uom-types 3.1.1 → 4.0.0

package/dist/functions-higher-order.cjs

@@ -1,125 +0,0 @@
-'use strict';
-
-/**
- * @module uom-types/functions/higher-order
- */
-/**
- * Add two values with the same units together.
- *
- * @category Math
- */
-function add(a) {
-    return (b) => (b + a);
-}
-/**
- * Subtract one value from another with the same units.
- *
- * @category Math
- */
-function sub(a) {
-    return (b) => (b - a);
-}
-/**
- * Multiple a value by the given value.
- *
- * @category Math
- */
-function mul(a) {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-return -- Casting to actual type fails for some reason.
-    return (b) => (b * a);
-}
-/**
- * Divide one value by the given value.
- *
- * @category Math
- */
-function div(a) {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-return -- Casting to actual type fails for some reason.
-    return (b) => (b / a);
-}
-/**
- * Modulo operator.
- *
- * @category Math
- */
-function mod(a) {
-    return (b) => (b % a);
-}
-/**
- * Perform mathematic modular arithmetic.
- *
- * @category Math
- */
-function modSafe(a) {
-    return (b) => (((b % a) + a) % a);
-}
-/**
- * Put a number to the power of the given value.
- *
- * @category Math
- */
-function pow(exponent) {
-    return (base) => (base ** exponent);
-}
-/**
- * Take the nth root of a number.
- *
- * @category Math
- */
-function root(exponent) {
-    return (base) => (base ** (1 / exponent));
-}
-/**
- * Equal: Compare if a value is equal to the given value.
- *
- * @category Math
- */
-function eq(a) {
-    return (b) => b === a;
-}
-/**
- * Greater Than: Compare if a value is greater than the given value.
- *
- * @category Math
- */
-function gt(a) {
-    return (b) => b > a;
-}
-/**
- * Greater Than or Equal: Compare if a value is greater than or equal to the given value.
- *
- * @category Math
- */
-function gte(a) {
-    return (b) => b >= a;
-}
-/**
- * Less Than: Compare if a value is less than the given value.
- *
- * @category Math
- */
-function lt(a) {
-    return (b) => b < a;
-}
-/**
- * Less Than or Equal: Compare if a value is less than or equal to the given value.
- *
- * @category Math
- */
-function lte(a) {
-    return (b) => b <= a;
-}
-
-exports.add = add;
-exports.div = div;
-exports.eq = eq;
-exports.gt = gt;
-exports.gte = gte;
-exports.lt = lt;
-exports.lte = lte;
-exports.mod = mod;
-exports.modSafe = modSafe;
-exports.mul = mul;
-exports.pow = pow;
-exports.root = root;
-exports.sub = sub;

package/dist/functions-higher-order.d.cts

@@ -1,91 +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 } from './_units.cjs';
-
-/**
- * @module uom-types/functions/higher-order
- */
-
-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 a value by the given value.
- *
- * @category Math
- */
-declare function mul<A extends number>(a: A): <B extends number>(b: B) => Multiply<B, A>;
-/**
- * Divide one value by the given value.
- *
- * @category Math
- */
-declare function div<A extends number>(a: A): <B extends number>(b: B) => Divide<B, A>;
-/**
- * Modulo operator.
- *
- * @category Math
- */
-declare function mod<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => OperationIO<T>;
-/**
- * Perform mathematic modular arithmetic.
- *
- * @category Math
- */
-declare function modSafe<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => OperationIO<T>;
-type PowFunction<E extends number, B extends number> = E extends UnknownUnit ? never : E extends UnknownAbstractUnit ? never : E extends Exponent ? (b: B) => Pow<B, E> : E extends 0.5 ? (b: B) => Root<B, 2> : (b: B) => number;
-/**
- * Put a number to the power of the given value.
- *
- * @category Math
- */
-declare function pow<E extends number>(exponent: E): <B extends number>(base: Parameters<PowFunction<E, B>>[0]) => ReturnType<PowFunction<E, B>>;
-type RootFunction<E extends number, B extends number> = E extends UnknownUnit ? never : E extends UnknownAbstractUnit ? never : E extends PosExponent ? (b: B) => Root<B, E> : (b: B) => number;
-/**
- * Take the nth root of a number.
- *
- * @category Math
- */
-declare function root<N extends number>(exponent: N): <B extends number>(base: Parameters<RootFunction<N, B>>[0]) => ReturnType<RootFunction<N, B>>;
-/**
- * Equal: Compare if a value is equal to the given value.
- *
- * @category Math
- */
-declare function eq<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => boolean;
-/**
- * Greater Than: Compare if a value is greater than the given value.
- *
- * @category Math
- */
-declare function gt<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => boolean;
-/**
- * Greater Than or Equal: Compare if a value is greater than or equal to the given value.
- *
- * @category Math
- */
-declare function gte<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => boolean;
-/**
- * Less Than: Compare if a value is less than the given value.
- *
- * @category Math
- */
-declare function lt<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => boolean;
-/**
- * Less Than or Equal: Compare if a value is less than or equal to the given value.
- *
- * @category Math
- */
-declare function lte<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => boolean;
-
-export { add, div, eq, gt, gte, lt, lte, mod, modSafe, mul, pow, root, sub };

package/dist/functions-higher-order.d.mts

@@ -1,91 +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 } from './_units.mjs';
-
-/**
- * @module uom-types/functions/higher-order
- */
-
-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 a value by the given value.
- *
- * @category Math
- */
-declare function mul<A extends number>(a: A): <B extends number>(b: B) => Multiply<B, A>;
-/**
- * Divide one value by the given value.
- *
- * @category Math
- */
-declare function div<A extends number>(a: A): <B extends number>(b: B) => Divide<B, A>;
-/**
- * Modulo operator.
- *
- * @category Math
- */
-declare function mod<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => OperationIO<T>;
-/**
- * Perform mathematic modular arithmetic.
- *
- * @category Math
- */
-declare function modSafe<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => OperationIO<T>;
-type PowFunction<E extends number, B extends number> = E extends UnknownUnit ? never : E extends UnknownAbstractUnit ? never : E extends Exponent ? (b: B) => Pow<B, E> : E extends 0.5 ? (b: B) => Root<B, 2> : (b: B) => number;
-/**
- * Put a number to the power of the given value.
- *
- * @category Math
- */
-declare function pow<E extends number>(exponent: E): <B extends number>(base: Parameters<PowFunction<E, B>>[0]) => ReturnType<PowFunction<E, B>>;
-type RootFunction<E extends number, B extends number> = E extends UnknownUnit ? never : E extends UnknownAbstractUnit ? never : E extends PosExponent ? (b: B) => Root<B, E> : (b: B) => number;
-/**
- * Take the nth root of a number.
- *
- * @category Math
- */
-declare function root<N extends number>(exponent: N): <B extends number>(base: Parameters<RootFunction<N, B>>[0]) => ReturnType<RootFunction<N, B>>;
-/**
- * Equal: Compare if a value is equal to the given value.
- *
- * @category Math
- */
-declare function eq<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => boolean;
-/**
- * Greater Than: Compare if a value is greater than the given value.
- *
- * @category Math
- */
-declare function gt<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => boolean;
-/**
- * Greater Than or Equal: Compare if a value is greater than or equal to the given value.
- *
- * @category Math
- */
-declare function gte<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => boolean;
-/**
- * Less Than: Compare if a value is less than the given value.
- *
- * @category Math
- */
-declare function lt<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => boolean;
-/**
- * Less Than or Equal: Compare if a value is less than or equal to the given value.
- *
- * @category Math
- */
-declare function lte<T extends number>(a: OperationIO<T>): (b: OperationIO<T>) => boolean;
-
-export { add, div, eq, gt, gte, lt, lte, mod, modSafe, mul, pow, root, sub };

package/dist/functions-higher-order.mjs

@@ -1,111 +0,0 @@
-/**
- * @module uom-types/functions/higher-order
- */
-/**
- * Add two values with the same units together.
- *
- * @category Math
- */
-function add(a) {
-    return (b) => (b + a);
-}
-/**
- * Subtract one value from another with the same units.
- *
- * @category Math
- */
-function sub(a) {
-    return (b) => (b - a);
-}
-/**
- * Multiple a value by the given value.
- *
- * @category Math
- */
-function mul(a) {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-return -- Casting to actual type fails for some reason.
-    return (b) => (b * a);
-}
-/**
- * Divide one value by the given value.
- *
- * @category Math
- */
-function div(a) {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-return -- Casting to actual type fails for some reason.
-    return (b) => (b / a);
-}
-/**
- * Modulo operator.
- *
- * @category Math
- */
-function mod(a) {
-    return (b) => (b % a);
-}
-/**
- * Perform mathematic modular arithmetic.
- *
- * @category Math
- */
-function modSafe(a) {
-    return (b) => (((b % a) + a) % a);
-}
-/**
- * Put a number to the power of the given value.
- *
- * @category Math
- */
-function pow(exponent) {
-    return (base) => (base ** exponent);
-}
-/**
- * Take the nth root of a number.
- *
- * @category Math
- */
-function root(exponent) {
-    return (base) => (base ** (1 / exponent));
-}
-/**
- * Equal: Compare if a value is equal to the given value.
- *
- * @category Math
- */
-function eq(a) {
-    return (b) => b === a;
-}
-/**
- * Greater Than: Compare if a value is greater than the given value.
- *
- * @category Math
- */
-function gt(a) {
-    return (b) => b > a;
-}
-/**
- * Greater Than or Equal: Compare if a value is greater than or equal to the given value.
- *
- * @category Math
- */
-function gte(a) {
-    return (b) => b >= a;
-}
-/**
- * Less Than: Compare if a value is less than the given value.
- *
- * @category Math
- */
-function lt(a) {
-    return (b) => b < a;
-}
-/**
- * Less Than or Equal: Compare if a value is less than or equal to the given value.
- *
- * @category Math
- */
-function lte(a) {
-    return (b) => b <= a;
-}
-
-export { add, div, eq, gt, gte, lt, lte, mod, modSafe, mul, pow, root, sub };