AbstractPredicateN (predicating 1.0.0 API)

Type Parameters:

P - the type of this predicate

All Superinterfaces:

And, net.ashwork.functionality.partial.Arity, net.ashwork.functionality.FunctionN<java.lang.Boolean>, LogicalOperator, Nand, Nor, Not, Or, OrNot, net.ashwork.functionality.partial.ResultChainable<java.lang.Boolean>, net.ashwork.functionality.partial.ResultChainableResult<java.lang.Boolean>, Sub, net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN, Xnor, Xor

All Known Subinterfaces:

AbstractBooleanPredicate1, AbstractBytePredicate1, AbstractCharPredicate1, AbstractDoublePredicate1, AbstractFloatPredicate1, AbstractIntPredicate1, AbstractLongPredicate1, AbstractPredicate0, AbstractPredicate1<T1,P>, AbstractPredicate2<T1,T2,P>, AbstractShortPredicate1, BooleanPredicate1, BytePredicate1, CharPredicate1, DoublePredicate1, FloatPredicate1, IntPredicate1, LongPredicate1, Predicate0, Predicate1<T1>, Predicate2<T1,T2>, PredicateN, ShortPredicate1

All Known Implementing Classes:

PredicateN.Instance
```
@InheritOnly
public interface AbstractPredicateN>
extends net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN, LogicalOperator
```
Represents a predicate that accepts n arguments and produces a boolean-valued result. This is the predicate specialization for ToBooleanFunctionN. All boolean-producing predicates are derived from this n-arity specialization.

Since:

1.0.0

See Also:

ToBooleanFunctionN

API Note:

This is an abstract predicate and should not be used directly. It should instead be called by one of its subtypes.

Nested Class Summary
- Nested classes/interfaces inherited from interface net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN
  net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN.Instance
- Nested classes/interfaces inherited from interface net.ashwork.functionality.FunctionN
  net.ashwork.functionality.FunctionN.FunctionSizeException

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default AbstractPredicateN<P>`	`and(P other)` Intersects this object with another object to produce a combined result.
`default boolean`	`applyAllAsBooleanUnchecked(java.lang.Object... args)`
`default AbstractPredicateN<P>`	`nand(P other)` Intersects this object with another object to produce the complement of a combined result.
`default AbstractPredicateN<P>`	`nor(P other)` Unions this object with another object to produce the complement of a combined result.
`default AbstractPredicateN<P>`	`not()` Gets the complement of this object.
`default AbstractPredicateN<P>`	`or(P other)` Unions this object with another object to produce a combined result.
`default AbstractPredicateN<P>`	`orNot(P other)` Subtracts the other object from this object to produce the complement of a combined result.
`default AbstractPredicateN<P>`	`sub(P other)` Subtracts the other object from this object to produce a combined result.
`boolean`	`testAllUnchecked(java.lang.Object... args)` Evaluates this predicate on the given arguments.
`default AbstractPredicateN<P>`	`xnor(P other)` Disjunctively unions this object with another object to produce the complement of a combined result.
`default AbstractPredicateN<P>`	`xor(P other)` Disjunctively unions this object with another object to produce a combined result.

Methods inherited from interface net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN
applyAllUnchecked

Methods inherited from interface net.ashwork.functionality.FunctionN
andThen, andThenUnchecked, arity, checkSize, checkSize, sizedApplyAllUnchecked

- Method Detail
 - testAllUnchecked
```
boolean testAllUnchecked(java.lang.Object... args)
```
 Evaluates this predicate on the given arguments. Makes no assumptions of the arguments passed in and whether a value will compute successfully.
 
 Parameters:
 
 args - the input arguments
 
 Returns:
 
 true if the input arguments match the predicate, otherwise false
 - applyAllAsBooleanUnchecked
```
default boolean applyAllAsBooleanUnchecked(java.lang.Object... args)
```
 Specified by:
 
 applyAllAsBooleanUnchecked in interface net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN
 - not
```
default AbstractPredicateN not()
```
 Description copied from interface: Not
 
 Gets the complement of this object. This is the equivalent of calling ~A or a logical NOT.
 
 Specified by:
 
 not in interface LogicalOperator>
 
 Specified by:
 
 not in interface Nand>
 
 Specified by:
 
 not in interface Nor>
 
 Specified by:
 
 not in interface Not
 
 Specified by:
 
 not in interface OrNot>
 
 Specified by:
 
 not in interface Sub>
 
 Specified by:
 
 not in interface Xnor>
 
 Specified by:
 
 not in interface Xor>
 
 Returns:
 
 a complement of this object
 - and
```
default AbstractPredicateN and(P other)
```
 Description copied from interface: And
 
 Intersects this object with another object to produce a combined result. This is the equivalent of calling A & B or a logical AND.
 
 Specified by:
 
 and in interface And>
 
 Specified by:
 
 and in interface LogicalOperator>
 
 Specified by:
 
 and in interface Nand>
 
 Specified by:
 
 and in interface Sub>
 
 Specified by:
 
 and in interface Xnor>
 
 Specified by:
 
 and in interface Xor>
 
 Parameters:
 
 other - the intersected object
 
 Returns:
 
 a combined object that represents the intersection of this object and the other object
 - or
```
default AbstractPredicateN or(P other)
```
 Description copied from interface: Or
 
 Unions this object with another object to produce a combined result. This is the equivalent of calling A | B or a logical OR.
 
 Specified by:
 
 or in interface LogicalOperator>
 
 Specified by:
 
 or in interface Nor>
 
 Specified by:
 
 or in interface Or>
 
 Specified by:
 
 or in interface OrNot>
 
 Specified by:
 
 or in interface Xnor>
 
 Specified by:
 
 or in interface Xor>
 
 Parameters:
 
 other - the unioned object
 
 Returns:
 
 a combined object that represents the union of this object and the other object
 - xor
```
default AbstractPredicateN xor(P other)
```
 Description copied from interface: Xor
 
 Disjunctively unions this object with another object to produce a combined result. This is the equivalent of calling A ^ B or a logical XOR.
 
 Specified by:
 
 xor in interface LogicalOperator>
 
 Specified by:
 
 xor in interface Xnor>
 
 Specified by:
 
 xor in interface Xor>
 
 Parameters:
 
 other - the disjunctively unioned object
 
 Returns:
 
 a combined object that represents the symmetric difference of this object and the other object
 - sub
```
default AbstractPredicateN sub(P other)
```
 Description copied from interface: Sub
 
 Subtracts the other object from this object to produce a combined result. This is the equivalent of calling A - B or the relative complement.
 
 Specified by:
 
 sub in interface LogicalOperator>
 
 Specified by:
 
 sub in interface Sub>
 
 Specified by:
 
 sub in interface Xnor>
 
 Specified by:
 
 sub in interface Xor>
 
 Parameters:
 
 other - the subtrahend object
 
 Returns:
 
 a combined object that represents the other object being subtracted from this object
 - nand
```
default AbstractPredicateN nand(P other)
```
 Description copied from interface: Nand
 
 Intersects this object with another object to produce the complement of a combined result. This is the equivalent of calling ~(A & B) or a logical NAND.
 
 Specified by:
 
 nand in interface LogicalOperator>
 
 Specified by:
 
 nand in interface Nand>
 
 Parameters:
 
 other - the intersected object
 
 Returns:
 
 a combined object that represents the complement of the intersection of this object and the other object
 - nor
```
default AbstractPredicateN nor(P other)
```
 Description copied from interface: Nor
 
 Unions this object with another object to produce the complement of a combined result. This is the equivalent of calling ~(A | B) or a logical NOR.
 
 Specified by:
 
 nor in interface LogicalOperator>
 
 Specified by:
 
 nor in interface Nor>
 
 Parameters:
 
 other - the unioned object
 
 Returns:
 
 a combined object that represents the complement of the union of this object and the other object
 - xnor
```
default AbstractPredicateN xnor(P other)
```
 Description copied from interface: Xnor
 
 Disjunctively unions this object with another object to produce the complement of a combined result. This is the equivalent of calling ~(A ^ B) or a logical XNOR.
 
 Specified by:
 
 xnor in interface LogicalOperator>
 
 Specified by:
 
 xnor in interface Xnor>
 
 Parameters:
 
 other - the disjunctively unioned object
 
 Returns:
 
 a combined object that represents the complement of the symmetric difference of this object and the other object
 - orNot
```
default AbstractPredicateN orNot(P other)
```
 Description copied from interface: OrNot
 
 Subtracts the other object from this object to produce the complement of a combined result. This is the equivalent of calling ~(A - B) or the complement of the relative complement.
 
 Specified by:
 
 orNot in interface LogicalOperator>
 
 Specified by:
 
 orNot in interface OrNot>
 
 Parameters:
 
 other - the subtrahend object
 
 Returns:
 
 a combined object that represents the complement of the other object being subtracted from this object

Interface AbstractPredicateN<P extends AbstractPredicateN<P>>

Nested Class Summary

Nested classes/interfaces inherited from interface net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN

Nested classes/interfaces inherited from interface net.ashwork.functionality.FunctionN

Method Summary

Methods inherited from interface net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN

Methods inherited from interface net.ashwork.functionality.FunctionN

Method Detail

testAllUnchecked

applyAllAsBooleanUnchecked

not

and

or

xor

sub

nand

nor

xnor

orNot