uom-types 3.1.1 → 4.0.0

package/dist/functions.d.mts

@@ -1,243 +0,0 @@
-import { t as Multiply, q as Divide, i as UnknownUnit, h as UnknownAbstractUnit, E as Exponent, P as Pow, R as Root, o as PosExponent, I as Inverse } from './_units.mjs';
-import { R as Radian } from './_angle-plane.mjs';
-import { U as Unitless } from './_identity.mjs';
-
-/**
- * @module uom-types/functions
- */
-
-type OperationIO<T extends number> = [T] extends [
-    UnknownUnit | UnknownAbstractUnit
-] ? T : number;
-/**
- * Add two values with the same units together.
- *
- * @category Math
- */
-declare function add<T extends number>(a: OperationIO<T>, b: OperationIO<T>): OperationIO<T>;
-/**
- * Subtract one value from another with the same units.
- *
- * @category Math
- */
-declare function sub<T extends number>(a: OperationIO<T>, b: OperationIO<T>): OperationIO<T>;
-/**
- * Multiple two values together.
- *
- * @category Math
- */
-declare function mul<A extends number, B extends number>(a: A, b: B): Multiply<A, B>;
-/**
- * Divide one value by another.
- *
- * @category Math
- */
-declare function div<A extends number, B extends number>(a: A, b: B): Divide<A, B>;
-/**
- * Modulo operator.
- *
- * @category Math
- * @param a - Must be an integer.
- * @param b - Must be an integer.
- * @returns `a % b`
- */
-declare function mod<T extends number>(a: OperationIO<T>, b: OperationIO<T>): OperationIO<T>;
-/**
- * Perform mathematic modular arithmetic.
- *
- * @category Math
- * @param a - Must be an integer.
- * @param b - Must be a positive integer.
- * @returns An integer between zero (inclusive) and `b` (exclusive).
- */
-declare function modSafe<T extends number>(a: OperationIO<T>, b: OperationIO<T>): OperationIO<T>;
-/**
- * Raise a number to the power of another.
- *
- * @category Math
- */
-declare function pow<B extends number, E extends number>(base: B, exponent: E extends UnknownUnit ? never : E extends UnknownAbstractUnit ? never : E): E extends Exponent ? Pow<B, E> : number;
-/**
- * Put a number to the power of 1/2.
- *
- * @category Math
- */
-declare function pow<B extends number>(base: B, exponent: 0.5): Root<B, 2>;
-/**
- * Take the nth root of a number.
- *
- * @category Math
- */
-declare function root<B extends number, N extends number>(base: B, exponent: N extends UnknownUnit ? never : N extends UnknownAbstractUnit ? never : N): N extends PosExponent ? Root<B, N> : number;
-/**
- * Take the square root of the given value.
- *
- * @category Math
- */
-declare function sqrt<T extends number>(value: T): Root<T, 2>;
-/**
- * Inverse the given value.
- *
- * @category Math
- */
-declare function inverse<T extends number>(value: T): Inverse<T>;
-/**
- * Returns the negative of the given value.
- *
- * @category Math
- */
-declare function negate<T extends number>(value: OperationIO<T>): OperationIO<T>;
-/**
- * Returns the absolute value of the given value.
- *
- * @category Math
- */
-declare function abs<T extends number>(value: OperationIO<T>): OperationIO<T>;
-/**
- * Returns the greatest integer less than or equal to the given value.
- *
- * @category Math
- */
-declare function floor<T extends number>(value: OperationIO<T>): OperationIO<T>;
-/**
- * Returns the smallest integer greater than or equal the given value.
- *
- * @category Math
- */
-declare function ceil<T extends number>(value: OperationIO<T>): OperationIO<T>;
-/**
- * Returns the given value rounded to the nearest integer.
- *
- * @category Math
- */
-declare function round<T extends number>(value: OperationIO<T>): OperationIO<T>;
-/**
- * Returns the larger value in the given collection.
- *
- * @category Math
- */
-declare function max<T extends number>(values: Iterable<T>): OperationIO<T>;
-/**
- * Returns the smallest value in the given collection.
- *
- * @category Math
- */
-declare function min<T extends number>(values: Iterable<T>): OperationIO<T>;
-/**
- * Takes the sum of all the values in the given collection.
- *
- * @category Math
- */
-declare function sum<T extends number>(values: Iterable<T>): OperationIO<T>;
-/**
- * Equal: Compare if two values are equal.
- *
- * @category Math
- */
-declare function eq<T extends number>(a: OperationIO<T>, b: OperationIO<T>): boolean;
-/**
- * Greater Than: Compare if the first value is greater than the second.
- *
- * @category Math
- */
-declare function gt<T extends number>(a: OperationIO<T>, b: OperationIO<T>): boolean;
-/**
- * Greater Than or Equal: Compare if the first value is greater than or equal to the second.
- *
- * @category Math
- */
-declare function gte<T extends number>(a: OperationIO<T>, b: OperationIO<T>): boolean;
-/**
- * Less Than: Compare if the first value is less than the second.
- *
- * @category Math
- */
-declare function lt<T extends number>(a: OperationIO<T>, b: OperationIO<T>): boolean;
-/**
- * Less Than or Equal: Compare if the first value is less than or equal to the second.
- *
- * @category Math
- */
-declare function lte<T extends number>(a: OperationIO<T>, b: OperationIO<T>): boolean;
-/**
- * Returns the sine of a number.
- *
- * @category Math
- */
-declare function sin(angle: Radian): Unitless;
-/**
- * Returns the cosine of a number.
- *
- * @category Math
- */
-declare function cos(angle: Radian): Unitless;
-/**
- * Returns the tangent of a number.
- *
- * @category Math
- */
-declare function tan(angle: Radian): Unitless;
-/**
- * Returns the arcsine of a number.
- *
- * @category Math
- */
-declare function asin(value: Unitless): Radian;
-/**
- * Returns the arc cosine (or inverse cosine) of a number.
- *
- * @category Math
- */
-declare function acos(value: Unitless): Radian;
-/**
- * Returns the arctangent of a number.
- *
- * @category Math
- */
-declare function atan(value: Unitless): Radian;
-/**
- * Returns the angle (in radians) from the X axis to a point.
- *
- * @category Math
- * @param x - A number representing the cartesian x-coordinate.
- * @param y - A number representing the cartesian y-coordinate.
- */
-declare function atan2<T extends number>(x: T, y: T): Radian;
-/**
- * Returns the hyperbolic sine of a number.
- *
- * @category Math
- */
-declare function sinh(angle: Radian): Unitless;
-/**
- * Returns the hyperbolic cosine of a number.
- *
- * @category Math
- */
-declare function cosh(angle: Radian): Unitless;
-/**
- * Returns the hyperbolic tangent of a number.
- *
- * @category Math
- */
-declare function tanh(angle: Radian): Unitless;
-/**
- * Returns the inverse hyperbolic sine of a number.
- *
- * @category Math
- */
-declare function asinh(value: Unitless): Radian;
-/**
- * Returns the inverse hyperbolic cosine of a number.
- *
- * @category Math
- */
-declare function acosh(value: Unitless): Radian;
-/**
- * Returns the inverse hyperbolic tangent of a number.
- *
- * @category Math
- */
-declare function atanh(value: Unitless): Radian;
-
-export { abs, acos, acosh, add, asin, asinh, atan, atan2, atanh, ceil, cos, cosh, div, eq, floor, gt, gte, inverse, lt, lte, max, min, mod, modSafe, mul, negate, pow, root, round, sin, sinh, sqrt, sub, sum, tan, tanh };

package/dist/functions.mjs

@@ -1,296 +0,0 @@
-/**
- * @module uom-types/functions
- */
-/**
- * Add two values with the same units together.
- *
- * @category Math
- */
-function add(a, b) {
-    return (a + b);
-}
-/**
- * Subtract one value from another with the same units.
- *
- * @category Math
- */
-function sub(a, b) {
-    return (a - b);
-}
-/**
- * Multiple two values together.
- *
- * @category Math
- */
-function mul(a, b) {
-    return (a * b);
-}
-/**
- * Divide one value by another.
- *
- * @category Math
- */
-function div(a, b) {
-    return (a / b);
-}
-/**
- * Modulo operator.
- *
- * @category Math
- * @param a - Must be an integer.
- * @param b - Must be an integer.
- * @returns `a % b`
- */
-function mod(a, b) {
-    return (a % b);
-}
-/**
- * Perform mathematic modular arithmetic.
- *
- * @category Math
- * @param a - Must be an integer.
- * @param b - Must be a positive integer.
- * @returns An integer between zero (inclusive) and `b` (exclusive).
- */
-function modSafe(a, b) {
-    return (((a % b) + b) % b);
-}
-function pow(base, exponent) {
-    return base ** exponent;
-}
-/**
- * Take the nth root of a number.
- *
- * @category Math
- */
-function root(base, exponent) {
-    return (base ** (1 / exponent));
-}
-/**
- * Take the square root of the given value.
- *
- * @category Math
- */
-function sqrt(value) {
-    return root(value, 2);
-}
-/**
- * Inverse the given value.
- *
- * @category Math
- */
-function inverse(value) {
-    return pow(value, -1);
-}
-/**
- * Returns the negative of the given value.
- *
- * @category Math
- */
-function negate(value) {
-    return -value;
-}
-/**
- * Returns the absolute value of the given value.
- *
- * @category Math
- */
-function abs(value) {
-    return Math.abs(value);
-}
-/**
- * Returns the greatest integer less than or equal to the given value.
- *
- * @category Math
- */
-function floor(value) {
-    return Math.floor(value);
-}
-/**
- * Returns the smallest integer greater than or equal the given value.
- *
- * @category Math
- */
-function ceil(value) {
-    return Math.ceil(value);
-}
-/**
- * Returns the given value rounded to the nearest integer.
- *
- * @category Math
- */
-function round(value) {
-    return Math.round(value);
-}
-/**
- * Returns the larger value in the given collection.
- *
- * @category Math
- */
-function max(values) {
-    return Math.max(...values);
-}
-/**
- * Returns the smallest value in the given collection.
- *
- * @category Math
- */
-function min(values) {
-    return Math.min(...values);
-}
-/**
- * Takes the sum of all the values in the given collection.
- *
- * @category Math
- */
-function sum(values) {
-    return [...values].reduce(add, 0);
-}
-/**
- * Equal: Compare if two values are equal.
- *
- * @category Math
- */
-function eq(a, b) {
-    return a === b;
-}
-/**
- * Greater Than: Compare if the first value is greater than the second.
- *
- * @category Math
- */
-function gt(a, b) {
-    return a > b;
-}
-/**
- * Greater Than or Equal: Compare if the first value is greater than or equal to the second.
- *
- * @category Math
- */
-function gte(a, b) {
-    return a >= b;
-}
-/**
- * Less Than: Compare if the first value is less than the second.
- *
- * @category Math
- */
-function lt(a, b) {
-    return a < b;
-}
-/**
- * Less Than or Equal: Compare if the first value is less than or equal to the second.
- *
- * @category Math
- */
-function lte(a, b) {
-    return a <= b;
-}
-/**
- * Returns the sine of a number.
- *
- * @category Math
- */
-function sin(angle) {
-    return Math.sin(angle);
-}
-/**
- * Returns the cosine of a number.
- *
- * @category Math
- */
-function cos(angle) {
-    return Math.cos(angle);
-}
-/**
- * Returns the tangent of a number.
- *
- * @category Math
- */
-function tan(angle) {
-    return Math.tan(angle);
-}
-/**
- * Returns the arcsine of a number.
- *
- * @category Math
- */
-function asin(value) {
-    return Math.asin(value);
-}
-/**
- * Returns the arc cosine (or inverse cosine) of a number.
- *
- * @category Math
- */
-function acos(value) {
-    return Math.acos(value);
-}
-/**
- * Returns the arctangent of a number.
- *
- * @category Math
- */
-function atan(value) {
-    return Math.atan(value);
-}
-/**
- * Returns the angle (in radians) from the X axis to a point.
- *
- * @category Math
- * @param x - A number representing the cartesian x-coordinate.
- * @param y - A number representing the cartesian y-coordinate.
- */
-function atan2(x, y) {
-    return Math.atan2(x, y);
-}
-/**
- * Returns the hyperbolic sine of a number.
- *
- * @category Math
- */
-function sinh(angle) {
-    return Math.sinh(angle);
-}
-/**
- * Returns the hyperbolic cosine of a number.
- *
- * @category Math
- */
-function cosh(angle) {
-    return Math.cosh(angle);
-}
-/**
- * Returns the hyperbolic tangent of a number.
- *
- * @category Math
- */
-function tanh(angle) {
-    return Math.tanh(angle);
-}
-/**
- * Returns the inverse hyperbolic sine of a number.
- *
- * @category Math
- */
-function asinh(value) {
-    return Math.asinh(value);
-}
-/**
- * Returns the inverse hyperbolic cosine of a number.
- *
- * @category Math
- */
-function acosh(value) {
-    return Math.acosh(value);
-}
-/**
- * Returns the inverse hyperbolic tangent of a number.
- *
- * @category Math
- */
-function atanh(value) {
-    return Math.atanh(value);
-}
-
-export { abs, acos, acosh, add, asin, asinh, atan, atan2, atanh, ceil, cos, cosh, div, eq, floor, gt, gte, inverse, lt, lte, max, min, mod, modSafe, mul, negate, pow, root, round, sin, sinh, sqrt, sub, sum, tan, tanh };