LanguageExt.Core ► Type Classes ► Ord

Contents

Ord <A>

OrdExt

ToComparable <A> (this Ord<A> self)
ToComparer <A> (this Ord<A> self)

TypeClass

greaterThan <ORD, A> (A x, A y)
greaterOrEq <ORD, A> (A x, A y)
lessThan <ORD, A> (A x, A y)
lessOrEq <ORD, A> (A x, A y)
compare <ORD, A> (A x, A y)
compare <ORD, A> (Option<A> x, Option<A> y)
compare <ORD, A> (OptionUnsafe<A> x, OptionUnsafe<A> y)
compare <ORDA, ORDB, A, B> (Either<A, B> x, Either<A, B> y)
compare <ORDA, ORDB, A, B> (EitherUnsafe<A, B> x, EitherUnsafe<A, B> y)
compare <MonoidA, ORDA, ORDB, A, B> (Validation<MonoidA, A, B> x, Validation<MonoidA, A, B> y)
compare <ORD, A> (A[] x, A[] y)
compare <ORD, A> (Lst<A> x, Lst<A> y)
compare <NEWTYPE, ORD, T, PRED> (NEWTYPE x, NEWTYPE y)
compare <NEWTYPE, NUM, T, PRED> (NEWTYPE x, NumType<NEWTYPE, NUM, T, PRED> y)
compare <ORD, A> (TryOption<A> x, TryOption<A> y)
compare <ORD, A> (Try<A> x, Try<A> y)
compare <ORD, L, R> (Either<L, R> x, Either<L, R> y)
compare <ORD, L, R> (EitherUnsafe<L, R> x, EitherUnsafe<L, R> y)
min <OrdA, A> (A x, A y)
max <OrdA, A> (A x, A y)
min <OrdA, A> (A x, A y, A z, params A[] tail)
max <OrdA, A> (A x, A y, A z, params A[] tail)

interface Ord <A> Source #

class OrdExt Source #

Methods

method IComparer<A> ToComparable <A> (this Ord<A> self) Source #

method IComparer<A> ToComparer <A> (this Ord<A> self) Source #

class TypeClass Source #

Methods

method bool greaterThan <ORD, A> (A x, A y) Source #

where ORD : struct, Ord<A>

Returns true if x is greater than y

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	True if x is greater than y

method bool greaterOrEq <ORD, A> (A x, A y) Source #

where ORD : struct, Ord<A>

Returns true if x is greater than or equal to y

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	True if x is greater than or equal to y

method bool lessThan <ORD, A> (A x, A y) Source #

where ORD : struct, Ord<A>

Returns true if x is less than y

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	True if x is less than y

method bool lessOrEq <ORD, A> (A x, A y) Source #

where ORD : struct, Ord<A>

Returns true if x is less than or equal to y

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	True if x is less than or equal to y

method int compare <ORD, A> (A x, A y) Source #

where ORD : struct, Ord<A>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <ORD, A> (Option<A> x, Option<A> y) Source #

where ORD : struct, Ord<A>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <ORD, A> (OptionUnsafe<A> x, OptionUnsafe<A> y) Source #

where ORD : struct, Ord<A>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <ORDA, ORDB, A, B> (Either<A, B> x, Either<A, B> y) Source #

where ORDA : struct, Ord<A>

where ORDB : struct, Ord<B>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <ORDA, ORDB, A, B> (EitherUnsafe<A, B> x, EitherUnsafe<A, B> y) Source #

where ORDA : struct, Ord<A>

where ORDB : struct, Ord<B>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <MonoidA, ORDA, ORDB, A, B> (Validation<MonoidA, A, B> x, Validation<MonoidA, A, B> y) Source #

where MonoidA : struct, Monoid<A>, Eq<A>

where ORDA : struct, Ord<A>

where ORDB : struct, Ord<B>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <ORD, A> (A[] x, A[] y) Source #

where ORD : struct, Ord<A>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <ORD, A> (Lst<A> x, Lst<A> y) Source #

where ORD : struct, Ord<A>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <NEWTYPE, ORD, T, PRED> (NEWTYPE x, NEWTYPE y) Source #

where ORD : struct, Ord<T>

where PRED : struct, Pred<T>

where NEWTYPE : NewType<NEWTYPE, T, PRED, ORD>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <NEWTYPE, NUM, T, PRED> (NEWTYPE x, NumType<NEWTYPE, NUM, T, PRED> y) Source #

where NUM : struct, Num<T>

where PRED : struct, Pred<T>

where NEWTYPE : NumType<NEWTYPE, NUM, T, PRED>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <ORD, A> (TryOption<A> x, TryOption<A> y) Source #

where ORD : struct, Ord<A>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <ORD, A> (Try<A> x, Try<A> y) Source #

where ORD : struct, Ord<A>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <ORD, L, R> (Either<L, R> x, Either<L, R> y) Source #

where ORD : struct, Ord<R>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method int compare <ORD, L, R> (EitherUnsafe<L, R> x, EitherUnsafe<L, R> y) Source #

where ORD : struct, Ord<R>

Compare one item to another to ascertain ordering

Parameters

param	x	The first item to compare
param	y	The second item to compare
returns	0 if x is equal to y -1 if x greater than y 1 if x less than y

method A min <OrdA, A> (A x, A y) Source #

where OrdA : struct, Ord<A>

Find the minimum value between any two values

Parameters

param	x	First value
param	y	Second value
returns	When ordering the two values in ascending order, this is the first of those

method A max <OrdA, A> (A x, A y) Source #

where OrdA : struct, Ord<A>

Find the maximum value between any two values

Parameters

param	x	First value
param	y	Second value
returns	When ordering the two values in ascending order, this is the last of those

method A min <OrdA, A> (A x, A y, A z, params A[] tail) Source #

where OrdA : struct, Ord<A>

Find the minimum value between a set of values

Parameters

param	x	First value
param	y	Second value
param	tail	Remaining values
returns	When ordering the values in ascending order, this is the first of those

method A max <OrdA, A> (A x, A y, A z, params A[] tail) Source #

where OrdA : struct, Ord<A>

Find the maximum value between a set of values

Parameters

param	x	First value
param	y	Second value
param	tail	Remaining values
returns	When ordering the values in ascending order, this is the last of those