|
Copyright 2008 - 2009 Tony Morris, Runar Bjarnason, Tom Adams, Brad Clow, Ricky Clarkson, Nick Partridge, Jason Zaugg This software is released under an open source BSD licence. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfj.pre.Ord<A>
public final class Ord<A>
Tests for ordering between two objects.
Field Summary | |
---|---|
static Ord<BigDecimal> |
bigdecimalOrd
An order instance for the BigDecimal type. |
static Ord<BigInteger> |
bigintOrd
An order instance for the BigInteger type. |
static Ord<Boolean> |
booleanOrd
An order instance for the boolean type. |
static Ord<Byte> |
byteOrd
An order instance for the byte type. |
static Ord<Character> |
charOrd
An order instance for the char type. |
static Ord<Double> |
doubleOrd
An order instance for the double type. |
static Ord<Float> |
floatOrd
An order instance for the float type. |
static Ord<Integer> |
intOrd
An order instance for the int type. |
static Ord<Long> |
longOrd
An order instance for the long type. |
F<A,F<A,A>> |
max
A function that returns the greater of its two arguments. |
F<A,F<A,A>> |
min
A function that returns the lesser of its two arguments. |
static Ord<Natural> |
naturalOrd
An order instance for the long type. |
static Ord<Ordering> |
orderingOrd
An order instance for the Ordering type. |
static Ord<Short> |
shortOrd
An order instance for the short type. |
static Ord<StringBuffer> |
stringBufferOrd
An order instance for the StringBuffer type. |
static Ord<StringBuilder> |
stringBuilderOrd
An order instance for the StringBuffer type. |
static Ord<String> |
stringOrd
An order instance for the String type. |
static Ord<Unit> |
unitOrd
An order instance for the Unit type. |
Method Summary | ||
---|---|---|
static
|
arrayOrd(Ord<A> oa)
An order instance for the Array type. |
|
|
comap(F<B,A> f)
Maps the given function across this ord as a contra-variant functor. |
|
static
|
comparableOrd()
An order instance for the Comparable interface. |
|
F<A,F<A,Ordering>> |
compare()
First-class ordering. |
|
Ordering |
compare(A a1,
A a2)
Returns an ordering for the given arguments. |
|
static
|
eitherOrd(Ord<A> oa,
Ord<B> ob)
An order instance for the Either type. |
|
boolean |
eq(A a1,
A a2)
Returns true if the given arguments are equal, false otherwise. |
|
Equal<A> |
equal()
Returns an Equal for this order. |
|
F<A,Boolean> |
isGreaterThan(A a)
Returns a function that returns true if its argument is greater than than the argument to this method. |
|
boolean |
isGreaterThan(A a1,
A a2)
Returns true if the first given argument is greater than the second given
argument, false otherwise. |
|
F<A,Boolean> |
isLessThan(A a)
Returns a function that returns true if its argument is less than the argument to this method. |
|
boolean |
isLessThan(A a1,
A a2)
Returns true if the first given argument is less than the second given argument,
false otherwise. |
|
static
|
listOrd(Ord<A> oa)
An order instance for the List type. |
|
A |
max(A a1,
A a2)
Returns the greater of its two arguments. |
|
A |
min(A a1,
A a2)
Returns the lesser of its two arguments. |
|
static
|
nonEmptyListOrd(Ord<A> oa)
An order instance for the NonEmptyList type. |
|
static
|
optionOrd(Ord<A> oa)
An order instance for the Option type. |
|
static
|
ord(F<A,F<A,Ordering>> f)
Returns an order instance that uses the given equality test and ordering function. |
|
static
|
p1Ord(Ord<A> oa)
An order instance for a product-1. |
|
static
|
p2Ord(Ord<A> oa,
Ord<B> ob)
An order instance for a product-2, with the first factor considered most significant. |
|
static
|
p3Ord(Ord<A> oa,
Ord<B> ob,
Ord<C> oc)
An order instance for a product-3, with the first factor considered most significant. |
|
static
|
setOrd(Ord<A> oa)
An order instance for the Set type. |
|
static
|
streamOrd(Ord<A> oa)
An order instance for the Stream type. |
|
static
|
validationOrd(Ord<A> oa,
Ord<B> ob)
An order instance for the Validation type. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public F<A,F<A,A>> max
public F<A,F<A,A>> min
public static final Ord<Boolean> booleanOrd
boolean
type.
public static final Ord<Byte> byteOrd
byte
type.
public static final Ord<Character> charOrd
char
type.
public static final Ord<Double> doubleOrd
double
type.
public static final Ord<Float> floatOrd
float
type.
public static final Ord<Integer> intOrd
int
type.
public static final Ord<BigInteger> bigintOrd
BigInteger
type.
public static final Ord<BigDecimal> bigdecimalOrd
BigDecimal
type.
public static final Ord<Long> longOrd
long
type.
public static final Ord<Short> shortOrd
short
type.
public static final Ord<Ordering> orderingOrd
Ordering
type.
public static final Ord<String> stringOrd
String
type.
public static final Ord<StringBuffer> stringBufferOrd
StringBuffer
type.
public static final Ord<StringBuilder> stringBuilderOrd
StringBuffer
type.
public static final Ord<Unit> unitOrd
Unit
type.
public static final Ord<Natural> naturalOrd
long
type.
Method Detail |
---|
public F<A,F<A,Ordering>> compare()
public Ordering compare(A a1, A a2)
a1
- An instance to compare for ordering to another.a2
- An instance to compare for ordering to another.
public boolean eq(A a1, A a2)
true
if the given arguments are equal, false
otherwise.
a1
- An instance to compare for equality to another.a2
- An instance to compare for equality to another.
true
if the given arguments are equal, false
otherwise.public Equal<A> equal()
Equal
for this order.
Equal
for this order.public <B> Ord<B> comap(F<B,A> f)
f
- The function to map.
public boolean isLessThan(A a1, A a2)
true
if the first given argument is less than the second given argument,
false
otherwise.
a1
- An instance to compare for ordering to another.a2
- An instance to compare for ordering to another.
true
if the first given argument is less than the second given argument,
false
otherwise.public boolean isGreaterThan(A a1, A a2)
true
if the first given argument is greater than the second given
argument, false
otherwise.
a1
- An instance to compare for ordering to another.a2
- An instance to compare for ordering to another.
true
if the first given argument is greater than the second given
argument, false
otherwise.public F<A,Boolean> isLessThan(A a)
a
- A value to compare against.
public F<A,Boolean> isGreaterThan(A a)
a
- A value to compare against.
public A max(A a1, A a2)
a1
- A value to compare with another.a2
- A value to compare with another.
public A min(A a1, A a2)
a1
- A value to compare with another.a2
- A value to compare with another.
public static <A> Ord<A> ord(F<A,F<A,Ordering>> f)
f
- The order function.
public static <A> Ord<Option<A>> optionOrd(Ord<A> oa)
Option
type.
oa
- Order across the element of the option.
Option
type.public static <A,B> Ord<Either<A,B>> eitherOrd(Ord<A> oa, Ord<B> ob)
Either
type.
oa
- Order across the left side of Either
.ob
- Order across the right side of Either
.
Either
type.public static <A,B> Ord<Validation<A,B>> validationOrd(Ord<A> oa, Ord<B> ob)
Validation
type.
oa
- Order across the failing side of Validation
.ob
- Order across the succeeding side of Validation
.
Validation
type.public static <A> Ord<List<A>> listOrd(Ord<A> oa)
List
type.
oa
- Order across the elements of the list.
List
type.public static <A> Ord<NonEmptyList<A>> nonEmptyListOrd(Ord<A> oa)
NonEmptyList
type.
oa
- Order across the elements of the non-empty list.
NonEmptyList
type.public static <A> Ord<Stream<A>> streamOrd(Ord<A> oa)
Stream
type.
oa
- Order across the elements of the stream.
Stream
type.public static <A> Ord<Array<A>> arrayOrd(Ord<A> oa)
Array
type.
oa
- Order across the elements of the array.
Array
type.public static <A> Ord<Set<A>> setOrd(Ord<A> oa)
Set
type.
oa
- Order across the elements of the set.
Set
type.public static <A> Ord<P1<A>> p1Ord(Ord<A> oa)
oa
- Order across the produced type.
public static <A,B> Ord<P2<A,B>> p2Ord(Ord<A> oa, Ord<B> ob)
oa
- An order instance for the first factor.ob
- An order instance for the second factor.
public static <A,B,C> Ord<P3<A,B,C>> p3Ord(Ord<A> oa, Ord<B> ob, Ord<C> oc)
oa
- An order instance for the first factor.ob
- An order instance for the second factor.oc
- An order instance for the third factor.
public static <A extends Comparable<A>> Ord<A> comparableOrd()
Comparable
interface.
Comparable
interface.
|
Copyright 2008 - 2009 Tony Morris, Runar Bjarnason, Tom Adams, Brad Clow, Ricky Clarkson, Nick Partridge, Jason Zaugg This software is released under an open source BSD licence. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |