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

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

Go to download

There is a newer version: 3.0.0
Show newest version
/*
 * This file is part of "lunisolar-magma".
 *
 * (C) Copyright 2015 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.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.*; // NOSONAR
import eu.lunisolar.magma.func.operator.unary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.binary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.ternary.*; // NOSONAR
import eu.lunisolar.magma.func.function.*; // NOSONAR
import eu.lunisolar.magma.func.function.from.*; // NOSONAR
import eu.lunisolar.magma.func.function.to.*; // NOSONAR
import eu.lunisolar.magma.func.function.conversion.*; // NOSONAR
import eu.lunisolar.magma.func.predicate.*; // NOSONAR
import eu.lunisolar.magma.func.supplier.*; // 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.tri.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.obj.*; // NOSONAR
import eu.lunisolar.magma.func.action.*; // NOSONAR

/**
 * Non-throwing functional interface (lambda) LDoublePredicate for Java 8.
 *
 * Type: predicate
 *
 * Domain (lvl: 1): double d
 *
 * Co-domain: none
 *
 * @see LDoublePredicateX
 */
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LDoublePredicate extends LDoublePredicateX, MetaPredicate, PrimitiveCodomain, MetaInterface.NonThrowing { // NOSONAR

	static final String DESCRIPTION = "LDoublePredicate: boolean doTest(double d)";

	/**
	 * Default implementation for JRE method that calls exception nesting method.
	 * @deprecated Calling this method via LDoublePredicate interface should be discouraged.
	 */
	@Override
	@Deprecated
	default boolean test(double d) {
		return this.nestingDoTest(d);
	}

	boolean doTest(double d);

	/** Function call that handles exceptions by always nesting checked exceptions and propagating the otheres as is. */
	default boolean nestingDoTest(double d) {
		return this.doTest(d);
	}

	/** Function call that handles exceptions by always propagating them as is even when they are undeclared checked ones. */
	default boolean shovingDoTest(double d) {
		return this.doTest(d);
	}

	/** Just to mirror the method: Ensures the result is not null */
	default boolean nonNullDoTest(double d) {
		return doTest(d);
	}

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

	default boolean doApplyAsBoolean(double d) {
		return doTest(d);
	}

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

	/** Captures arguments but delays the evaluation. */
	default LBoolSupplier captureDoublePred(double d) {
		return () -> this.doTest(d);
	}

	/** Creates function that always returns the same value. */
	static LDoublePredicate constant(boolean r) {
		return d -> r;
	}

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

	// 

	/** Wraps JRE instance. */
	@Nonnull
	static LDoublePredicate wrap(final java.util.function.DoublePredicate other) {
		return other::test;
	}

	/** Wraps opposite (throwing vs non-throwing) instance. */
	@Nonnull
	static  LDoublePredicate wrap(final @Nonnull LDoublePredicateX other) {
		return other::nestingDoTest;
	}

	// 
	// 

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

	/**
	 * 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 LDoublePredicate and(@Nonnull LDoublePredicate other) {
		Null.nonNullArg(other, "other");
		return d -> doTest(d) && other.doTest(d);
	}

	/**
	 * 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 LDoublePredicate or(@Nonnull LDoublePredicate other) {
		Null.nonNullArg(other, "other");
		return d -> doTest(d) || other.doTest(d);
	}

	/**
	 * 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 LDoublePredicate xor(@Nonnull LDoublePredicate other) {
		Null.nonNullArg(other, "other");
		return d -> doTest(d) ^ other.doTest(d);
	}

	/**
	 * Creates predicate that evaluates if an object is equal with the argument one.
	 * @see {@link java.util.function.Predicate#isEqual()
	 */
	@Nonnull
	static LDoublePredicate isEqual(double target) {
		return d -> d == target;
	}

	// 

	// 

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default LDoublePredicate doublePredComposeDouble(@Nonnull final LDoubleUnaryOperator before1) {
		Null.nonNullArg(before1, "before1");
		return v1 -> this.doTest(before1.doApplyAsDouble(v1));
	}

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default  LPredicate doublePredCompose(@Nonnull final LToDoubleFunction before1) {
		Null.nonNullArg(before1, "before1");
		return v1 -> this.doTest(before1.doApplyAsDouble(v1));
	}

	// 

	// 

	/** Combines two predicates together in a order. */
	@Nonnull
	default  LDoubleFunction boolToDoubleFunction(@Nonnull LBoolFunction after) {
		Null.nonNullArg(after, "after");
		return d -> after.doApply(this.doTest(d));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LDoubleToByteFunction boolToDoubleToByteFunction(@Nonnull LBoolToByteFunction after) {
		Null.nonNullArg(after, "after");
		return d -> after.doApplyAsByte(this.doTest(d));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LDoubleToShortFunction boolToDoubleToShortFunction(@Nonnull LBoolToShortFunction after) {
		Null.nonNullArg(after, "after");
		return d -> after.doApplyAsShort(this.doTest(d));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LDoubleToIntFunction boolToDoubleToIntFunction(@Nonnull LBoolToIntFunction after) {
		Null.nonNullArg(after, "after");
		return d -> after.doApplyAsInt(this.doTest(d));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LDoubleToLongFunction boolToDoubleToLongFunction(@Nonnull LBoolToLongFunction after) {
		Null.nonNullArg(after, "after");
		return d -> after.doApplyAsLong(this.doTest(d));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LDoubleToFloatFunction boolToDoubleToFloatFunction(@Nonnull LBoolToFloatFunction after) {
		Null.nonNullArg(after, "after");
		return d -> after.doApplyAsFloat(this.doTest(d));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LDoubleUnaryOperator boolToDoubleUnaryOperator(@Nonnull LBoolToDoubleFunction after) {
		Null.nonNullArg(after, "after");
		return d -> after.doApplyAsDouble(this.doTest(d));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LDoubleToCharFunction boolToDoubleToCharFunction(@Nonnull LBoolToCharFunction after) {
		Null.nonNullArg(after, "after");
		return d -> after.doApplyAsChar(this.doTest(d));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LDoublePredicate boolToDoublePredicate(@Nonnull LLogicalOperator after) {
		Null.nonNullArg(after, "after");
		return d -> after.doApply(this.doTest(d));
	}

	// 
	// 

	/** Converts to non-throwing variant (if required). */
	@Nonnull
	default LDoublePredicate nestingDoublePred() {
		return this;
	}

	/** Converts to throwing variant (RuntimeException). */
	@Nonnull
	default LDoublePredicateX nestingDoublePredX() {
		return this;
	}

	/** Converts to non-throwing variant that will propagate checked exception as it would be unchecked - there is no exception wrapping involved (at least not here). */
	default LDoublePredicate shovingDoublePred() {
		return this;
	}

	/** Converts to throwing variant (RuntimeException) that will propagate checked exception as it would be unchecked - there is no exception wrapping involved (at least not here). */
	default LDoublePredicateX shovingDoublePredX() {
		return this;
	}

	// 

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy