Class Compare<A>
- java.lang.Object
-
- com.jnape.palatable.lambda.functions.builtin.fn3.Compare<A>
-
- Type Parameters:
A
- the value type
- All Implemented Interfaces:
Fn1<java.util.Comparator<A>,Fn1<A,Fn1<A,ComparisonRelation>>>
,Fn2<java.util.Comparator<A>,A,Fn1<A,ComparisonRelation>>
,Fn3<java.util.Comparator<A>,A,A,ComparisonRelation>
,Applicative<Fn1<A,Fn1<A,ComparisonRelation>>,Fn1<java.util.Comparator<A>,?>>
,Cartesian<java.util.Comparator<A>,Fn1<A,Fn1<A,ComparisonRelation>>,Fn1<?,?>>
,Cocartesian<java.util.Comparator<A>,Fn1<A,Fn1<A,ComparisonRelation>>,Fn1<?,?>>
,Contravariant<java.util.Comparator<A>,Profunctor<?,Fn1<A,Fn1<A,ComparisonRelation>>,Fn1<?,?>>>
,Functor<Fn1<A,Fn1<A,ComparisonRelation>>,Fn1<java.util.Comparator<A>,?>>
,Profunctor<java.util.Comparator<A>,Fn1<A,Fn1<A,ComparisonRelation>>,Fn1<?,?>>
,Monad<Fn1<A,Fn1<A,ComparisonRelation>>,Fn1<java.util.Comparator<A>,?>>
,MonadReader<java.util.Comparator<A>,Fn1<A,Fn1<A,ComparisonRelation>>,Fn1<java.util.Comparator<A>,?>>
,MonadRec<Fn1<A,Fn1<A,ComparisonRelation>>,Fn1<java.util.Comparator<A>,?>>
,MonadWriter<java.util.Comparator<A>,Fn1<A,Fn1<A,ComparisonRelation>>,Fn1<java.util.Comparator<A>,?>>
public final class Compare<A> extends java.lang.Object implements Fn3<java.util.Comparator<A>,A,A,ComparisonRelation>
Given aComparator
from some typeA
and two values of typeA
, return aComparisonRelation
of the first value with reference to the second value (according toComparator.compare(Object, Object)
. The order of parameters is flipped with respect toComparator.compare(Object, Object)
for more idiomatic partial application.Example:
Compare.compare(naturalOrder(), 1, 2); // ComparisonRelation.GreaterThan Compare.compare(naturalOrder(), 2, 1); // ComparisonRelation.LessThan Compare.compare(naturalOrder(), 1, 1); // ComparisonRelation.Equal
- See Also:
Comparator
,Compare
-
-
Constructor Summary
Constructors Modifier Constructor Description private
Compare()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ComparisonRelation
checkedApply(java.util.Comparator<A> aComparator, A a, A a2)
static <A> Compare<A>
compare()
static <A> Fn2<A,A,ComparisonRelation>
compare(java.util.Comparator<A> comparator)
static <A> Fn1<A,ComparisonRelation>
compare(java.util.Comparator<A> comparator, A a)
static <A> ComparisonRelation
compare(java.util.Comparator<A> aComparator, A a, A a2)
-
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.functions.Fn1
andThen, carry, cartesian, censor, choose, cocartesian, diMap, diMapR, discardL, flatMap, fmap, lazyZip, listens, local, pure, self, thunk, toFunction, trampolineM, zip, zip
-
Methods inherited from interface com.jnape.palatable.lambda.functions.Fn2
checkedApply, toBiFunction
-
-
-
-
Field Detail
-
INSTANCE
private static final Compare<?> INSTANCE
-
-
Method Detail
-
checkedApply
public ComparisonRelation checkedApply(java.util.Comparator<A> aComparator, A a, A a2) throws java.lang.Throwable
- Specified by:
checkedApply
in interfaceFn3<java.util.Comparator<A>,A,A,ComparisonRelation>
- Throws:
java.lang.Throwable
-
compare
public static <A> Compare<A> compare()
-
compare
public static <A> Fn2<A,A,ComparisonRelation> compare(java.util.Comparator<A> comparator)
-
compare
public static <A> Fn1<A,ComparisonRelation> compare(java.util.Comparator<A> comparator, A a)
-
compare
public static <A> ComparisonRelation compare(java.util.Comparator<A> aComparator, A a, A a2)
-
-