org.matheclipse.core.generic.interfaces

Interface BiPredicate<T>

All Known Implementing Classes:

IntPolynomialQ, IntPolynomialQ, IsBinaryFalse, IsBinaryTrue, IsLEOrdered, PolynomialQ

public interface BiPredicate<T>

A BiPredicate can determine a true or false value for any input of its parameterized types.

Implementors of BiPredicate which may cause side effects upon evaluation are strongly encouraged to state this fact clearly in their API documentation.

NOTE: This interface could technically extend BiFunction, since a predicate is just a special case of a function (one that returns a boolean). However, since implementing this would entail changing the signature of the apply(T, T) method to return a Boolean instead of a boolean, which would in turn allow people to return null from their BiPredicate, which would in turn enable code that looks like this if (myPredicate.apply(myObject)) ... to throw a NullPointerException, it was decided not to make this change.

Method Summary

Modifier and Type	Method and Description
boolean	apply(T t1, T t2) Applies this Predicate to the given objects.

Method Detail

apply

boolean apply(@Nullable
              T t1,
              @Nullable
              T t2)

Applies this Predicate to the given objects.

Returns:

the value of this Predicate when applied to input t1 and t2.