IOrdered
Defined in: ordered.ts:10
A totally ordered set — every pair of elements is comparable, and the order is antisymmetric, transitive and total.
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”T extends IOrdered<T>
The carrier set.
Methods
Section titled “Methods”clamp()
Section titled “clamp()”clamp(
lower,upper):T
Defined in: ordered.ts:27
Restricts the value to [lower, upper].
Parameters
Section titled “Parameters”T
T
Returns
Section titled “Returns”T
cmp(
other):Sign
Defined in: ordered.ts:12
Three-way comparison consistent with the total order.
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”eq(
other):boolean
Defined in: ordered.ts:14
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”boolean
gt(
other):boolean
Defined in: ordered.ts:17
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”boolean
gte(
other):boolean
Defined in: ordered.ts:18
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”boolean
lt(
other):boolean
Defined in: ordered.ts:15
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”boolean
lte(
other):boolean
Defined in: ordered.ts:16
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”boolean
max(
other):T
Defined in: ordered.ts:24
The larger of the two operands under the total order.
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”T
min(
other):T
Defined in: ordered.ts:21
The smaller of the two operands under the total order.
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”T