All Downloads are FREE. Search and download functionalities are using the official Maven repository.

eu.lunisolar.magma.func.predicate.LObjLongPredicate Maven / Gradle / Ivy

There is a newer version: 3.0.0
Show newest version
/*
 * This file is part of "lunisolar-magma".
 *
 * (C) Copyright 2014-2019 Lunisolar (http://lunisolar.eu/).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package eu.lunisolar.magma.func.predicate;

import javax.annotation.Nonnull; // NOSONAR
import javax.annotation.Nullable; // NOSONAR
import java.util.Comparator; // NOSONAR
import java.util.Objects; // NOSONAR
import eu.lunisolar.magma.basics.*; //NOSONAR
import eu.lunisolar.magma.basics.builder.*; // NOSONAR
import eu.lunisolar.magma.basics.exceptions.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.aType.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.type.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.domain.*; // NOSONAR
import eu.lunisolar.magma.func.IA;
import eu.lunisolar.magma.func.SA;
import eu.lunisolar.magma.func.*; // NOSONAR
import eu.lunisolar.magma.func.tuple.*; // NOSONAR
import java.util.function.*; // NOSONAR
import java.util.*; // NOSONAR
import java.lang.reflect.*;

import eu.lunisolar.magma.func.action.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.bi.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.obj.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.tri.*; // NOSONAR
import eu.lunisolar.magma.func.function.*; // NOSONAR
import eu.lunisolar.magma.func.function.conversion.*; // NOSONAR
import eu.lunisolar.magma.func.function.from.*; // NOSONAR
import eu.lunisolar.magma.func.function.to.*; // NOSONAR
import eu.lunisolar.magma.func.operator.binary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.ternary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.unary.*; // NOSONAR
import eu.lunisolar.magma.func.predicate.*; // NOSONAR
import eu.lunisolar.magma.func.supplier.*; // NOSONAR

/**
 * Non-throwing functional interface (lambda) LObjLongPredicate for Java 8.
 *
 * Type: predicate
 *
 * Domain (lvl: 2): T a1,long a2
 *
 * Co-domain: boolean
 *
 */
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LObjLongPredicate extends MetaPredicate, MetaInterface.NonThrowing, Codomain, Domain2, aLong> { // NOSONAR

	String DESCRIPTION = "LObjLongPredicate: boolean test(T a1,long a2)";

	// boolean test(T a1,long a2) ;
	default boolean test(T a1, long a2) {
		// return nestingTest(a1,a2);
		try {
			return this.testX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			throw Handling.nestCheckedAndThrow(e);
		}
	}

	/**
	 * Implement this, but call test(T a1,long a2)
	 */
	boolean testX(T a1, long a2) throws Throwable;

	default boolean tupleTest(LObjLongPair args) {
		return test(args.first(), args.second());
	}

	/** Function call that handles exceptions according to the instructions. */
	default boolean handlingTest(T a1, long a2, HandlingInstructions handling) {
		try {
			return this.testX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			throw Handler.handleOrNest(e, handling);
		}
	}

	default LObjLongPredicate handling(HandlingInstructions handling) {
		return (a1, a2) -> handlingTest(a1, a2, handling);
	}

	default boolean test(T a1, long a2, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
		try {
			return this.testX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			throw Handling.wrap(e, exF, newMessage, messageParams);
		}
	}

	default LObjLongPredicate trying(@Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
		return (a1, a2) -> test(a1, a2, exF, newMessage, messageParams);
	}

	default boolean test(T a1, long a2, @Nonnull ExWF exF) {
		try {
			return this.testX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			throw Handling.wrap(e, exF);
		}
	}

	default LObjLongPredicate trying(@Nonnull ExWF exF) {
		return (a1, a2) -> test(a1, a2, exF);
	}

	default boolean testThen(T a1, long a2, @Nonnull LPredicate handler) {
		try {
			return this.testX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			Handling.handleErrors(e);
			return handler.test(e);
		}
	}

	default LObjLongPredicate tryingThen(@Nonnull LPredicate handler) {
		return (a1, a2) -> testThen(a1, a2, handler);
	}

	/** Function call that handles exceptions by always nesting checked exceptions and propagating the others as is. */
	default boolean nestingTest(T a1, long a2) {
		try {
			return this.testX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			throw Handling.nestCheckedAndThrow(e);
		}
	}

	/** Function call that handles exceptions by always propagating them as is, even when they are undeclared checked ones. */
	default boolean shovingTest(T a1, long a2) {
		try {
			return this.testX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			throw Handling.shoveIt(e);
		}
	}

	static  boolean handlingTest(T a1, long a2, LObjLongPredicate func, HandlingInstructions handling) { // <-
		Null.nonNullArg(func, "func");
		return func.handlingTest(a1, a2, handling);
	}

	static  boolean tryTest(T a1, long a2, LObjLongPredicate func) {
		Null.nonNullArg(func, "func");
		return func.nestingTest(a1, a2);
	}

	static  boolean tryTest(T a1, long a2, LObjLongPredicate func, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
		Null.nonNullArg(func, "func");
		return func.test(a1, a2, exF, newMessage, messageParams);
	}

	static  boolean tryTest(T a1, long a2, LObjLongPredicate func, @Nonnull ExWF exF) {
		Null.nonNullArg(func, "func");
		return func.test(a1, a2, exF);
	}

	static  boolean tryTestThen(T a1, long a2, LObjLongPredicate func, @Nonnull LPredicate handler) {
		Null.nonNullArg(func, "func");
		return func.testThen(a1, a2, handler);
	}

	default boolean failSafeTest(T a1, long a2, @Nonnull LObjLongPredicate failSafe) {
		try {
			return test(a1, a2);
		} catch (Throwable e) { // NOSONAR
			Handling.handleErrors(e);
			return failSafe.test(a1, a2);
		}
	}

	static  boolean failSafeTest(T a1, long a2, LObjLongPredicate func, @Nonnull LObjLongPredicate failSafe) {
		Null.nonNullArg(failSafe, "failSafe");
		if (func == null) {
			return failSafe.test(a1, a2);
		} else {
			return func.failSafeTest(a1, a2, failSafe);
		}
	}

	static  LObjLongPredicate failSafe(LObjLongPredicate func, @Nonnull LObjLongPredicate failSafe) {
		Null.nonNullArg(failSafe, "failSafe");
		return (a1, a2) -> failSafeTest(a1, a2, func, failSafe);
	}

	default boolean doIf(T a1, long a2, LAction action) {
		Null.nonNullArg(action, "action");
		if (test(a1, a2)) {
			action.execute();
			return true;
		} else {
			return false;
		}
	}

	static  boolean doIf(T a1, long a2, @Nonnull LObjLongPredicate predicate, @Nonnull LAction action) {
		Null.nonNullArg(predicate, "predicate");
		return predicate.doIf(a1, a2, action);
	}

	static  boolean doIf(T a1, long a2, @Nonnull LObjLongPredicate predicate, @Nonnull LObjLongConsumer consumer) {
		Null.nonNullArg(predicate, "predicate");
		return predicate.doIf(a1, a2, consumer);
	}

	default boolean doIf(T a1, long a2, @Nonnull LObjLongConsumer consumer) {
		Null.nonNullArg(consumer, "consumer");
		if (test(a1, a2)) {
			consumer.accept(a1, a2);
			return true;
		} else {
			return false;
		}
	}

	static  void throwIf(T a1, long a2, LObjLongPredicate pred, ExMF factory, @Nonnull String newMessage, @Nullable Object... messageParams) {
		if (pred.test(a1, a2)) {
			throw Handling.create(factory, newMessage, messageParams);
		}
	}

	static  void throwIfNot(T a1, long a2, LObjLongPredicate pred, ExMF factory, @Nonnull String newMessage, @Nullable Object... messageParams) {
		if (!pred.test(a1, a2)) {
			throw Handling.create(factory, newMessage, messageParams);
		}
	}

	/** Just to mirror the method: Ensures the result is not null */
	default boolean nonNullTest(T a1, long a2) {
		return test(a1, a2);
	}

	/** For convenience, where "test()" makes things more confusing than "applyAsBoolean()". */

	default boolean doApplyAsBoolean(T a1, long a2) {
		return test(a1, a2);
	}

	/** Returns description of the functional interface. */
	@Nonnull
	default String functionalInterfaceDescription() {
		return LObjLongPredicate.DESCRIPTION;
	}

	public default  boolean doIf(V a1, T a2, long a3, LBiObjLongConsumer consumer) {
		if (test(a2, a3)) {
			consumer.accept(a1, a2, a3);
			return true;
		} else {
			return false;
		}
	}

	/** From-To. Intended to be used with non-capturing lambda. */
	public static  void fromTo(long min_a2, long max_a2, T a1, LObjLongPredicate func) {
		Null.nonNullArg(func, "func");
		if (min_a2 <= max_a2) {
			for (long a2 = min_a2; a2 <= max_a2; a2++) {
				func.test(a1, a2);
			}
		} else {
			for (long a2 = min_a2; a2 >= max_a2; a2--) {
				func.test(a1, a2);
			}
		}
	}

	/** From-To. Intended to be used with non-capturing lambda. */
	public static  void fromTill(long min_a2, long max_a2, T a1, LObjLongPredicate func) {
		Null.nonNullArg(func, "func");
		if (min_a2 <= max_a2) {
			for (long a2 = min_a2; a2 < max_a2; a2++) {
				func.test(a1, a2);
			}
		} else {
			for (long a2 = min_a2; a2 > max_a2; a2--) {
				func.test(a1, a2);
			}
		}
	}

	/** From-To. Intended to be used with non-capturing lambda. */
	public static  void times(long max_a2, T a1, LObjLongPredicate func) {
		if (max_a2 < 0)
			return;
		fromTill(0, max_a2, a1, func);
	}

	public default LLongPredicate lShrink(LLongFunction left) {
		return a2 -> test(left.apply(a2), a2);
	}

	public default LLongPredicate lShrinkc(T a1) {
		return a2 -> test(a1, a2);
	}

	public static  LLongPredicate lShrinked(LLongFunction left, LObjLongPredicate func) {
		return func.lShrink(left);
	}

	public static  LLongPredicate lShrinkedc(T a1, LObjLongPredicate func) {
		return func.lShrinkc(a1);
	}

	public default LPredicate rShrink(LToLongFunction right) {
		return a1 -> test(a1, right.applyAsLong(a1));
	}

	public default LPredicate rShrinkc(long a2) {
		return a1 -> test(a1, a2);
	}

	public static  LPredicate rShrinked(LToLongFunction right, LObjLongPredicate func) {
		return func.rShrink(right);
	}

	public static  LPredicate rShrinkedc(long a2, LObjLongPredicate func) {
		return func.rShrinkc(a2);
	}

	/**  */
	public static  LObjLongPredicate uncurry(LFunction func) {
		return (T a1, long a2) -> func.apply(a1).test(a2);
	}

	/** Cast that removes generics. */
	public default LObjLongPredicate untyped() {
		return this;
	}

	/** Cast that replace generics. */
	public default  LObjLongPredicate cast() {
		return untyped();
	}

	/** Cast that replace generics. */
	public static  LObjLongPredicate cast(LObjLongPredicate function) {
		return (LObjLongPredicate) function;
	}

	/** Captures arguments but delays the evaluation. */
	default LBoolSupplier capture(T a1, long a2) {
		return () -> this.test(a1, a2);
	}

	/** Creates function that always returns the same value. */
	static  LObjLongPredicate constant(boolean r) {
		return (a1, a2) -> r;
	}

	/** Captures single parameter function into this interface where only 1st parameter will be used. */
	@Nonnull
	static  LObjLongPredicate test1st(@Nonnull LPredicate func) {
		return (a1, a2) -> func.test(a1);
	}

	/** Captures single parameter function into this interface where only 2nd parameter will be used. */
	@Nonnull
	static  LObjLongPredicate test2nd(@Nonnull LLongPredicate func) {
		return (a1, a2) -> func.test(a2);
	}

	/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
	@Nonnull
	static  LObjLongPredicate objLongPred(final @Nonnull LObjLongPredicate lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda;
	}

	@Nonnull
	static  LObjLongPredicate recursive(final @Nonnull LFunction, LObjLongPredicate> selfLambda) {
		final LObjLongPredicateSingle single = new LObjLongPredicateSingle();
		LObjLongPredicate func = selfLambda.apply(single);
		single.target = func;
		return func;
	}

	final class LObjLongPredicateSingle implements LSingle>, LObjLongPredicate {
		private LObjLongPredicate target = null;

		@Override
		public boolean testX(T a1, long a2) throws Throwable {
			return target.testX(a1, a2);
		}

		@Override
		public LObjLongPredicate value() {
			return target;
		}
	}

	@Nonnull
	static  LObjLongPredicate objLongPredThrowing(final @Nonnull ExF exF) {
		Null.nonNullArg(exF, "exF");
		return (a1, a2) -> {
			throw exF.produce();
		};
	}

	@Nonnull
	static  LObjLongPredicate objLongPredThrowing(final String message, final @Nonnull ExMF exF) {
		Null.nonNullArg(exF, "exF");
		return (a1, a2) -> {
			throw exF.produce(message);
		};
	}

	// 

	/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
	@Nonnull
	static  LLongObjPred longObjPred(final @Nonnull LLongObjPred lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda;
	}

	// 

	static  boolean call(T a1, long a2, final @Nonnull LObjLongPredicate lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda.test(a1, a2);
	}

	// 

	// 

	// 

	/** Safe instance. That always returns the same value (as alwaysFalse). */
	@Nonnull
	static  LObjLongPredicate safe() {
		return LObjLongPredicate::alwaysFalse;
	}

	/** Safe instance supplier. Returns supplier of safe() instance. */
	@Nonnull
	static  LSupplier> safeSupplier() {
		return () -> safe();
	}

	/** Safe wrapping. Either argument function is returned (if it is not null) or safe() instance. */
	@Nonnull
	static  LObjLongPredicate safe(final @Nullable LObjLongPredicate other) {
		if (other == null) {
			return safe();
		} else {
			return other;
		}
	}

	/** Safe supplier. Either argument supplier is returned (if it is not null) or supplier of safe() instance. */
	@Nonnull
	static  LSupplier> safeSupplier(final @Nullable LSupplier> supplier) {
		if (supplier == null) {
			return safeSupplier();
		} else {
			return supplier;
		}
	}

	// 
	// 

	/**
	 * Returns a predicate that represents the logical negation of this predicate.
	 *
	 * @see {@link java.util.function.Predicate#negate}
	 */
	@Nonnull
	default LObjLongPredicate negate() {
		return (a1, a2) -> !test(a1, a2);
	}

	/**
	 * Returns a predicate that represents the logical AND of evaluation of this predicate and the argument one.
	 * @see {@link java.util.function.Predicate#and()}
	 */
	@Nonnull
	default LObjLongPredicate and(@Nonnull LObjLongPredicate other) {
		Null.nonNullArg(other, "other");
		return (a1, a2) -> test(a1, a2) && other.test(a1, a2);
	}

	/**
	 * Returns a predicate that represents the logical OR of evaluation of this predicate and the argument one.
	 * @see {@link java.util.function.Predicate#or}
	 */
	@Nonnull
	default LObjLongPredicate or(@Nonnull LObjLongPredicate other) {
		Null.nonNullArg(other, "other");
		return (a1, a2) -> test(a1, a2) || other.test(a1, a2);
	}

	/**
	 * Returns a predicate that represents the logical XOR of evaluation of this predicate and the argument one.
	 * @see {@link java.util.function.Predicate#or}
	 */
	@Nonnull
	default LObjLongPredicate xor(@Nonnull LObjLongPredicate other) {
		Null.nonNullArg(other, "other");
		return (a1, a2) -> test(a1, a2) ^ other.test(a1, a2);
	}

	/**
	 * Creates predicate that evaluates if an object is equal with the argument one.
	 * @see {@link java.util.function.Predicate#isEqual()
	 */
	@Nonnull
	static  LObjLongPredicate isEqual(T v1, long v2) {
		return (a1, a2) -> (a1 == null ? v1 == null : a1.equals(v1)) && (a2 == v2);
	}

	// 

	// 

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default  LObjLongPredicate compose(@Nonnull final LFunction before1, @Nonnull final LLongUnaryOperator before2) {
		Null.nonNullArg(before1, "before1");
		Null.nonNullArg(before2, "before2");
		return (v1, v2) -> this.test(before1.apply(v1), before2.applyAsLong(v2));
	}

	public static  LObjLongPredicate composed(@Nonnull final LFunction before1, @Nonnull final LLongUnaryOperator before2, LObjLongPredicate after) {
		return after.compose(before1, before2);
	}

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default  LBiPredicate objLongPredCompose(@Nonnull final LFunction before1, @Nonnull final LToLongFunction before2) {
		Null.nonNullArg(before1, "before1");
		Null.nonNullArg(before2, "before2");
		return (v1, v2) -> this.test(before1.apply(v1), before2.applyAsLong(v2));
	}

	public static  LBiPredicate composed(@Nonnull final LFunction before1, @Nonnull final LToLongFunction before2, LObjLongPredicate after) {
		return after.objLongPredCompose(before1, before2);
	}

	// 

	// 

	/** Combines two functions together in a order. */
	@Nonnull
	default  LObjLongFunction boolToObjLongFunc(@Nonnull LBoolFunction after) {
		Null.nonNullArg(after, "after");
		return (a1, a2) -> after.apply(this.test(a1, a2));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LObjLongPredicate boolToObjLongPred(@Nonnull LLogicalOperator after) {
		Null.nonNullArg(after, "after");
		return (a1, a2) -> after.apply(this.test(a1, a2));
	}

	// 

	// 

	// 

	// 

	/** Permutation of LObjLongPredicate for method references. */
	@FunctionalInterface
	interface LLongObjPred extends LObjLongPredicate {

		boolean testLongObj(long a2, T a1);

		@Override
		default boolean testX(T a1, long a2) {
			return this.testLongObj(a2, a1);
		}
	}

	// 

	// >>> LObjLongPredicate

	/** Returns TRUE. */
	public static  boolean alwaysTrue(T a1, long a2) {
		return true;
	}

	/** Returns FALSE. */
	public static  boolean alwaysFalse(T a1, long a2) {
		return false;
	}

	// >>> LLongObjPred

	/** Returns TRUE. */
	public static  boolean alwaysTrue(long a2, T a1) {
		return true;
	}

	/** Returns FALSE. */
	public static  boolean alwaysFalse(long a2, T a1) {
		return false;
	}

	/**
	* For each element (or tuple) from arguments, calls the consumer if predicate test passes.
	* Thread safety, fail-fast, fail-safety of this method is not expected.
	*/
	default  void filterForEach(IndexedRead> ia1, C1 source1, IndexedRead ia2, C2 source2, LObjLongConsumer consumer) {
		int size = ia1.size(source1);
		LOiFunction oiFunc1 = (LOiFunction) ia1.getter();
		size = Integer.min(size, ia2.size(source2));
		LOiToLongFunction oiFunc2 = (LOiToLongFunction) ia2.getter();
		int i = 0;
		for (; i < size; i++) {
			T a1 = oiFunc1.apply(source1, i);
			long a2 = oiFunc2.applyAsLong(source2, i);
			doIf(a1, a2, consumer);
		}
	}

	/**
	* For each element (or tuple) from arguments, calls the consumer if predicate test passes.
	* Thread safety, fail-fast, fail-safety of this method is not expected.
	*/
	default  void filterIterate(SequentialRead> sa1, C1 source1, IndexedRead ia2, C2 source2, LObjLongConsumer consumer) {
		Object iterator1 = ((LFunction) sa1.adapter()).apply(source1);
		LPredicate testFunc1 = (LPredicate) sa1.tester();
		LFunction nextFunc1 = (LFunction) sa1.supplier();
		int size = ia2.size(source2);
		LOiToLongFunction oiFunc2 = (LOiToLongFunction) ia2.getter();
		int i = 0;
		while (testFunc1.test(iterator1) && i < size) {
			T a1 = nextFunc1.apply(iterator1);
			long a2 = oiFunc2.applyAsLong(source2, i);
			doIf(a1, a2, consumer);
			i++;
		}
	}

	/**
	* For each element (or tuple) from arguments, calls the consumer if predicate test passes.
	* Thread safety, fail-fast, fail-safety of this method is not expected.
	*/
	default  void filterIterate(IndexedRead> ia1, C1 source1, SequentialRead sa2, C2 source2, LObjLongConsumer consumer) {
		int size = ia1.size(source1);
		LOiFunction oiFunc1 = (LOiFunction) ia1.getter();
		Object iterator2 = ((LFunction) sa2.adapter()).apply(source2);
		LPredicate testFunc2 = (LPredicate) sa2.tester();
		LToLongFunction nextFunc2 = (LToLongFunction) sa2.supplier();
		int i = 0;
		while (i < size && testFunc2.test(iterator2)) {
			T a1 = oiFunc1.apply(source1, i);
			long a2 = nextFunc2.applyAsLong(iterator2);
			doIf(a1, a2, consumer);
			i++;
		}
	}

	/**
	* For each element (or tuple) from arguments, calls the consumer if predicate test passes.
	* Thread safety, fail-fast, fail-safety of this method depends highly on the arguments.
	*/
	default  void filterIterate(SequentialRead> sa1, C1 source1, SequentialRead sa2, C2 source2, LObjLongConsumer consumer) {
		Object iterator1 = ((LFunction) sa1.adapter()).apply(source1);
		LPredicate testFunc1 = (LPredicate) sa1.tester();
		LFunction nextFunc1 = (LFunction) sa1.supplier();
		Object iterator2 = ((LFunction) sa2.adapter()).apply(source2);
		LPredicate testFunc2 = (LPredicate) sa2.tester();
		LToLongFunction nextFunc2 = (LToLongFunction) sa2.supplier();
		while (testFunc1.test(iterator1) && testFunc2.test(iterator2)) {
			T a1 = nextFunc1.apply(iterator1);
			long a2 = nextFunc2.applyAsLong(iterator2);
			doIf(a1, a2, consumer);
		}
	}

}