Class Booleans

java.lang.Object

fj.function.Booleans

public final class Booleans
extends Object

Curried logical functions.

Field Summary

Fields

Modifier and Type	Field	Description
static final F<Boolean, F<Boolean,Boolean>>	and	Curried form of logical "and" (conjunction).
static final F<Boolean, F<Boolean,Boolean>>	if_	Curried form of logical "if" (reverse material implication).
static final F<Boolean, F<Boolean,Boolean>>	iff	Curried form of logical "if and only if" (biconditional, equivalence).
static final F<Boolean, F<Boolean,Boolean>>	implies	Curried form of logical "only if" (material implication).
static final F<Boolean, F<Boolean,Boolean>>	nif	Curried form of logical "not if" (reverse nonimplication).
static final F<Boolean, F<Boolean,Boolean>>	nimp	Curried form of logical "not implies" (nonimplication).
static final F<Boolean, F<Boolean,Boolean>>	nor	Curried form of logical "not or".
static final F<Boolean,Boolean>	not	Logical negation.
static final F<Boolean, F<Boolean,Boolean>>	or	Curried form of logical "inclusive or" (disjunction).
static final F<Boolean, F<Boolean,Boolean>>	xor	Curried form of logical xor (nonequivalence).

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Booleans()

Method Summary

Modifier and Type	Method	Description
static boolean	and(List<Boolean> l)	Returns true if all the elements of the given list are true.
static boolean	and(Stream<Boolean> l)	Returns true if all the elements of the given stream are true.
static <A> F<A,Boolean>	and(F<A,Boolean> p1, F<A,Boolean> p2)	composes the given predicate using conjunction
static <A> F<A,Boolean>	andAll(List<F<A,Boolean>> l)	Returns a composed predicate of given List of predicates
static <A> F<A,Boolean>	andAll(Stream<F<A,Boolean>> l)	Returns composed predicate
static <A> F<Boolean, F<A,F<A,A>>>	cond()	Curried form of conditional.
static <A,B> F<B,Boolean>	contramap(F<B,A> f, F<A,Boolean> p)	maps given function to the predicate function
static <A,B> F<B,Boolean>	is(F<B,A> f, F<A,Boolean> p)	alias for contramap
static <A,B> F<B,Boolean>	isnot(F<B,A> f, F<A,Boolean> p)	returns inverse of contramap
static <A> F<A,Boolean>	not(F<A,Boolean> p)	Negates the given predicate.
static boolean	or(List<Boolean> l)	Returns true if any element of the given list is true.
static boolean	or(Stream<Boolean> l)	Returns true if any element of the given stream is true.
static <A> F<A,Boolean>	or(F<A,Boolean> p1, F<A,Boolean> p2)	returns composed predicate using disjunction
static <A> F<A,Boolean>	orAll(List<F<A,Boolean>> l)	Returns a composed predicate of given List of predicates
static <A> F<A,Boolean>	orAll(Stream<F<A,Boolean>> l)	Returns a composed predicate of given Stream of predicates
static <A> F<A,Boolean>	xor(F<A,Boolean> p1, F<A,Boolean> p2)	composes the given predicate using exclusive disjunction

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

or

public static final F<Boolean, F<Boolean,Boolean>> or

Curried form of logical "inclusive or" (disjunction).

and

public static final F<Boolean, F<Boolean,Boolean>> and

Curried form of logical "and" (conjunction).

xor

public static final F<Boolean, F<Boolean,Boolean>> xor

Curried form of logical xor (nonequivalence).

not

public static final F<Boolean,Boolean> not

Logical negation.

implies

public static final F<Boolean, F<Boolean,Boolean>> implies

Curried form of logical "only if" (material implication).

if_

public static final F<Boolean, F<Boolean,Boolean>> if_

Curried form of logical "if" (reverse material implication).

iff

public static final F<Boolean, F<Boolean,Boolean>> iff

Curried form of logical "if and only if" (biconditional, equivalence).

nimp

public static final F<Boolean, F<Boolean,Boolean>> nimp

Curried form of logical "not implies" (nonimplication).

nif

public static final F<Boolean, F<Boolean,Boolean>> nif

Curried form of logical "not if" (reverse nonimplication).

nor

public static final F<Boolean, F<Boolean,Boolean>> nor

Curried form of logical "not or".

Constructor Details

Booleans

private Booleans()

Method Details

and

public static boolean and(List<Boolean> l)

Returns true if all the elements of the given list are true.

Parameters:

l - A list to check for all the elements being true.

Returns:

true if all the elements of the given list are true. False otherwise.

contramap

public static <A,B> F<B,Boolean> contramap(F<B,A> f,
 F<A,Boolean> p)

maps given function to the predicate function

Parameters:

f - function

p - predicate to be mapped over

Returns:

predicate function

is

public static <A,B> F<B,Boolean> is(F<B,A> f,
 F<A,Boolean> p)

alias for contramap

Parameters:

f - function

p - predicate to be mapped over

Returns:

predicate function

isnot

public static <A,B> F<B,Boolean> isnot(F<B,A> f,
 F<A,Boolean> p)

returns inverse of contramap

Parameters:

f - function

p - predicate to be mapped over

Returns:

predicate function

and

public static <A> F<A,Boolean> and(F<A,Boolean> p1,
 F<A,Boolean> p2)

composes the given predicate using conjunction

Parameters:

p1 - first predicate

p2 - second predicate

Returns:

composed predicate function

xor

public static <A> F<A,Boolean> xor(F<A,Boolean> p1,
 F<A,Boolean> p2)

composes the given predicate using exclusive disjunction

Parameters:

p1 - first predicate

p2 - second predicate

Returns:

composed predicate function

or

public static <A> F<A,Boolean> or(F<A,Boolean> p1,
 F<A,Boolean> p2)

returns composed predicate using disjunction

Parameters:

p1 - first predicate

p2 - second predicate

Returns:

composed predicate

and

public static boolean and(Stream<Boolean> l)

Returns true if all the elements of the given stream are true.

Parameters:

l - A stream to check for all the elements being true.

Returns:

true if all the elements of the given stream are true. False otherwise.

andAll

public static <A> F<A,Boolean> andAll(Stream<F<A,Boolean>> l)

Returns composed predicate

Parameters:

l - A stream of predicates

Returns:

composed predicate

andAll

public static <A> F<A,Boolean> andAll(List<F<A,Boolean>> l)

Returns a composed predicate of given List of predicates

Parameters:

l - A list of predicate functions

Returns:

composed predicate function

orAll

public static <A> F<A,Boolean> orAll(List<F<A,Boolean>> l)

Returns a composed predicate of given List of predicates

Parameters:

l - A list of predicate functions

Returns:

composed predicate function

orAll

public static <A> F<A,Boolean> orAll(Stream<F<A,Boolean>> l)

Returns a composed predicate of given Stream of predicates

Parameters:

l - A stream of predicate functions

Returns:

composed predicate function

or

public static boolean or(List<Boolean> l)

Returns true if any element of the given list is true.

Parameters:

l - A list to check for any element being true.

Returns:

true if any element of the given list is true. False otherwise.

or

public static boolean or(Stream<Boolean> l)

Returns true if any element of the given stream is true.

Parameters:

l - A stream to check for any element being true.

Returns:

true if any element of the given stream is true. False otherwise.

not

public static <A> F<A,Boolean> not(F<A,Boolean> p)

Negates the given predicate.

Parameters:

p - A predicate to negate.

Returns:

The negation of the given predicate.

cond

public static <A> F<Boolean, F<A,F<A,A>>> cond()

Curried form of conditional. If the first argument is true, returns the second argument, otherwise the third argument.

Returns:

A function that returns its second argument if the first argument is true, otherwise the third argument.