uom-types 1.0.3 → 3.0.0

package/dist/functions.d.cts

@@ -1,95 +1,42 @@
-type BrandUnit<T extends Record<string, UnitValue>> = {
-    __exactKeys: keyof ExcludeZeroExponentsKeys<T>;
-    __uom_types: RemoveNever<{
-        [U in keyof T]: U extends keyof ExcludeZeroExponentsKeys<T> ? BrandUnitConfigValue<T[U]> : never;
-    }>;
-};
-type RemoveNever<T> = {
-    [K in keyof T as [T[K]] extends [never] ? never : K]: T[K];
-};
-type BrandUnitConfigValue<T extends UnitValue> = ExcludeZeroExponents<T> & {
-    __exactKeys: keyof ExcludeZeroExponents<T>;
-};
-type GetUnitConfig<T> = T extends UnitFull<infer C> ? C : never;
-type ExcludeZeroExponentsKeys<T extends Record<string, UnitValue>> = {
-    [K in keyof T as T[K] extends {
-        exponent: 0;
-    } ? never : K]: T[K];
-};
-type ExcludeZeroExponents<T extends UnitValue> = {
-    [K in keyof T as T[K] extends 0 ? never : K]: T[K];
-};
-type GetUnitValues<T extends Record<string, UnitValue>, U> = U extends keyof T ? T[U] : {
-    exponent: 0;
-};
-type KeysOfTwoObjects<A, B> = keyof A | keyof B;
-type KeysOfKeyOfTwoObjects<A, B, K> = K extends keyof A ? K extends keyof B ? keyof A[K] | keyof B[K] : keyof A[K] : K extends keyof B ? keyof B[K] : never;
-type Inverse<T extends number> = T extends UnknownUnit ? InverseUnit<T> : number;
-type NegativeExponent<T extends Exponent> = T extends -6 ? 6 : T extends -5 ? 5 : T extends -4 ? 4 : T extends -3 ? 3 : T extends -2 ? 2 : T extends -1 ? 0 : T extends 0 ? 1 : T extends 1 ? -1 : T extends 2 ? -2 : T extends 3 ? -3 : T extends 4 ? -4 : T extends 5 ? -5 : T extends 6 ? -6 : never;
-type InverseUnit<T extends UnknownUnit> = InverseUnitCore<T> extends Record<string, UnitValue> ? Unit<InverseUnitCore<T>> : never;
-type InverseUnitCore<T extends UnknownUnit> = {
-    [U in keyof GetUnitConfig<T>]: {
-        [E in keyof GetUnitConfig<T>[U]]: NegativeExponent<GetUnitConfig<T>[U][E]>;
-    };
-};
-type Multiply<A extends number, B extends number> = A extends UnknownUnit ? B extends UnknownUnit ? MultiplyUnits<A, B> : A : B extends UnknownUnit ? B : number;
-type MultiplyUnits<A extends UnknownUnit, B extends UnknownUnit> = MultiplyUnitsCore<A, B> extends Record<string, UnitValue> ? Unit<FlatternAlias<MultiplyUnitsCore<A, B>>> : never;
-type MultiplyUnitsCore<A extends UnknownUnit, B extends UnknownUnit> = {
-    [U in KeysOfTwoObjects<GetUnitConfig<A>, GetUnitConfig<B>>]: {
-        [E in KeysOfKeyOfTwoObjects<GetUnitConfig<A>, GetUnitConfig<B>, U>]: SumExponents<E extends keyof GetUnitValues<GetUnitConfig<A>, U> ? GetUnitValues<GetUnitConfig<A>, U>[E] extends Exponent ? GetUnitValues<GetUnitConfig<A>, U>[E] : 0 : 0, E extends keyof GetUnitValues<GetUnitConfig<B>, U> ? GetUnitValues<GetUnitConfig<B>, U>[E] extends Exponent ? GetUnitValues<GetUnitConfig<B>, U>[E] : 0 : 0>;
-    };
-};
-type Divide<A extends number, B extends number> = A extends UnknownUnit ? B extends UnknownUnit ? DivideUnits<A, B> : A : B extends UnknownUnit ? Inverse<B> : number;
-type DivideUnits<A extends UnknownUnit, B extends UnknownUnit> = MultiplyUnits<A, InverseUnit<B> extends UnknownUnit ? InverseUnit<B> : never>;
-type SumExponents<A extends Exponent, B extends Exponent> = A extends -6 ? B extends 0 ? A : B extends 1 ? -5 : B extends 2 ? -4 : B extends 3 ? -3 : B extends 4 ? -2 : B extends 5 ? -1 : B extends 6 ? 0 : never : A extends -5 ? B extends -1 ? -6 : B extends 0 ? A : B extends 1 ? -4 : B extends 2 ? -3 : B extends 3 ? -2 : B extends 4 ? -1 : B extends 5 ? 0 : B extends 6 ? 1 : never : A extends -4 ? B extends -2 ? -6 : B extends -1 ? -5 : B extends 0 ? A : B extends 1 ? -3 : B extends 2 ? -2 : B extends 3 ? -1 : B extends 4 ? 0 : B extends 5 ? 1 : B extends 6 ? 2 : never : A extends -3 ? B extends -3 ? -6 : B extends -2 ? -5 : B extends -1 ? -4 : B extends 0 ? A : B extends 1 ? -2 : B extends 2 ? -1 : B extends 3 ? 0 : B extends 4 ? 1 : B extends 5 ? 2 : B extends 6 ? 3 : never : A extends -2 ? B extends -4 ? -6 : B extends -3 ? -5 : B extends -2 ? -4 : B extends -1 ? -3 : B extends 0 ? A : B extends 1 ? -1 : B extends 2 ? 0 : B extends 3 ? 1 : B extends 4 ? 2 : B extends 5 ? 3 : B extends 6 ? 4 : never : A extends -1 ? B extends -5 ? -6 : B extends -4 ? -5 : B extends -3 ? -4 : B extends -2 ? -3 : B extends -1 ? -2 : B extends 0 ? A : B extends 1 ? 0 : B extends 2 ? 1 : B extends 3 ? 2 : B extends 4 ? 3 : B extends 5 ? 4 : B extends 6 ? 5 : never : A extends 0 ? B : A extends 1 ? B extends -6 ? -5 : B extends -5 ? -4 : B extends -4 ? -3 : B extends -3 ? -2 : B extends -2 ? -1 : B extends -1 ? 0 : B extends 0 ? A : B extends 1 ? 2 : B extends 2 ? 3 : B extends 3 ? 4 : B extends 4 ? 5 : B extends 5 ? 6 : never : A extends 2 ? B extends -6 ? -4 : B extends -5 ? -3 : B extends -4 ? -2 : B extends -3 ? -1 : B extends -2 ? 0 : B extends -1 ? 1 : B extends 0 ? A : B extends 1 ? 3 : B extends 2 ? 4 : B extends 3 ? 5 : B extends 4 ? 6 : never : A extends 3 ? B extends -6 ? -3 : B extends -5 ? -2 : B extends -4 ? -1 : B extends -3 ? 0 : B extends -2 ? 1 : B extends -1 ? 2 : B extends 0 ? A : B extends 1 ? 4 : B extends 2 ? 5 : B extends 3 ? 6 : never : A extends 4 ? B extends -6 ? -2 : B extends -5 ? -1 : B extends -4 ? 0 : B extends -3 ? 1 : B extends -2 ? 2 : B extends -1 ? 3 : B extends 0 ? A : B extends 1 ? 5 : B extends 2 ? 6 : never : A extends 5 ? B extends -6 ? -1 : B extends -5 ? 0 : B extends -4 ? 1 : B extends -3 ? 2 : B extends -2 ? 3 : B extends -1 ? 4 : B extends 0 ? A : B extends 1 ? 6 : never : A extends 6 ? B extends -6 ? 0 : B extends -5 ? 1 : B extends -4 ? 2 : B extends -3 ? 3 : B extends -2 ? 4 : B extends -1 ? 5 : B extends 0 ? A : never : never;
-/**
- * Flatten a complex type such as a union or intersection of objects into a
- * single object.
- */
-type FlatternAlias<T> = {
-    [P in keyof T]: T[P];
-} & {};
+import { M as Multiply, D as Divide, I as Inverse, U as UnknownUnit, a as Unit, b as UnknownAbstractUnit, A as AbstractUnit, c as DivideUnitExponents } from './_index.cjs';
+import { R as Radian } from './_angle-plane.cjs';
+import { U as Unitless } from './_identity.cjs';
 
-type Exponent = -6 | -5 | -4 | -3 | -2 | -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6;
-type UnitFull<T extends Record<string, UnitValue>> = number & Readonly<BrandUnit<T>>;
-type UnitValue = {
-    exponent: Exponent;
-} & Record<string, Exponent>;
-/**
- * A unit of measurement.
- */
-type Unit<T extends Record<string, Exponent | UnitValue>> = UnitFull<{
-    [K in keyof T]: T[K] extends Exponent ? {
-        exponent: T[K];
-    } : T[K] extends UnitValue ? T[K] : never;
-}>;
-type UnknownUnit = number & Readonly<{
-    __exactKeys: string;
-    __uom_types: Record<string, {}>;
-}>;
-
-type Decimal = Unit<{}>;
+/**
+ * @module uom-types/functions
+ */
 
-type OperationIO<T extends number> = T extends UnknownUnit ? T : number;
+type OperationIO<T extends number> = [T] extends [
+    UnknownUnit | UnknownAbstractUnit
+] ? T : number;
 /**
- * Add two values together.
+ * 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.
+ * 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: OperationIO<A>, b: OperationIO<B>): OperationIO<Multiply<A, B>>;
+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: OperationIO<A>, b: OperationIO<B>): OperationIO<Divide<A, B>>;
+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`
@@ -98,6 +45,7 @@ declare function mod<T extends number>(a: OperationIO<T>, b: OperationIO<T>): Op
 /**
  * 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).
@@ -105,99 +53,221 @@ declare function mod<T extends number>(a: OperationIO<T>, b: OperationIO<T>): Op
 declare function modSafe<T extends number>(a: OperationIO<T>, b: OperationIO<T>): OperationIO<T>;
 /**
  * Put a number to the power of -1.
+ *
+ * @category Math
  */
-declare function pow<B extends number>(base: OperationIO<B>, exponent: -1): OperationIO<Inverse<B>>;
+declare function pow<B extends number>(base: B, exponent: -1): Inverse<B>;
 /**
  * Put a number to the power of 0.
+ *
+ * @category Math
  */
-declare function pow<B extends number>(base: OperationIO<B>, exponent: 0): OperationIO<B> extends UnknownUnit ? Decimal : 1;
+declare function pow<B extends number>(base: B, exponent: 0): B extends UnknownUnit ? Unit<{}> : B extends UnknownAbstractUnit ? AbstractUnit<{}> : 1;
 /**
  * Put a number to the power of 1/2.
+ *
+ * @category Math
  */
-declare function pow<B extends number>(base: OperationIO<B>, exponent: 0.5): OperationIO<Divide<B, 2>>;
+declare function pow<B extends number>(base: B, exponent: 0.5): DivideUnitExponents<B, 2>;
 /**
  * Put a number to the power of 1.
+ *
+ * @category Math
  */
-declare function pow<E extends number>(base: OperationIO<E>, exponent: 1): E;
+declare function pow<E extends number>(base: E, exponent: 1): E;
 /**
  * Put a number to the power of 2.
+ *
+ * @category Math
  */
-declare function pow<B extends number>(base: OperationIO<B>, exponent: 2): OperationIO<Multiply<B, B>>;
+declare function pow<B extends number>(base: B, exponent: 2): Multiply<B, B>;
 /**
  * Put a number to the power of 3.
+ *
+ * @category Math
  */
-declare function pow<B extends number>(base: OperationIO<B>, exponent: 3): OperationIO<Multiply<B, Multiply<B, B>>>;
+declare function pow<B extends number>(base: B, exponent: 3): Multiply<B, Multiply<B, B>>;
 /**
  * Put a number to the power of 4.
+ *
+ * @category Math
  */
-declare function pow<B extends number>(base: OperationIO<B>, exponent: 4): OperationIO<Multiply<B, Multiply<B, Multiply<B, B>>>>;
+declare function pow<B extends number>(base: B, exponent: 4): Multiply<B, Multiply<B, Multiply<B, B>>>;
 /**
  * Put one number to the power of the other.
+ *
+ * @category Math
  */
-declare function pow<B extends number, E extends number>(base: OperationIO<B>, exponent: E extends UnknownUnit ? never : E): number;
+declare function pow<B extends number, E extends number>(base: B, exponent: E extends UnknownUnit ? never : E extends UnknownAbstractUnit ? never : E): number;
 /**
  * Take the square root of the given value.
+ *
+ * @category Math
  */
-declare function sqrt<T extends number>(value: OperationIO<T>): OperationIO<Divide<T, 2>>;
+declare function sqrt<T extends number>(value: T): DivideUnitExponents<T, 2>;
 /**
  * Inverse the given value.
+ *
+ * @category Math
  */
-declare function inverse<T extends number>(value: OperationIO<T>): OperationIO<Inverse<T>>;
+declare function inverse<T extends number>(value: T): Inverse<T>;
 /**
- * Make the given value negative.
+ * 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 a number.
+ * 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: ReadonlyArray<T>): OperationIO<T>;
-/**
- * Takes the product of all the values in the given collection.
- */
-declare function product<T extends number>(values: ReadonlyArray<T>): OperationIO<T>;
+declare function sum<T extends number>(values: Iterable<T>): OperationIO<T>;
 /**
  * Equal: Compare if two values are equal.
+ *
+ * @category Math
  */
-declare function eq<A extends number>(a: OperationIO<A>, b: A): boolean;
+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<A extends number>(a: OperationIO<A>, b: A): boolean;
+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<A extends number>(a: OperationIO<A>, b: A): boolean;
+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<A extends number>(a: OperationIO<A>, b: A): boolean;
+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 lte<A extends number>(a: OperationIO<A>, b: A): boolean;
+declare function atanh(value: Unitless): Radian;
 
-export { abs, add, ceil, div, eq, floor, gt, gte, inverse, lt, lte, max, min, mod, modSafe, mul, negate, pow, product, round, sqrt, sub, sum };
+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, round, sin, sinh, sqrt, sub, sum, tan, tanh };