com.jnape.palatable.lambda.monoid.builtin

Class Xor

java.lang.Object

com.jnape.palatable.lambda.monoid.builtin.Xor

All Implemented Interfaces:

Fn1<Boolean,Fn1<Boolean,Boolean>>, Fn2<Boolean,Boolean,Boolean>, BiPredicate<Boolean,Boolean>, Applicative<Fn1<Boolean,Boolean>,Fn1<Boolean,?>>, Cartesian<Boolean,Fn1<Boolean,Boolean>,Fn1<?,?>>, Cocartesian<Boolean,Fn1<Boolean,Boolean>,Fn1<?,?>>, Contravariant<Boolean,Profunctor<?,Fn1<Boolean,Boolean>,Fn1<?,?>>>, Functor<Fn1<Boolean,Boolean>,Fn1<Boolean,?>>, Profunctor<Boolean,Fn1<Boolean,Boolean>,Fn1<?,?>>, Monad<Fn1<Boolean,Boolean>,Fn1<Boolean,?>>, MonadReader<Boolean,Fn1<Boolean,Boolean>,Fn1<Boolean,?>>, MonadRec<Fn1<Boolean,Boolean>,Fn1<Boolean,?>>, MonadWriter<Boolean,Fn1<Boolean,Boolean>,Fn1<Boolean,?>>, Monoid<Boolean>, Semigroup<Boolean>

public final class Xor
extends Object
implements Monoid<Boolean>, BiPredicate<Boolean,Boolean>

Logical exclusive-or. Equivalent to logical ^.

Note that this implementation behaves as a cascade of binary exclusive-or operations, as is the only possible monoidal behavior when applied to an unknown number of inputs.

See Also:

Or, And

Method Summary

Modifier and Type	Method and Description
Boolean	checkedApply(Boolean x, Boolean y)
Xor	flip() Flip the order of the arguments.
Boolean	identity() The identity element of this monoid.
static Xor	xor()
static Fn1<Boolean,Boolean>	xor(Boolean x)
static Boolean	xor(Boolean x, Boolean y)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jnape.palatable.lambda.monoid.Monoid

foldLeft, foldMap, foldRight, monoid, monoid, reduceLeft, reduceRight

Methods inherited from interface com.jnape.palatable.lambda.functions.Fn2

apply, apply, checkedApply, compose, contraMap, curried, curry, diMapL, discardR, fn2, fromBiFunction, toBiFunction, uncurry, widen

Methods inherited from interface com.jnape.palatable.lambda.functions.Fn1

andThen, carry, cartesian, censor, choose, cocartesian, diMap, diMapR, discardL, flatMap, fmap, fn1, fromFunction, lazyZip, listens, local, pure, pureFn1, thunk, toFunction, trampolineM, zip, zip

Methods inherited from interface com.jnape.palatable.lambda.monad.Monad

join

Methods inherited from interface com.jnape.palatable.lambda.functor.Functor

coerce

Methods inherited from interface com.jnape.palatable.lambda.functions.specialized.BiPredicate

and, apply, contraMap, diMapL, discardR, fromBiPredicate, negate, or, toBiPredicate, uncurry

Method Detail

identity

public Boolean identity()

Description copied from interface: Monoid

The identity element of this monoid.

Specified by:

identity in interface Monoid<Boolean>

Returns:

the identity

checkedApply

public Boolean checkedApply(Boolean x,
                            Boolean y)

Specified by:

checkedApply in interface Fn2<Boolean,Boolean,Boolean>

flip

public Xor flip()

Description copied from interface: Monoid

Flip the order of the arguments.

Specified by:

flip in interface Fn2<Boolean,Boolean,Boolean>

Specified by:

flip in interface BiPredicate<Boolean,Boolean>

Specified by:

flip in interface Monoid<Boolean>

Specified by:

flip in interface Semigroup<Boolean>

Returns:

an Fn2<B, A, C>

xor

public static Xor xor()

xor

public static Fn1<Boolean,Boolean> xor(Boolean x)

xor

public static Boolean xor(Boolean x,
                          Boolean y)