 Server : Apache/2 System : Linux server-15-235-50-60 5.15.0-164-generic #174-Ubuntu SMP Fri Nov 14 20:25:16 UTC 2025 x86_64 User : gositeme ( 1004) PHP Version : 8.2.29 Disable Function : exec,system,passthru,shell_exec,proc_close,proc_open,dl,popen,show_source,posix_kill,posix_mkfifo,posix_getpwuid,posix_setpgid,posix_setsid,posix_setuid,posix_setgid,posix_seteuid,posix_setegid,posix_uname Directory : /home/gositeme/domains/lavocat.quebec/private_html/node_modules/effect/src/ |
/**
* This module provides an implementation of the `Order` type class which is used to define a total ordering on some type `A`.
* An order is defined by a relation `<=`, which obeys the following laws:
*
* - either `x <= y` or `y <= x` (totality)
* - if `x <= y` and `y <= x`, then `x == y` (antisymmetry)
* - if `x <= y` and `y <= z`, then `x <= z` (transitivity)
*
* The truth table for compare is defined as follows:
*
* | `x <= y` | `x >= y` | Ordering | |
* | -------- | -------- | -------- | --------------------- |
* | `true` | `true` | `0` | corresponds to x == y |
* | `true` | `false` | `< 0` | corresponds to x < y |
* | `false` | `true` | `> 0` | corresponds to x > y |
*
* @since 2.0.0
*/
import { dual } from "./Function.js"
import type { TypeLambda } from "./HKT.js"
/**
* @category type class
* @since 2.0.0
*/
export interface Order<in A> {
(self: A, that: A): -1 | 0 | 1
}
/**
* @category type lambdas
* @since 2.0.0
*/
export interface OrderTypeLambda extends TypeLambda {
readonly type: Order<this["Target"]>
}
/**
* @category constructors
* @since 2.0.0
*/
export const make = <A>(
compare: (self: A, that: A) => -1 | 0 | 1
): Order<A> =>
(self, that) => self === that ? 0 : compare(self, that)
/**
* @category instances
* @since 2.0.0
*/
export const string: Order<string> = make((self, that) => self < that ? -1 : 1)
/**
* @category instances
* @since 2.0.0
*/
export const number: Order<number> = make((self, that) => self < that ? -1 : 1)
/**
* @category instances
* @since 2.0.0
*/
export const boolean: Order<boolean> = make((self, that) => self < that ? -1 : 1)
/**
* @category instances
* @since 2.0.0
*/
export const bigint: Order<bigint> = make((self, that) => self < that ? -1 : 1)
/**
* @since 2.0.0
*/
export const reverse = <A>(O: Order<A>): Order<A> => make((self, that) => O(that, self))
/**
* @category combining
* @since 2.0.0
*/
export const combine: {
/**
* @category combining
* @since 2.0.0
*/
<A>(that: Order<A>): (self: Order<A>) => Order<A>
/**
* @category combining
* @since 2.0.0
*/
<A>(self: Order<A>, that: Order<A>): Order<A>
} = dual(2, <A>(self: Order<A>, that: Order<A>): Order<A> =>
make((a1, a2) => {
const out = self(a1, a2)
if (out !== 0) {
return out
}
return that(a1, a2)
}))
/**
* @category combining
* @since 2.0.0
*/
export const combineMany: {
/**
* @category combining
* @since 2.0.0
*/
<A>(collection: Iterable<Order<A>>): (self: Order<A>) => Order<A>
/**
* @category combining
* @since 2.0.0
*/
<A>(self: Order<A>, collection: Iterable<Order<A>>): Order<A>
} = dual(2, <A>(self: Order<A>, collection: Iterable<Order<A>>): Order<A> =>
make((a1, a2) => {
let out = self(a1, a2)
if (out !== 0) {
return out
}
for (const O of collection) {
out = O(a1, a2)
if (out !== 0) {
return out
}
}
return out
}))
/**
* @since 2.0.0
*/
export const empty = <A>(): Order<A> => make(() => 0)
/**
* @category combining
* @since 2.0.0
*/
export const combineAll = <A>(collection: Iterable<Order<A>>): Order<A> => combineMany(empty(), collection)
/**
* @category mapping
* @since 2.0.0
*/
export const mapInput: {
/**
* @category mapping
* @since 2.0.0
*/
<B, A>(f: (b: B) => A): (self: Order<A>) => Order<B>
/**
* @category mapping
* @since 2.0.0
*/
<A, B>(self: Order<A>, f: (b: B) => A): Order<B>
} = dual(
2,
<A, B>(self: Order<A>, f: (b: B) => A): Order<B> => make((b1, b2) => self(f(b1), f(b2)))
)
/**
* @category instances
* @since 2.0.0
*/
export const Date: Order<Date> = mapInput(number, (date) => date.getTime())
/**
* @category combining
* @since 2.0.0
*/
export const product: {
<B>(that: Order<B>): <A>(self: Order<A>) => Order<readonly [A, B]> // readonly because invariant
<A, B>(self: Order<A>, that: Order<B>): Order<readonly [A, B]> // readonly because invariant
} = dual(2, <A, B>(self: Order<A>, that: Order<B>): Order<readonly [A, B]> =>
make(([xa, xb], [ya, yb]) => {
const o = self(xa, ya)
return o !== 0 ? o : that(xb, yb)
}))
/**
* @category combining
* @since 2.0.0
*/
export const all = <A>(collection: Iterable<Order<A>>): Order<ReadonlyArray<A>> => {
return make((x, y) => {
const len = Math.min(x.length, y.length)
let collectionLength = 0
for (const O of collection) {
if (collectionLength >= len) {
break
}
const o = O(x[collectionLength], y[collectionLength])
if (o !== 0) {
return o
}
collectionLength++
}
return 0
})
}
/**
* @category combining
* @since 2.0.0
*/
export const productMany: {
<A>(collection: Iterable<Order<A>>): (self: Order<A>) => Order<readonly [A, ...Array<A>]> // readonly because invariant
<A>(self: Order<A>, collection: Iterable<Order<A>>): Order<readonly [A, ...Array<A>]> // readonly because invariant
} = dual(2, <A>(self: Order<A>, collection: Iterable<Order<A>>): Order<readonly [A, ...Array<A>]> => {
const O = all(collection)
return make((x, y) => {
const o = self(x[0], y[0])
return o !== 0 ? o : O(x.slice(1), y.slice(1))
})
})
/**
* Similar to `Promise.all` but operates on `Order`s.
*
* ```
* [Order<A>, Order<B>, ...] -> Order<[A, B, ...]>
* ```
*
* This function creates and returns a new `Order` for a tuple of values based on the given `Order`s for each element in the tuple.
* The returned `Order` compares two tuples of the same type by applying the corresponding `Order` to each element in the tuple.
* It is useful when you need to compare two tuples of the same type and you have a specific way of comparing each element
* of the tuple.
*
* @category combinators
* @since 2.0.0
*/
export const tuple = <T extends ReadonlyArray<Order<any>>>(
...elements: T
): Order<Readonly<{ [I in keyof T]: [T[I]] extends [Order<infer A>] ? A : never }>> => all(elements) as any
/**
* This function creates and returns a new `Order` for an array of values based on a given `Order` for the elements of the array.
* The returned `Order` compares two arrays by applying the given `Order` to each element in the arrays.
* If all elements are equal, the arrays are then compared based on their length.
* It is useful when you need to compare two arrays of the same type and you have a specific way of comparing each element of the array.
*
* @category combinators
* @since 2.0.0
*/
export const array = <A>(O: Order<A>): Order<ReadonlyArray<A>> =>
make((self, that) => {
const aLen = self.length
const bLen = that.length
const len = Math.min(aLen, bLen)
for (let i = 0; i < len; i++) {
const o = O(self[i], that[i])
if (o !== 0) {
return o
}
}
return number(aLen, bLen)
})
/**
* This function creates and returns a new `Order` for a struct of values based on the given `Order`s
* for each property in the struct.
*
* @category combinators
* @since 2.0.0
*/
export const struct = <R extends { readonly [x: string]: Order<any> }>(
fields: R
): Order<{ [K in keyof R]: [R[K]] extends [Order<infer A>] ? A : never }> => {
const keys = Object.keys(fields)
return make((self, that) => {
for (const key of keys) {
const o = fields[key](self[key], that[key])
if (o !== 0) {
return o
}
}
return 0
})
}
/**
* Test whether one value is _strictly less than_ another.
*
* @since 2.0.0
*/
export const lessThan = <A>(O: Order<A>): {
(that: A): (self: A) => boolean
(self: A, that: A): boolean
} => dual(2, (self: A, that: A) => O(self, that) === -1)
/**
* Test whether one value is _strictly greater than_ another.
*
* @since 2.0.0
*/
export const greaterThan = <A>(O: Order<A>): {
(that: A): (self: A) => boolean
(self: A, that: A): boolean
} => dual(2, (self: A, that: A) => O(self, that) === 1)
/**
* Test whether one value is _non-strictly less than_ another.
*
* @since 2.0.0
*/
export const lessThanOrEqualTo = <A>(O: Order<A>): {
(that: A): (self: A) => boolean
(self: A, that: A): boolean
} => dual(2, (self: A, that: A) => O(self, that) !== 1)
/**
* Test whether one value is _non-strictly greater than_ another.
*
* @since 2.0.0
*/
export const greaterThanOrEqualTo = <A>(O: Order<A>): {
(that: A): (self: A) => boolean
(self: A, that: A): boolean
} => dual(2, (self: A, that: A) => O(self, that) !== -1)
/**
* Take the minimum of two values. If they are considered equal, the first argument is chosen.
*
* @since 2.0.0
*/
export const min = <A>(O: Order<A>): {
(that: A): (self: A) => A
(self: A, that: A): A
} => dual(2, (self: A, that: A) => self === that || O(self, that) < 1 ? self : that)
/**
* Take the maximum of two values. If they are considered equal, the first argument is chosen.
*
* @since 2.0.0
*/
export const max = <A>(O: Order<A>): {
(that: A): (self: A) => A
(self: A, that: A): A
} => dual(2, (self: A, that: A) => self === that || O(self, that) > -1 ? self : that)
/**
* Clamp a value between a minimum and a maximum.
*
* @example
* ```ts
* import * as assert from "node:assert"
* import { Order, Number } from "effect"
*
* const clamp = Order.clamp(Number.Order)({ minimum: 1, maximum: 5 })
*
* assert.equal(clamp(3), 3)
* assert.equal(clamp(0), 1)
* assert.equal(clamp(6), 5)
* ```
*
* @since 2.0.0
*/
export const clamp = <A>(O: Order<A>): {
(options: {
minimum: A
maximum: A
}): (self: A) => A
(self: A, options: {
minimum: A
maximum: A
}): A
} =>
dual(
2,
(self: A, options: {
minimum: A
maximum: A
}): A => min(O)(options.maximum, max(O)(options.minimum, self))
)
/**
* Test whether a value is between a minimum and a maximum (inclusive).
*
* @since 2.0.0
*/
export const between = <A>(O: Order<A>): {
(options: {
minimum: A
maximum: A
}): (self: A) => boolean
(self: A, options: {
minimum: A
maximum: A
}): boolean
} =>
dual(
2,
(self: A, options: {
minimum: A
maximum: A
}): boolean => !lessThan(O)(self, options.minimum) && !greaterThan(O)(self, options.maximum)
)