ts-data-forge 1.0.0 → 1.0.2

package/dist/number/branded-types/non-zero-uint16.mjs

@@ -0,0 +1,140 @@
+import { TsVerifiedInternals } from '../refined-number-utils.mjs';
+
+const typeNameInMessage = 'a non-zero integer in [1, 2^16)';
+const { MIN_VALUE, MAX_VALUE, min: min_, max: max_, pow, add, sub, mul, div, randomNonZero: random, is, castType, clamp, } = TsVerifiedInternals.RefinedNumberUtils.operatorsForInteger({
+    integerOrSafeInteger: 'SafeInteger',
+    nonZero: true,
+    MIN_VALUE: 1,
+    MAX_VALUE: 2 ** 16 - 1,
+    typeNameInMessage,
+});
+/**
+ * Checks if a number is a NonZeroUint16 (16-bit non-zero unsigned integer in the range [1, 2^16)).
+ * @param value The value to check.
+ * @returns `true` if the value is a NonZeroUint16, `false` otherwise.
+ */
+const isNonZeroUint16 = is;
+/**
+ * Casts a number to a NonZeroUint16 type.
+ * @param value The value to cast.
+ * @returns The value as a NonZeroUint16 type.
+ * @throws {TypeError} If the value is not a non-zero integer in [1, 2^16).
+ * @example
+ * ```typescript
+ * const x = asNonZeroUint16(1000); // NonZeroUint16
+ * const y = asNonZeroUint16(65535); // NonZeroUint16
+ * // asNonZeroUint16(0); // throws TypeError
+ * // asNonZeroUint16(-1); // throws TypeError
+ * // asNonZeroUint16(65536); // throws TypeError
+ * ```
+ */
+const asNonZeroUint16 = castType;
+/**
+ * Namespace providing type-safe arithmetic operations for 16-bit non-zero unsigned integers.
+ *
+ * All operations automatically clamp results to the valid NonZeroUint16 range [1, 65535].
+ * This ensures that all arithmetic maintains the 16-bit non-zero unsigned integer constraint,
+ * with results below 1 clamped to MIN_VALUE and overflow results clamped to MAX_VALUE.
+ *
+ * @example
+ * ```typescript
+ * const a = asNonZeroUint16(60000);
+ * const b = asNonZeroUint16(10000);
+ *
+ * // Arithmetic operations with automatic clamping and non-zero constraint
+ * const sum = NonZeroUint16.add(a, b);       // NonZeroUint16 (65535 - clamped to MAX_VALUE)
+ * const diff = NonZeroUint16.sub(a, b);      // NonZeroUint16 (50000)
+ * const reverseDiff = NonZeroUint16.sub(b, a); // NonZeroUint16 (1 - clamped to MIN_VALUE)
+ * const product = NonZeroUint16.mul(a, b);   // NonZeroUint16 (65535 - clamped due to overflow)
+ *
+ * // Range operations (maintaining non-zero constraint)
+ * const clamped = NonZeroUint16.clamp(-100);     // NonZeroUint16 (1)
+ * const minimum = NonZeroUint16.min(a, b);       // NonZeroUint16 (10000)
+ * const maximum = NonZeroUint16.max(a, b);       // NonZeroUint16 (60000)
+ *
+ * // Utility operations
+ * const random = NonZeroUint16.random();         // NonZeroUint16 (random value in [1, 65535])
+ * const power = NonZeroUint16.pow(asNonZeroUint16(2), asNonZeroUint16(10)); // NonZeroUint16 (1024)
+ * ```
+ */
+const NonZeroUint16 = {
+    /**
+     * Type guard to check if a value is a NonZeroUint16.
+     * @param value The value to check.
+     * @returns `true` if the value is a 16-bit non-zero unsigned integer, `false` otherwise.
+     */
+    is,
+    /**
+     * The minimum value for a 16-bit non-zero unsigned integer.
+     * @readonly
+     */
+    MIN_VALUE,
+    /**
+     * The maximum value for a 16-bit non-zero unsigned integer.
+     * @readonly
+     */
+    MAX_VALUE,
+    /**
+     * Returns the smaller of two NonZeroUint16 values.
+     * @param a The first NonZeroUint16.
+     * @param b The second NonZeroUint16.
+     * @returns The minimum value as a NonZeroUint16.
+     */
+    min: min_,
+    /**
+     * Returns the larger of two NonZeroUint16 values.
+     * @param a The first NonZeroUint16.
+     * @param b The second NonZeroUint16.
+     * @returns The maximum value as a NonZeroUint16.
+     */
+    max: max_,
+    /**
+     * Clamps a number to the NonZeroUint16 range.
+     * @param value The number to clamp.
+     * @returns The value clamped to [1, 65535] as a NonZeroUint16.
+     */
+    clamp,
+    /**
+     * Generates a random NonZeroUint16 value within the valid range.
+     * @returns A random NonZeroUint16 between 1 and 65535.
+     */
+    random,
+    /**
+     * Raises a NonZeroUint16 to the power of another NonZeroUint16.
+     * @param a The base NonZeroUint16.
+     * @param b The exponent NonZeroUint16.
+     * @returns `a ** b` clamped to [1, 65535] as a NonZeroUint16.
+     */
+    pow,
+    /**
+     * Adds two NonZeroUint16 values.
+     * @param a The first NonZeroUint16.
+     * @param b The second NonZeroUint16.
+     * @returns `a + b` clamped to [1, 65535] as a NonZeroUint16.
+     */
+    add,
+    /**
+     * Subtracts one NonZeroUint16 from another.
+     * @param a The minuend NonZeroUint16.
+     * @param b The subtrahend NonZeroUint16.
+     * @returns `a - b` clamped to [1, 65535] as a NonZeroUint16 (minimum 1).
+     */
+    sub,
+    /**
+     * Multiplies two NonZeroUint16 values.
+     * @param a The first NonZeroUint16.
+     * @param b The second NonZeroUint16.
+     * @returns `a * b` clamped to [1, 65535] as a NonZeroUint16.
+     */
+    mul,
+    /**
+     * Divides one NonZeroUint16 by another using floor division.
+     * @param a The dividend NonZeroUint16.
+     * @param b The divisor NonZeroUint16.
+     * @returns `⌊a / b⌋` clamped to [1, 65535] as a NonZeroUint16.
+     */
+    div,
+};
+
+export { NonZeroUint16, asNonZeroUint16, isNonZeroUint16 };
+//# sourceMappingURL=non-zero-uint16.mjs.map

package/dist/number/branded-types/non-zero-uint16.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"non-zero-uint16.mjs","sources":["../../../src/number/branded-types/non-zero-uint16.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAKA,MAAM,iBAAiB,GAAG,iCAAiC;AAE3D,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,aAAa,EAAE,MAAM,EACrB,EAAE,EACF,QAAQ,EACR,KAAK,GACN,GAAG,mBAAmB,CAAC,kBAAkB,CAAC,mBAAmB,CAI5D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,OAAO,EAAE,IAAI;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;AAIG;AACI,MAAM,eAAe,GAAG;AAE/B;;;;;;;;;;;;;AAaG;AACI,MAAM,eAAe,GAAG;AAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BG;AACI,MAAM,aAAa,GAAG;AAC3B;;;;AAIG;IACH,EAAE;AAEF;;;AAGG;IACH,SAAS;AAET;;;AAGG;IACH,SAAS;AAET;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;AAIG;IACH,KAAK;AAEL;;;AAGG;IACH,MAAM;AAEN;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;;;;;"}

package/dist/number/branded-types/non-zero-uint32.d.mts

@@ -0,0 +1,156 @@
+/**
+ * Checks if a number is a NonZeroUint32 (32-bit non-zero unsigned integer in the range [1, 2^32)).
+ * @param value The value to check.
+ * @returns `true` if the value is a NonZeroUint32, `false` otherwise.
+ */
+export declare const isNonZeroUint32: (a: number) => a is PositiveUint32;
+/**
+ * Casts a number to a NonZeroUint32 type.
+ * @param value The value to cast.
+ * @returns The value as a NonZeroUint32 type.
+ * @throws {TypeError} If the value is not a non-zero integer in [1, 2^32).
+ * @example
+ * ```typescript
+ * const x = asNonZeroUint32(1000); // NonZeroUint32
+ * const y = asNonZeroUint32(4294967295); // NonZeroUint32
+ * // asNonZeroUint32(0); // throws TypeError
+ * // asNonZeroUint32(-1); // throws TypeError
+ * // asNonZeroUint32(4294967296); // throws TypeError
+ * ```
+ */
+export declare const asNonZeroUint32: <N extends number>(x: N) => number & {
+    readonly NaNValue: false;
+    readonly "!=0": true;
+    readonly "> -2^16": true;
+    readonly "> -2^32": true;
+    readonly ">= -2^15": true;
+    readonly ">= -2^31": true;
+    readonly ">=0": true;
+    readonly "< 2^32": true;
+    readonly Finite: true;
+    readonly Int: true;
+    readonly SafeInt: true;
+} & Readonly<{
+    'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
+}> & N;
+/**
+ * Namespace providing type-safe arithmetic operations for 32-bit non-zero unsigned integers.
+ *
+ * All operations automatically clamp results to the valid NonZeroUint32 range [1, 4294967295].
+ * This ensures that all arithmetic maintains the 32-bit non-zero unsigned integer constraint,
+ * with results below 1 clamped to MIN_VALUE and overflow results clamped to MAX_VALUE.
+ *
+ * @example
+ * ```typescript
+ * const a = asNonZeroUint32(4000000000);
+ * const b = asNonZeroUint32(1000000000);
+ *
+ * // Arithmetic operations with automatic clamping and non-zero constraint
+ * const sum = NonZeroUint32.add(a, b);       // NonZeroUint32 (4294967295 - clamped to MAX_VALUE)
+ * const diff = NonZeroUint32.sub(a, b);      // NonZeroUint32 (3000000000)
+ * const reverseDiff = NonZeroUint32.sub(b, a); // NonZeroUint32 (1 - clamped to MIN_VALUE)
+ * const product = NonZeroUint32.mul(a, b);   // NonZeroUint32 (4294967295 - clamped due to overflow)
+ *
+ * // Range operations (maintaining non-zero constraint)
+ * const clamped = NonZeroUint32.clamp(-100);     // NonZeroUint32 (1)
+ * const minimum = NonZeroUint32.min(a, b);       // NonZeroUint32 (1000000000)
+ * const maximum = NonZeroUint32.max(a, b);       // NonZeroUint32 (4000000000)
+ *
+ * // Utility operations
+ * const random = NonZeroUint32.random();         // NonZeroUint32 (random value in [1, 4294967295])
+ * const power = NonZeroUint32.pow(asNonZeroUint32(2), asNonZeroUint32(20)); // NonZeroUint32 (1048576)
+ * ```
+ */
+export declare const NonZeroUint32: {
+    /**
+     * Type guard to check if a value is a NonZeroUint32.
+     * @param value The value to check.
+     * @returns `true` if the value is a 32-bit non-zero unsigned integer, `false` otherwise.
+     */
+    readonly is: (a: number) => a is PositiveUint32;
+    /**
+     * The minimum value for a 32-bit non-zero unsigned integer.
+     * @readonly
+     */
+    readonly MIN_VALUE: 1;
+    /**
+     * The maximum value for a 32-bit non-zero unsigned integer.
+     * @readonly
+     */
+    readonly MAX_VALUE: number;
+    /**
+     * Returns the smaller of two NonZeroUint32 values.
+     * @param a The first NonZeroUint32.
+     * @param b The second NonZeroUint32.
+     * @returns The minimum value as a NonZeroUint32.
+     */
+    readonly min: (...values: readonly WithSmallInt<PositiveUint32, 40>[]) => PositiveUint32;
+    /**
+     * Returns the larger of two NonZeroUint32 values.
+     * @param a The first NonZeroUint32.
+     * @param b The second NonZeroUint32.
+     * @returns The maximum value as a NonZeroUint32.
+     */
+    readonly max: (...values: readonly WithSmallInt<PositiveUint32, 40>[]) => PositiveUint32;
+    /**
+     * Clamps a number to the NonZeroUint32 range.
+     * @param value The number to clamp.
+     * @returns The value clamped to [1, 4294967295] as a NonZeroUint32.
+     */
+    readonly clamp: (x: number) => PositiveUint32;
+    /**
+     * Generates a random NonZeroUint32 value within the valid range.
+     * @returns A random NonZeroUint32 between 1 and 4294967295.
+     */
+    readonly random: (min: WithSmallInt<PositiveUint32, 40>, max: WithSmallInt<PositiveUint32, 40>) => PositiveUint32;
+    /**
+     * Raises a NonZeroUint32 to the power of another NonZeroUint32.
+     * @param a The base NonZeroUint32.
+     * @param b The exponent NonZeroUint32.
+     * @returns `a ** b` clamped to [1, 4294967295] as a NonZeroUint32.
+     */
+    readonly pow: (x: WithSmallInt<PositiveUint32, 40>, y: WithSmallInt<PositiveUint32, 40>) => PositiveUint32;
+    /**
+     * Adds two NonZeroUint32 values.
+     * @param a The first NonZeroUint32.
+     * @param b The second NonZeroUint32.
+     * @returns `a + b` clamped to [1, 4294967295] as a NonZeroUint32.
+     */
+    readonly add: (x: WithSmallInt<PositiveUint32, 40>, y: WithSmallInt<PositiveUint32, 40>) => PositiveUint32;
+    /**
+     * Subtracts one NonZeroUint32 from another.
+     * @param a The minuend NonZeroUint32.
+     * @param b The subtrahend NonZeroUint32.
+     * @returns `a - b` clamped to [1, 4294967295] as a NonZeroUint32 (minimum 1).
+     */
+    readonly sub: (x: WithSmallInt<PositiveUint32, 40>, y: WithSmallInt<PositiveUint32, 40>) => PositiveUint32;
+    /**
+     * Multiplies two NonZeroUint32 values.
+     * @param a The first NonZeroUint32.
+     * @param b The second NonZeroUint32.
+     * @returns `a * b` clamped to [1, 4294967295] as a NonZeroUint32.
+     */
+    readonly mul: (x: WithSmallInt<PositiveUint32, 40>, y: WithSmallInt<PositiveUint32, 40>) => PositiveUint32;
+    /**
+     * Divides one NonZeroUint32 by another using floor division.
+     * @param a The dividend NonZeroUint32.
+     * @param b The divisor NonZeroUint32.
+     * @returns `⌊a / b⌋` clamped to [1, 4294967295] as a NonZeroUint32.
+     */
+    readonly div: (x: WithSmallInt<PositiveUint32, 40>, y: 1 | 2 | 3 | 32 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 10 | 24 | 14 | 34 | 12 | 13 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 33 | 35 | 36 | 37 | 38 | 39 | NormalizeBrandUnion<number & {
+        readonly NaNValue: false;
+        readonly "!=0": true;
+        readonly "> -2^16": true;
+        readonly "> -2^32": true;
+        readonly ">= -2^15": true;
+        readonly ">= -2^31": true;
+        readonly ">=0": true;
+        readonly "< 2^32": true;
+        readonly Finite: true;
+        readonly Int: true;
+        readonly SafeInt: true;
+    } & Readonly<{
+        'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
+    }>>) => PositiveUint32;
+};
+//# sourceMappingURL=non-zero-uint32.d.mts.map

package/dist/number/branded-types/non-zero-uint32.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"non-zero-uint32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-uint32.mts"],"names":[],"mappings":"AAiCA;;;;GAIG;AACH,eAAO,MAAM,eAAe,oCAAK,CAAC;AAElC;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,aAAa;IACxB;;;;OAIG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;;;;;;;;;;;;;;;CAEK,CAAC"}

package/dist/number/branded-types/non-zero-uint32.mjs

@@ -0,0 +1,140 @@
+import { TsVerifiedInternals } from '../refined-number-utils.mjs';
+
+const typeNameInMessage = 'a non-zero integer in [1, 2^32)';
+const { MIN_VALUE, MAX_VALUE, min: min_, max: max_, pow, add, sub, mul, div, randomNonZero: random, is, castType, clamp, } = TsVerifiedInternals.RefinedNumberUtils.operatorsForInteger({
+    integerOrSafeInteger: 'SafeInteger',
+    nonZero: true,
+    MIN_VALUE: 1,
+    MAX_VALUE: 2 ** 32 - 1,
+    typeNameInMessage,
+});
+/**
+ * Checks if a number is a NonZeroUint32 (32-bit non-zero unsigned integer in the range [1, 2^32)).
+ * @param value The value to check.
+ * @returns `true` if the value is a NonZeroUint32, `false` otherwise.
+ */
+const isNonZeroUint32 = is;
+/**
+ * Casts a number to a NonZeroUint32 type.
+ * @param value The value to cast.
+ * @returns The value as a NonZeroUint32 type.
+ * @throws {TypeError} If the value is not a non-zero integer in [1, 2^32).
+ * @example
+ * ```typescript
+ * const x = asNonZeroUint32(1000); // NonZeroUint32
+ * const y = asNonZeroUint32(4294967295); // NonZeroUint32
+ * // asNonZeroUint32(0); // throws TypeError
+ * // asNonZeroUint32(-1); // throws TypeError
+ * // asNonZeroUint32(4294967296); // throws TypeError
+ * ```
+ */
+const asNonZeroUint32 = castType;
+/**
+ * Namespace providing type-safe arithmetic operations for 32-bit non-zero unsigned integers.
+ *
+ * All operations automatically clamp results to the valid NonZeroUint32 range [1, 4294967295].
+ * This ensures that all arithmetic maintains the 32-bit non-zero unsigned integer constraint,
+ * with results below 1 clamped to MIN_VALUE and overflow results clamped to MAX_VALUE.
+ *
+ * @example
+ * ```typescript
+ * const a = asNonZeroUint32(4000000000);
+ * const b = asNonZeroUint32(1000000000);
+ *
+ * // Arithmetic operations with automatic clamping and non-zero constraint
+ * const sum = NonZeroUint32.add(a, b);       // NonZeroUint32 (4294967295 - clamped to MAX_VALUE)
+ * const diff = NonZeroUint32.sub(a, b);      // NonZeroUint32 (3000000000)
+ * const reverseDiff = NonZeroUint32.sub(b, a); // NonZeroUint32 (1 - clamped to MIN_VALUE)
+ * const product = NonZeroUint32.mul(a, b);   // NonZeroUint32 (4294967295 - clamped due to overflow)
+ *
+ * // Range operations (maintaining non-zero constraint)
+ * const clamped = NonZeroUint32.clamp(-100);     // NonZeroUint32 (1)
+ * const minimum = NonZeroUint32.min(a, b);       // NonZeroUint32 (1000000000)
+ * const maximum = NonZeroUint32.max(a, b);       // NonZeroUint32 (4000000000)
+ *
+ * // Utility operations
+ * const random = NonZeroUint32.random();         // NonZeroUint32 (random value in [1, 4294967295])
+ * const power = NonZeroUint32.pow(asNonZeroUint32(2), asNonZeroUint32(20)); // NonZeroUint32 (1048576)
+ * ```
+ */
+const NonZeroUint32 = {
+    /**
+     * Type guard to check if a value is a NonZeroUint32.
+     * @param value The value to check.
+     * @returns `true` if the value is a 32-bit non-zero unsigned integer, `false` otherwise.
+     */
+    is,
+    /**
+     * The minimum value for a 32-bit non-zero unsigned integer.
+     * @readonly
+     */
+    MIN_VALUE,
+    /**
+     * The maximum value for a 32-bit non-zero unsigned integer.
+     * @readonly
+     */
+    MAX_VALUE,
+    /**
+     * Returns the smaller of two NonZeroUint32 values.
+     * @param a The first NonZeroUint32.
+     * @param b The second NonZeroUint32.
+     * @returns The minimum value as a NonZeroUint32.
+     */
+    min: min_,
+    /**
+     * Returns the larger of two NonZeroUint32 values.
+     * @param a The first NonZeroUint32.
+     * @param b The second NonZeroUint32.
+     * @returns The maximum value as a NonZeroUint32.
+     */
+    max: max_,
+    /**
+     * Clamps a number to the NonZeroUint32 range.
+     * @param value The number to clamp.
+     * @returns The value clamped to [1, 4294967295] as a NonZeroUint32.
+     */
+    clamp,
+    /**
+     * Generates a random NonZeroUint32 value within the valid range.
+     * @returns A random NonZeroUint32 between 1 and 4294967295.
+     */
+    random,
+    /**
+     * Raises a NonZeroUint32 to the power of another NonZeroUint32.
+     * @param a The base NonZeroUint32.
+     * @param b The exponent NonZeroUint32.
+     * @returns `a ** b` clamped to [1, 4294967295] as a NonZeroUint32.
+     */
+    pow,
+    /**
+     * Adds two NonZeroUint32 values.
+     * @param a The first NonZeroUint32.
+     * @param b The second NonZeroUint32.
+     * @returns `a + b` clamped to [1, 4294967295] as a NonZeroUint32.
+     */
+    add,
+    /**
+     * Subtracts one NonZeroUint32 from another.
+     * @param a The minuend NonZeroUint32.
+     * @param b The subtrahend NonZeroUint32.
+     * @returns `a - b` clamped to [1, 4294967295] as a NonZeroUint32 (minimum 1).
+     */
+    sub,
+    /**
+     * Multiplies two NonZeroUint32 values.
+     * @param a The first NonZeroUint32.
+     * @param b The second NonZeroUint32.
+     * @returns `a * b` clamped to [1, 4294967295] as a NonZeroUint32.
+     */
+    mul,
+    /**
+     * Divides one NonZeroUint32 by another using floor division.
+     * @param a The dividend NonZeroUint32.
+     * @param b The divisor NonZeroUint32.
+     * @returns `⌊a / b⌋` clamped to [1, 4294967295] as a NonZeroUint32.
+     */
+    div,
+};
+
+export { NonZeroUint32, asNonZeroUint32, isNonZeroUint32 };
+//# sourceMappingURL=non-zero-uint32.mjs.map

package/dist/number/branded-types/non-zero-uint32.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"non-zero-uint32.mjs","sources":["../../../src/number/branded-types/non-zero-uint32.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAKA,MAAM,iBAAiB,GAAG,iCAAiC;AAE3D,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,aAAa,EAAE,MAAM,EACrB,EAAE,EACF,QAAQ,EACR,KAAK,GACN,GAAG,mBAAmB,CAAC,kBAAkB,CAAC,mBAAmB,CAI5D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,OAAO,EAAE,IAAI;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;AAIG;AACI,MAAM,eAAe,GAAG;AAE/B;;;;;;;;;;;;;AAaG;AACI,MAAM,eAAe,GAAG;AAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BG;AACI,MAAM,aAAa,GAAG;AAC3B;;;;AAIG;IACH,EAAE;AAEF;;;AAGG;IACH,SAAS;AAET;;;AAGG;IACH,SAAS;AAET;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;AAIG;IACH,KAAK;AAEL;;;AAGG;IACH,MAAM;AAEN;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;;;;;"}

package/dist/number/branded-types/positive-finite-number.d.mts

@@ -0,0 +1,171 @@
+import { TsVerifiedInternals } from '../refined-number-utils.mjs';
+type ElementType = PositiveFiniteNumber;
+/**
+ * Checks if a number is a PositiveFiniteNumber (a finite number > 0).
+ * @param value The value to check.
+ * @returns `true` if the value is a PositiveFiniteNumber, `false` otherwise.
+ */
+export declare const isPositiveFiniteNumber: (a: number) => a is PositiveFiniteNumber;
+/**
+ * Casts a number to a PositiveFiniteNumber type.
+ * @param value The value to cast.
+ * @returns The value as a PositiveFiniteNumber type.
+ * @throws {TypeError} If the value is not a positive finite number.
+ * @example
+ * ```typescript
+ * const x = asPositiveFiniteNumber(5.5); // PositiveFiniteNumber
+ * const y = asPositiveFiniteNumber(0.001); // PositiveFiniteNumber
+ * // asPositiveFiniteNumber(0); // throws TypeError
+ * // asPositiveFiniteNumber(-1); // throws TypeError
+ * ```
+ */
+export declare const asPositiveFiniteNumber: <N extends number>(x: N) => number & {
+    readonly NaNValue: false;
+    readonly "!=0": true;
+    readonly "> -2^16": true;
+    readonly "> -2^32": true;
+    readonly ">= -2^15": true;
+    readonly ">= -2^31": true;
+    readonly ">=0": true;
+    readonly Finite: true;
+} & Readonly<{
+    'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
+}> & N;
+/**
+ * Namespace providing type-safe arithmetic operations for positive finite numbers.
+ *
+ * All operations maintain the positive constraint by clamping non-positive results to MIN_VALUE,
+ * while ensuring results remain finite (excluding NaN and Infinity). This type is useful
+ * for representing quantities that must always be positive, such as probabilities, magnitudes,
+ * and physical measurements.
+ *
+ * @example
+ * ```typescript
+ * const probability = asPositiveFiniteNumber(0.75);
+ * const rate = asPositiveFiniteNumber(1.25);
+ *
+ * // Arithmetic operations with positive clamping
+ * const combined = PositiveFiniteNumber.add(probability, rate);        // PositiveFiniteNumber (2.0)
+ * const difference = PositiveFiniteNumber.sub(rate, probability);      // PositiveFiniteNumber (0.5)
+ * const scaled = PositiveFiniteNumber.mul(probability, rate);          // PositiveFiniteNumber (0.9375)
+ * const ratio = PositiveFiniteNumber.div(rate, probability);           // PositiveFiniteNumber (1.666...)
+ *
+ * // Range operations
+ * const clamped = PositiveFiniteNumber.clamp(-10.5);                  // PositiveFiniteNumber (MIN_VALUE)
+ * const minimum = PositiveFiniteNumber.min(probability, rate);         // PositiveFiniteNumber (0.75)
+ * const maximum = PositiveFiniteNumber.max(probability, rate);         // PositiveFiniteNumber (1.25)
+ *
+ * // Rounding operations (different return types based on operation)
+ * const ceiled = PositiveFiniteNumber.ceil(probability);              // PositiveInt (1)
+ * const floored = PositiveFiniteNumber.floor(rate);                   // Uint (1)
+ * const rounded = PositiveFiniteNumber.round(rate);                   // Uint (1)
+ *
+ * // Utility operations
+ * const random = PositiveFiniteNumber.random();                       // PositiveFiniteNumber (random positive value)
+ * const power = PositiveFiniteNumber.pow(rate, probability);          // PositiveFiniteNumber (1.18...)
+ * ```
+ */
+export declare const PositiveFiniteNumber: {
+    /**
+     * Type guard to check if a value is a PositiveFiniteNumber.
+     * @param value The value to check.
+     * @returns `true` if the value is a positive finite number, `false` otherwise.
+     */
+    readonly is: (a: number) => a is PositiveFiniteNumber;
+    /**
+     * The minimum value for a positive finite number.
+     * @readonly
+     */
+    readonly MIN_VALUE: number;
+    /**
+     * Returns the smaller of two PositiveFiniteNumber values.
+     * @param a The first PositiveFiniteNumber.
+     * @param b The second PositiveFiniteNumber.
+     * @returns The minimum value as a PositiveFiniteNumber.
+     */
+    readonly min: (...values: readonly PositiveFiniteNumber[]) => PositiveFiniteNumber;
+    /**
+     * Returns the larger of two PositiveFiniteNumber values.
+     * @param a The first PositiveFiniteNumber.
+     * @param b The second PositiveFiniteNumber.
+     * @returns The maximum value as a PositiveFiniteNumber.
+     */
+    readonly max: (...values: readonly PositiveFiniteNumber[]) => PositiveFiniteNumber;
+    /**
+     * Clamps a number to the positive finite range.
+     * @param value The number to clamp.
+     * @returns The value clamped to (0, +∞) as a PositiveFiniteNumber.
+     */
+    readonly clamp: (x: number) => PositiveFiniteNumber;
+    /**
+     * Rounds down a PositiveFiniteNumber to the nearest integer.
+     * @param x The PositiveFiniteNumber to round down.
+     * @returns The floor value as a Uint (can be 0).
+     */
+    readonly floor: (x: ElementType) => TsVerifiedInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsVerifiedInternals.RefinedNumberUtils.ToInt<ElementType>>;
+    /**
+     * Rounds up a PositiveFiniteNumber to the nearest integer.
+     * @param x The PositiveFiniteNumber to round up.
+     * @returns The ceiling value as a PositiveInt (always >= 1).
+     */
+    readonly ceil: (x: ElementType) => TsVerifiedInternals.RefinedNumberUtils.ToInt<ElementType>;
+    /**
+     * Rounds a PositiveFiniteNumber to the nearest integer.
+     * @param x The PositiveFiniteNumber to round.
+     * @returns The rounded value as a Uint (can be 0 if x < 0.5).
+     */
+    readonly round: (x: ElementType) => TsVerifiedInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsVerifiedInternals.RefinedNumberUtils.ToInt<ElementType>>;
+    /**
+     * Generates a random PositiveFiniteNumber value.
+     * @returns A random positive finite number.
+     */
+    readonly random: (min: PositiveFiniteNumber, max: PositiveFiniteNumber) => PositiveFiniteNumber;
+    /**
+     * Raises a PositiveFiniteNumber to the power of another PositiveFiniteNumber.
+     * @param a The base PositiveFiniteNumber.
+     * @param b The exponent PositiveFiniteNumber.
+     * @returns `a ** b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     */
+    readonly pow: (x: PositiveFiniteNumber, y: PositiveFiniteNumber) => PositiveFiniteNumber;
+    /**
+     * Adds two PositiveFiniteNumber values.
+     * @param a The first PositiveFiniteNumber.
+     * @param b The second PositiveFiniteNumber.
+     * @returns `a + b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     */
+    readonly add: (x: PositiveFiniteNumber, y: PositiveFiniteNumber) => PositiveFiniteNumber;
+    /**
+     * Subtracts one PositiveFiniteNumber from another.
+     * @param a The minuend PositiveFiniteNumber.
+     * @param b The subtrahend PositiveFiniteNumber.
+     * @returns `a - b` clamped to (0, +∞) as a PositiveFiniteNumber (minimum MIN_VALUE).
+     */
+    readonly sub: (x: PositiveFiniteNumber, y: PositiveFiniteNumber) => PositiveFiniteNumber;
+    /**
+     * Multiplies two PositiveFiniteNumber values.
+     * @param a The first PositiveFiniteNumber.
+     * @param b The second PositiveFiniteNumber.
+     * @returns `a * b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     */
+    readonly mul: (x: PositiveFiniteNumber, y: PositiveFiniteNumber) => PositiveFiniteNumber;
+    /**
+     * Divides one PositiveFiniteNumber by another.
+     * @param a The dividend PositiveFiniteNumber.
+     * @param b The divisor PositiveFiniteNumber.
+     * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     */
+    readonly div: (x: PositiveFiniteNumber, y: number & {
+        readonly NaNValue: false;
+        readonly "!=0": true;
+        readonly "> -2^16": true;
+        readonly "> -2^32": true;
+        readonly ">= -2^15": true;
+        readonly ">= -2^31": true;
+        readonly ">=0": true;
+        readonly Finite: true;
+    } & Readonly<{
+        'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
+    }>) => PositiveFiniteNumber;
+};
+export {};
+//# sourceMappingURL=positive-finite-number.d.mts.map

package/dist/number/branded-types/positive-finite-number.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,KAAK,WAAW,GAAG,oBAAoB,CAAC;AAiExC;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,0CAAK,CAAC;AAEzC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;MAAW,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;OAIG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;wBAtIA,WAAW,KACb,mBAAmB,CAAC,kBAAkB,CAAC,qBAAqB,CAC7D,mBAAmB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC1D;IAsIC;;;;OAIG;uBAnIA,WAAW,KACb,mBAAmB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAqI1D;;;;OAIG;wBApIA,WAAW,KACb,mBAAmB,CAAC,kBAAkB,CAAC,qBAAqB,CAC7D,mBAAmB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC1D;IAoIC;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;;;;;;;;;;;;CAEK,CAAC"}