(that: bigint): (self: bigint) => bigint
(self: bigint, that: bigint): bigintDetermines the greatest common divisor of two bigints.
When to use
Use to compute the greatest common divisor of two integer values.
Example (Calculating greatest common divisors)
import { BigInt } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(BigInt.gcd(2n, 3n), 1n)
assert.deepStrictEqual(BigInt.gcd(2n, 4n), 2n)
assert.deepStrictEqual(BigInt.gcd(16n, 24n), 8n)export const const gcd: {
(that: bigint): (self: bigint) => bigint
(self: bigint, that: bigint): bigint
}
Determines the greatest common divisor of two bigints.
When to use
Use to compute the greatest common divisor of two integer values.
Example (Calculating greatest common divisors)
import { BigInt } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(BigInt.gcd(2n, 3n), 1n)
assert.deepStrictEqual(BigInt.gcd(2n, 4n), 2n)
assert.deepStrictEqual(BigInt.gcd(16n, 24n), 8n)
gcd: {
(that: bigintthat: bigint): (self: bigintself: bigint) => bigint
(self: bigintself: bigint, that: bigintthat: bigint): bigint
} = dual<(...args: Array<any>) => any, (self: bigint, that: bigint) => bigint>(arity: 2, body: (self: bigint, that: bigint) => bigint): ((...args: Array<any>) => any) & ((self: bigint, that: bigint) => bigint) (+1 overload)Creates a function that can be called in data-first style or data-last
(pipe-friendly) style.
When to use
Use to expose one implementation through both direct and pipe-friendly
call styles.
Details
Pass either the arity of the uncurried function or a predicate that decides
whether the current call is data-first. Arity is the common case. Use a
predicate when optional arguments make arity ambiguous.
Example (Selecting data-first or data-last style by arity)
import { Function, pipe } from "effect"
const sum = Function.dual<
(that: number) => (self: number) => number,
(self: number, that: number) => number
>(2, (self, that) => self + that)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
Example (Defining overloads with call signatures)
import { Function, pipe } from "effect"
const sum: {
(that: number): (self: number) => number
(self: number, that: number): number
} = Function.dual(2, (self: number, that: number): number => self + that)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
Example (Selecting data-first or data-last style with a predicate)
import { Function, pipe } from "effect"
const sum = Function.dual<
(that: number) => (self: number) => number,
(self: number, that: number) => number
>(
(args) => args.length === 2,
(self, that) => self + that
)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
dual(2, (self: bigintself: bigint, that: bigintthat: bigint): bigint => {
while (that: bigintthat !== const bigint0: bigintbigint0) {
const const t: bigintt = that: bigintthat
that: bigintthat = self: bigintself % that: bigintthat
self: bigintself = const t: bigintt
}
return self: bigintself
})