/** * This module provides utility functions and type class instances for working with the `number` type in TypeScript. * It includes functions for basic arithmetic operations. * * @since 2.0.0 */ import * as Equ from "./Equivalence.ts"; import * as Option from "./Option.ts"; import * as order from "./Order.ts"; import type { Ordering } from "./Ordering.ts"; import * as Reducer from "./Reducer.ts"; /** * The global `Number` constructor. * * @example * ```ts * import * as N from "effect/Number" * * const num = N.Number("42") * console.log(num) // 42 * * const float = N.Number("3.14") * console.log(float) // 3.14 * ``` * * @category constructors * @since 4.0.0 */ export declare const Number: NumberConstructor; /** * Tests if a value is a `number`. * * @example * ```ts * import { isNumber } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isNumber(2), true) * assert.deepStrictEqual(isNumber("2"), false) * ``` * * @category guards * @since 2.0.0 */ export declare const isNumber: (input: unknown) => input is number; /** * Provides an addition operation on `number`s. * * @example * ```ts * import { sum } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(sum(2, 3), 5) * ``` * * @category math * @since 2.0.0 */ export declare const sum: { /** * Provides an addition operation on `number`s. * * @example * ```ts * import { sum } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(sum(2, 3), 5) * ``` * * @category math * @since 2.0.0 */ (that: number): (self: number) => number; /** * Provides an addition operation on `number`s. * * @example * ```ts * import { sum } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(sum(2, 3), 5) * ``` * * @category math * @since 2.0.0 */ (self: number, that: number): number; }; /** * Provides a multiplication operation on `number`s. * * @example * ```ts * import { multiply } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(multiply(2, 3), 6) * ``` * * @category math * @since 2.0.0 */ export declare const multiply: { /** * Provides a multiplication operation on `number`s. * * @example * ```ts * import { multiply } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(multiply(2, 3), 6) * ``` * * @category math * @since 2.0.0 */ (that: number): (self: number) => number; /** * Provides a multiplication operation on `number`s. * * @example * ```ts * import { multiply } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(multiply(2, 3), 6) * ``` * * @category math * @since 2.0.0 */ (self: number, that: number): number; }; /** * Provides a subtraction operation on `number`s. * * @example * ```ts * import { subtract } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(subtract(2, 3), -1) * ``` * * @category math * @since 2.0.0 */ export declare const subtract: { /** * Provides a subtraction operation on `number`s. * * @example * ```ts * import { subtract } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(subtract(2, 3), -1) * ``` * * @category math * @since 2.0.0 */ (that: number): (self: number) => number; /** * Provides a subtraction operation on `number`s. * * @example * ```ts * import { subtract } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(subtract(2, 3), -1) * ``` * * @category math * @since 2.0.0 */ (self: number, that: number): number; }; /** * Provides a division operation on `number`s. * * Returns `Option.none()` if the divisor is `0`. * * **Example** * * ```ts * import { Number } from "effect" * * Number.divide(6, 3) // Option.some(2) * Number.divide(6, 0) // Option.none() * ``` * * @category math * @since 2.0.0 */ export declare const divide: { /** * Provides a division operation on `number`s. * * Returns `Option.none()` if the divisor is `0`. * * **Example** * * ```ts * import { Number } from "effect" * * Number.divide(6, 3) // Option.some(2) * Number.divide(6, 0) // Option.none() * ``` * * @category math * @since 2.0.0 */ (that: number): (self: number) => Option.Option; /** * Provides a division operation on `number`s. * * Returns `Option.none()` if the divisor is `0`. * * **Example** * * ```ts * import { Number } from "effect" * * Number.divide(6, 3) // Option.some(2) * Number.divide(6, 0) // Option.none() * ``` * * @category math * @since 2.0.0 */ (self: number, that: number): Option.Option; }; /** * Provides an unsafe division operation on `number`s. * * Throws a `RangeError` if the divisor is `0`. * * **Example** * * ```ts * import { Number } from "effect" * * Number.divideUnsafe(6, 3) // 2 * Number.divideUnsafe(6, 0) // throws RangeError("Division by zero") * ``` * * @category math * @since 2.0.0 */ export declare const divideUnsafe: { /** * Provides an unsafe division operation on `number`s. * * Throws a `RangeError` if the divisor is `0`. * * **Example** * * ```ts * import { Number } from "effect" * * Number.divideUnsafe(6, 3) // 2 * Number.divideUnsafe(6, 0) // throws RangeError("Division by zero") * ``` * * @category math * @since 2.0.0 */ (that: number): (self: number) => number; /** * Provides an unsafe division operation on `number`s. * * Throws a `RangeError` if the divisor is `0`. * * **Example** * * ```ts * import { Number } from "effect" * * Number.divideUnsafe(6, 3) // 2 * Number.divideUnsafe(6, 0) // throws RangeError("Division by zero") * ``` * * @category math * @since 2.0.0 */ (self: number, that: number): number; }; /** * Returns the result of adding `1` to a given number. * * @example * ```ts * import { increment } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(increment(2), 3) * ``` * * @category math * @since 2.0.0 */ export declare const increment: (n: number) => number; /** * Decrements a number by `1`. * * @example * ```ts * import { decrement } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(decrement(3), 2) * ``` * * @category math * @since 2.0.0 */ export declare const decrement: (n: number) => number; /** * An `Order` instance for `number` values. * * @example * ```ts * import * as Number from "effect/Number" * * console.log(Number.Order(1, 2)) // -1 * console.log(Number.Order(2, 1)) // 1 * console.log(Number.Order(1, 1)) // 0 * ``` * * @category instances * @since 2.0.0 */ export declare const Order: order.Order; /** * An `Equivalence` instance for numbers. * * `NaN` is considered equal to `NaN`. * * @example * ```ts * import { Number } from "effect" * * console.log(Number.Equivalence(1, 1)) // true * console.log(Number.Equivalence(1, 2)) // false * console.log(Number.Equivalence(NaN, NaN)) // true * ``` * * @category instances * @since 4.0.0 */ export declare const Equivalence: Equ.Equivalence; /** * Returns `true` if the first argument is less than the second, otherwise `false`. * * @example * ```ts * import { isLessThan } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isLessThan(2, 3), true) * assert.deepStrictEqual(isLessThan(3, 3), false) * assert.deepStrictEqual(isLessThan(4, 3), false) * ``` * * @category predicates * @since 2.0.0 */ export declare const isLessThan: { /** * Returns `true` if the first argument is less than the second, otherwise `false`. * * @example * ```ts * import { isLessThan } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isLessThan(2, 3), true) * assert.deepStrictEqual(isLessThan(3, 3), false) * assert.deepStrictEqual(isLessThan(4, 3), false) * ``` * * @category predicates * @since 2.0.0 */ (that: number): (self: number) => boolean; /** * Returns `true` if the first argument is less than the second, otherwise `false`. * * @example * ```ts * import { isLessThan } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isLessThan(2, 3), true) * assert.deepStrictEqual(isLessThan(3, 3), false) * assert.deepStrictEqual(isLessThan(4, 3), false) * ``` * * @category predicates * @since 2.0.0 */ (self: number, that: number): boolean; }; /** * Returns a function that checks if a given `number` is less than or equal to the provided one. * * @example * ```ts * import { isLessThanOrEqualTo } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isLessThanOrEqualTo(2, 3), true) * assert.deepStrictEqual(isLessThanOrEqualTo(3, 3), true) * assert.deepStrictEqual(isLessThanOrEqualTo(4, 3), false) * ``` * * @category predicates * @since 2.0.0 */ export declare const isLessThanOrEqualTo: { /** * Returns a function that checks if a given `number` is less than or equal to the provided one. * * @example * ```ts * import { isLessThanOrEqualTo } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isLessThanOrEqualTo(2, 3), true) * assert.deepStrictEqual(isLessThanOrEqualTo(3, 3), true) * assert.deepStrictEqual(isLessThanOrEqualTo(4, 3), false) * ``` * * @category predicates * @since 2.0.0 */ (that: number): (self: number) => boolean; /** * Returns a function that checks if a given `number` is less than or equal to the provided one. * * @example * ```ts * import { isLessThanOrEqualTo } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isLessThanOrEqualTo(2, 3), true) * assert.deepStrictEqual(isLessThanOrEqualTo(3, 3), true) * assert.deepStrictEqual(isLessThanOrEqualTo(4, 3), false) * ``` * * @category predicates * @since 2.0.0 */ (self: number, that: number): boolean; }; /** * Returns `true` if the first argument is greater than the second, otherwise `false`. * * @example * ```ts * import { isGreaterThan } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isGreaterThan(2, 3), false) * assert.deepStrictEqual(isGreaterThan(3, 3), false) * assert.deepStrictEqual(isGreaterThan(4, 3), true) * ``` * * @category predicates * @since 2.0.0 */ export declare const isGreaterThan: { /** * Returns `true` if the first argument is greater than the second, otherwise `false`. * * @example * ```ts * import { isGreaterThan } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isGreaterThan(2, 3), false) * assert.deepStrictEqual(isGreaterThan(3, 3), false) * assert.deepStrictEqual(isGreaterThan(4, 3), true) * ``` * * @category predicates * @since 2.0.0 */ (that: number): (self: number) => boolean; /** * Returns `true` if the first argument is greater than the second, otherwise `false`. * * @example * ```ts * import { isGreaterThan } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isGreaterThan(2, 3), false) * assert.deepStrictEqual(isGreaterThan(3, 3), false) * assert.deepStrictEqual(isGreaterThan(4, 3), true) * ``` * * @category predicates * @since 2.0.0 */ (self: number, that: number): boolean; }; /** * Returns a function that checks if a given `number` is greater than or equal to the provided one. * * @example * ```ts * import { isGreaterThanOrEqualTo } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isGreaterThanOrEqualTo(2, 3), false) * assert.deepStrictEqual(isGreaterThanOrEqualTo(3, 3), true) * assert.deepStrictEqual(isGreaterThanOrEqualTo(4, 3), true) * ``` * * @category predicates * @since 2.0.0 */ export declare const isGreaterThanOrEqualTo: { /** * Returns a function that checks if a given `number` is greater than or equal to the provided one. * * @example * ```ts * import { isGreaterThanOrEqualTo } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isGreaterThanOrEqualTo(2, 3), false) * assert.deepStrictEqual(isGreaterThanOrEqualTo(3, 3), true) * assert.deepStrictEqual(isGreaterThanOrEqualTo(4, 3), true) * ``` * * @category predicates * @since 2.0.0 */ (that: number): (self: number) => boolean; /** * Returns a function that checks if a given `number` is greater than or equal to the provided one. * * @example * ```ts * import { isGreaterThanOrEqualTo } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(isGreaterThanOrEqualTo(2, 3), false) * assert.deepStrictEqual(isGreaterThanOrEqualTo(3, 3), true) * assert.deepStrictEqual(isGreaterThanOrEqualTo(4, 3), true) * ``` * * @category predicates * @since 2.0.0 */ (self: number, that: number): boolean; }; /** * Checks if a `number` is between a `minimum` and `maximum` value (inclusive). * * @example * ```ts * import * as Number from "effect/Number" * import * as assert from "node:assert" * * const between = Number.between({ minimum: 0, maximum: 5 }) * * assert.deepStrictEqual(between(3), true) * assert.deepStrictEqual(between(-1), false) * assert.deepStrictEqual(between(6), false) * ``` * * @category predicates * @since 2.0.0 */ export declare const between: { /** * Checks if a `number` is between a `minimum` and `maximum` value (inclusive). * * @example * ```ts * import * as Number from "effect/Number" * import * as assert from "node:assert" * * const between = Number.between({ minimum: 0, maximum: 5 }) * * assert.deepStrictEqual(between(3), true) * assert.deepStrictEqual(between(-1), false) * assert.deepStrictEqual(between(6), false) * ``` * * @category predicates * @since 2.0.0 */ (options: { minimum: number; maximum: number; }): (self: number) => boolean; /** * Checks if a `number` is between a `minimum` and `maximum` value (inclusive). * * @example * ```ts * import * as Number from "effect/Number" * import * as assert from "node:assert" * * const between = Number.between({ minimum: 0, maximum: 5 }) * * assert.deepStrictEqual(between(3), true) * assert.deepStrictEqual(between(-1), false) * assert.deepStrictEqual(between(6), false) * ``` * * @category predicates * @since 2.0.0 */ (self: number, options: { minimum: number; maximum: number; }): boolean; }; /** * Restricts the given `number` to be within the range specified by the `minimum` and `maximum` values. * * - If the `number` is less than the `minimum` value, the function returns the `minimum` value. * - If the `number` is greater than the `maximum` value, the function returns the `maximum` value. * - Otherwise, it returns the original `number`. * * @example * ```ts * import * as Number from "effect/Number" * import * as assert from "node:assert" * * const clamp = Number.clamp({ minimum: 1, maximum: 5 }) * * assert.equal(clamp(3), 3) * assert.equal(clamp(0), 1) * assert.equal(clamp(6), 5) * ``` * * @category math * @since 2.0.0 */ export declare const clamp: { /** * Restricts the given `number` to be within the range specified by the `minimum` and `maximum` values. * * - If the `number` is less than the `minimum` value, the function returns the `minimum` value. * - If the `number` is greater than the `maximum` value, the function returns the `maximum` value. * - Otherwise, it returns the original `number`. * * @example * ```ts * import * as Number from "effect/Number" * import * as assert from "node:assert" * * const clamp = Number.clamp({ minimum: 1, maximum: 5 }) * * assert.equal(clamp(3), 3) * assert.equal(clamp(0), 1) * assert.equal(clamp(6), 5) * ``` * * @category math * @since 2.0.0 */ (options: { minimum: number; maximum: number; }): (self: number) => number; /** * Restricts the given `number` to be within the range specified by the `minimum` and `maximum` values. * * - If the `number` is less than the `minimum` value, the function returns the `minimum` value. * - If the `number` is greater than the `maximum` value, the function returns the `maximum` value. * - Otherwise, it returns the original `number`. * * @example * ```ts * import * as Number from "effect/Number" * import * as assert from "node:assert" * * const clamp = Number.clamp({ minimum: 1, maximum: 5 }) * * assert.equal(clamp(3), 3) * assert.equal(clamp(0), 1) * assert.equal(clamp(6), 5) * ``` * * @category math * @since 2.0.0 */ (self: number, options: { minimum: number; maximum: number; }): number; }; /** * Returns the minimum between two `number`s. * * @example * ```ts * import { min } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(min(2, 3), 2) * ``` * * @category math * @since 2.0.0 */ export declare const min: { /** * Returns the minimum between two `number`s. * * @example * ```ts * import { min } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(min(2, 3), 2) * ``` * * @category math * @since 2.0.0 */ (that: number): (self: number) => number; /** * Returns the minimum between two `number`s. * * @example * ```ts * import { min } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(min(2, 3), 2) * ``` * * @category math * @since 2.0.0 */ (self: number, that: number): number; }; /** * Returns the maximum between two `number`s. * * @example * ```ts * import { max } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(max(2, 3), 3) * ``` * * @category math * @since 2.0.0 */ export declare const max: { /** * Returns the maximum between two `number`s. * * @example * ```ts * import { max } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(max(2, 3), 3) * ``` * * @category math * @since 2.0.0 */ (that: number): (self: number) => number; /** * Returns the maximum between two `number`s. * * @example * ```ts * import { max } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(max(2, 3), 3) * ``` * * @category math * @since 2.0.0 */ (self: number, that: number): number; }; /** * Determines the sign of a given `number`. * * @example * ```ts * import { sign } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(sign(-5), -1) * assert.deepStrictEqual(sign(0), 0) * assert.deepStrictEqual(sign(5), 1) * ``` * * @category math * @since 2.0.0 */ export declare const sign: (n: number) => Ordering; /** * Takes an `Iterable` of `number`s and returns their sum as a single `number`. * * @example * ```ts * import { sumAll } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(sumAll([2, 3, 4]), 9) * ``` * * @category math * @since 2.0.0 */ export declare const sumAll: (collection: Iterable) => number; /** * Takes an `Iterable` of `number`s and returns their multiplication as a single `number`. * * @example * ```ts * import { multiplyAll } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(multiplyAll([2, 3, 4]), 24) * ``` * * @category math * @since 2.0.0 */ export declare const multiplyAll: (collection: Iterable) => number; /** * Returns the remainder left over when one operand is divided by a second operand. * * It always takes the sign of the dividend. * * @example * ```ts * import { remainder } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(remainder(2, 2), 0) * assert.deepStrictEqual(remainder(3, 2), 1) * assert.deepStrictEqual(remainder(-4, 2), -0) * ``` * * @category math * @since 2.0.0 */ export declare const remainder: { /** * Returns the remainder left over when one operand is divided by a second operand. * * It always takes the sign of the dividend. * * @example * ```ts * import { remainder } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(remainder(2, 2), 0) * assert.deepStrictEqual(remainder(3, 2), 1) * assert.deepStrictEqual(remainder(-4, 2), -0) * ``` * * @category math * @since 2.0.0 */ (divisor: number): (self: number) => number; /** * Returns the remainder left over when one operand is divided by a second operand. * * It always takes the sign of the dividend. * * @example * ```ts * import { remainder } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(remainder(2, 2), 0) * assert.deepStrictEqual(remainder(3, 2), 1) * assert.deepStrictEqual(remainder(-4, 2), -0) * ``` * * @category math * @since 2.0.0 */ (self: number, divisor: number): number; }; /** * Returns the next power of 2 from the given number. * * @example * ```ts * import { nextPow2 } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(nextPow2(5), 8) * assert.deepStrictEqual(nextPow2(17), 32) * ``` * * @category math * @since 2.0.0 */ export declare const nextPow2: (n: number) => number; /** * Tries to parse a `number` from a `string` using the `Number()` function. * The following special string values are supported: "NaN", "Infinity", "-Infinity". * * **Example** * * ```ts * import { Number } from "effect" * * Number.parse("42") // Option.some(42) * Number.parse("3.14") // Option.some(3.14) * Number.parse("NaN") // Option.some(NaN) * Number.parse("Infinity") // Option.some(Infinity) * Number.parse("-Infinity") // Option.some(-Infinity) * Number.parse("not a number") // Option.none() * ``` * * @category constructors * @since 2.0.0 */ export declare const parse: (s: string) => Option.Option; /** * Returns the number rounded with the given precision. * * @example * ```ts * import { round } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(round(1.1234, 2), 1.12) * assert.deepStrictEqual(round(1.567, 2), 1.57) * ``` * * @category math * @since 3.8.0 */ export declare const round: { /** * Returns the number rounded with the given precision. * * @example * ```ts * import { round } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(round(1.1234, 2), 1.12) * assert.deepStrictEqual(round(1.567, 2), 1.57) * ``` * * @category math * @since 3.8.0 */ (precision: number): (self: number) => number; /** * Returns the number rounded with the given precision. * * @example * ```ts * import { round } from "effect/Number" * import * as assert from "node:assert" * * assert.deepStrictEqual(round(1.1234, 2), 1.12) * assert.deepStrictEqual(round(1.567, 2), 1.57) * ``` * * @category math * @since 3.8.0 */ (self: number, precision: number): number; }; /** * A `Reducer` for combining `number`s using addition. * * @since 4.0.0 */ export declare const ReducerSum: Reducer.Reducer; /** * A `Reducer` for combining `number`s using multiplication. * * @since 4.0.0 */ export declare const ReducerMultiply: Reducer.Reducer; /** * A `Combiner` that returns the maximum `number`. * * @since 4.0.0 */ export declare const ReducerMax: Reducer.Reducer; /** * A `Combiner` that returns the minimum `number`. * * @since 4.0.0 */ export declare const ReducerMin: Reducer.Reducer; //# sourceMappingURL=Number.d.ts.map