ts-data-forge 11.0.0 → 12.0.0

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

@@ -3,18 +3,24 @@ import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 export type PositiveFiniteNumber = TtfImported_PositiveFiniteNumber;
 type ElementType = PositiveFiniteNumber;
 /**
- * Checks if a number is a PositiveFiniteNumber (a finite number > 0).
+ * Type guard that checks if a value is a positive finite number.
  *
- * @param value The value to check.
- * @returns `true` if the value is a PositiveFiniteNumber, `false` otherwise.
+ * Returns `true` only for a finite value — never `NaN`, `Infinity`, or
+ * `-Infinity`.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a positive finite number, `false` otherwise
  */
 export declare const isPositiveFiniteNumber: (a: number) => a is TtfImported_PositiveFiniteNumber;
 /**
- * Casts a number to a PositiveFiniteNumber type.
+ * Casts a `number` to the `PositiveFiniteNumber` branded type.
+ *
+ * Validates that the value is a positive finite number and returns it with the
+ * `PositiveFiniteNumber` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a PositiveFiniteNumber type.
- * @throws {TypeError} If the value is not a positive finite number.
+ * @param value - The value to cast
+ * @returns The value as a `PositiveFiniteNumber`
+ * @throws {TypeError} If the value is not a positive finite number
  */
 export declare const asPositiveFiniteNumber: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -30,118 +36,130 @@ export declare const asPositiveFiniteNumber: <N extends number>(x: N) => number
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for positive finite
- * numbers.
+ * Namespace providing type-safe operations for the `PositiveFiniteNumber`
+ * branded type.
  *
- * 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.
+ * The `PositiveFiniteNumber` type represents a positive finite number.
  */
 export declare const PositiveFiniteNumber: {
     /**
-     * Type guard to check if a value is a PositiveFiniteNumber.
+     * Type guard that checks if a value is a positive finite number.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a positive finite number, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a positive finite number, `false` otherwise
+     * @see {@link isPositiveFiniteNumber} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_PositiveFiniteNumber;
     /**
-     * The minimum value for a positive finite number.
-     *
-     * @readonly
+     * The smallest value representable as `PositiveFiniteNumber` (the lower
+     * saturation target of `fromNumber`). The domain is open at `0` (excluded),
+     * so this is `Number.MIN_VALUE` — the smallest positive double — rather than
+     * `0`.
      */
     readonly MIN_VALUE: number;
     /**
-     * Returns the smaller of two PositiveFiniteNumber values.
+     * Returns the smallest of the given positive finite numbers.
      *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns The minimum value as a PositiveFiniteNumber.
+     * @param values - The positive finite numbers to compare (at least one required)
+     * @returns The smallest value as a `PositiveFiniteNumber`
      */
     readonly min: (...values: readonly TtfImported_PositiveFiniteNumber[]) => TtfImported_PositiveFiniteNumber;
     /**
-     * Returns the larger of two PositiveFiniteNumber values.
+     * Returns the largest of the given positive finite numbers.
      *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns The maximum value as a PositiveFiniteNumber.
+     * @param values - The positive finite numbers to compare (at least one required)
+     * @returns The largest value as a `PositiveFiniteNumber`
      */
     readonly max: (...values: readonly TtfImported_PositiveFiniteNumber[]) => TtfImported_PositiveFiniteNumber;
     /**
-     * Clamps a number to the positive finite range.
+     * Converts an arbitrary `number` into a `PositiveFiniteNumber`, saturating it
+     * into the range `[MIN_VALUE, MAX_VALUE]`.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to (0, +∞) as a PositiveFiniteNumber.
+     * Unlike `asPositiveFiniteNumber`, this is total: out-of-range inputs are
+     * clamped to the nearest representable `PositiveFiniteNumber` instead of
+     * throwing.
+     *
+     * @param value - The value to convert
+     * @returns The value as a `PositiveFiniteNumber`
      */
-    readonly clamp: (x: number) => TtfImported_PositiveFiniteNumber;
+    readonly fromNumber: (x: number) => TtfImported_PositiveFiniteNumber;
     /**
-     * Rounds down a PositiveFiniteNumber to the nearest integer.
+     * Returns the greatest integer less than or equal to a positive finite
+     * number.
      *
-     * @param x The PositiveFiniteNumber to round down.
-     * @returns The floor value as a Uint (can be 0).
+     * @param a - The positive finite number value
+     * @returns The floored value as an integer
      */
     readonly floor: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
     /**
-     * Rounds up a PositiveFiniteNumber to the nearest integer.
+     * Returns the smallest integer greater than or equal to a positive finite
+     * number.
      *
-     * @param x The PositiveFiniteNumber to round up.
-     * @returns The ceiling value as a PositiveInt (always >= 1).
+     * @param a - The positive finite number value
+     * @returns The ceiled value as an integer
      */
     readonly ceil: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * Rounds a PositiveFiniteNumber to the nearest integer.
+     * Returns the value of a positive finite number rounded to the nearest
+     * integer.
      *
-     * @param x The PositiveFiniteNumber to round.
-     * @returns The rounded value as a Uint (can be 0 if x < 0.5).
+     * @param a - The positive finite number value
+     * @returns The rounded value as an integer
      */
     readonly round: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
     /**
-     * Generates a random PositiveFiniteNumber value.
+     * Generates a random `PositiveFiniteNumber` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random positive finite number.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `PositiveFiniteNumber` in `[min, max]`
      */
     readonly random: (min?: TtfImported_PositiveFiniteNumber | undefined, max?: TtfImported_PositiveFiniteNumber | undefined) => TtfImported_PositiveFiniteNumber;
     /**
-     * Raises a PositiveFiniteNumber to the power of another PositiveFiniteNumber.
+     * Raises `a` to the power `b`, returning `a ** b` as a
+     * `PositiveFiniteNumber`.
      *
-     * @param a The base PositiveFiniteNumber.
-     * @param b The exponent PositiveFiniteNumber.
-     * @returns `a ** b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     * @param a - The base positive finite number
+     * @param b - The exponent positive finite number
+     * @returns `a ** b` as a `PositiveFiniteNumber`
      */
     readonly pow: (x: TtfImported_PositiveFiniteNumber, y: TtfImported_PositiveFiniteNumber) => TtfImported_PositiveFiniteNumber;
     /**
-     * Adds two PositiveFiniteNumber values.
+     * Adds two positive finite numbers, returning `a + b` as a
+     * `PositiveFiniteNumber`.
      *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns `a + b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     * @param a - The first positive finite number
+     * @param b - The second positive finite number
+     * @returns The sum of `a` and `b` as a `PositiveFiniteNumber`
      */
     readonly add: (x: TtfImported_PositiveFiniteNumber, y: TtfImported_PositiveFiniteNumber) => TtfImported_PositiveFiniteNumber;
     /**
-     * Subtracts one PositiveFiniteNumber from another.
+     * Subtracts two positive finite numbers, returning `a - b` as a
+     * `PositiveFiniteNumber`.
      *
-     * @param a The minuend PositiveFiniteNumber.
-     * @param b The subtrahend PositiveFiniteNumber.
-     * @returns `a - b` clamped to (0, +∞) as a PositiveFiniteNumber (minimum
-     *   MIN_VALUE).
+     * @param a - The first positive finite number
+     * @param b - The second positive finite number
+     * @returns The difference of `a` and `b` as a `PositiveFiniteNumber`
      */
     readonly sub: (x: TtfImported_PositiveFiniteNumber, y: TtfImported_PositiveFiniteNumber) => TtfImported_PositiveFiniteNumber;
     /**
-     * Multiplies two PositiveFiniteNumber values.
+     * Multiplies two positive finite numbers, returning `a * b` as a
+     * `PositiveFiniteNumber`.
      *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns `a * b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     * @param a - The first positive finite number
+     * @param b - The second positive finite number
+     * @returns The product of `a` and `b` as a `PositiveFiniteNumber`
      */
     readonly mul: (x: TtfImported_PositiveFiniteNumber, y: TtfImported_PositiveFiniteNumber) => TtfImported_PositiveFiniteNumber;
     /**
-     * Divides one PositiveFiniteNumber by another.
+     * Divides two positive finite numbers, returning `a / b` as a
+     * `PositiveFiniteNumber`.
      *
-     * @param a The dividend PositiveFiniteNumber.
-     * @param b The divisor PositiveFiniteNumber.
-     * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns `a / b` as a `PositiveFiniteNumber`
      */
     readonly div: (x: TtfImported_PositiveFiniteNumber, y: number & {
         readonly "!=0": true;

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

@@ -1 +1 @@
-{"version":3,"file":"positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,oBAAoB,IAAI,gCAAgC,EAE9D,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,oBAAoB,GAAG,gCAAgC,CAAC;AAEpE,KAAK,WAAW,GAAG,oBAAoB,CAAC;AAqExC;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,sDAAK,CAAC;AAEzC;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;MAAW,CAAC;AAE/C;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;wBAnHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAmHC;;;;;OAKG;uBA/GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAiH3D;;;;;OAKG;wBAjHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAiHC;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,oBAAoB,IAAI,gCAAgC,EAE9D,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,oBAAoB,GAAG,gCAAgC,CAAC;AAEpE,KAAK,WAAW,GAAG,oBAAoB,CAAC;AAqExC;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,sDAAK,CAAC;AAEzC;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;MAAW,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;OAMG;wBA3HA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA2HC;;;;;;OAMG;uBAxHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IA0H3D;;;;;;OAMG;wBA3HA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA2HC;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;CAEK,CAAC"}

package/dist/number/branded-types/positive-finite-number.mjs

@@ -5,8 +5,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -39,108 +39,123 @@ const isPositiveFiniteNumber = is;
 const asPositiveFiniteNumber = castType;
 const PositiveFiniteNumber = {
   /**
-   * Type guard to check if a value is a PositiveFiniteNumber.
+   * Type guard that checks if a value is a positive finite number.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a positive finite number, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a positive finite number, `false` otherwise
+   * @see {@link isPositiveFiniteNumber} for usage examples
    */
   is,
   /**
-   * The minimum value for a positive finite number.
-   *
-   * @readonly
+   * The smallest value representable as `PositiveFiniteNumber` (the lower
+   * saturation target of `fromNumber`). The domain is open at `0` (excluded),
+   * so this is `Number.MIN_VALUE` — the smallest positive double — rather than
+   * `0`.
    */
   MIN_VALUE,
   /**
-   * Returns the smaller of two PositiveFiniteNumber values.
+   * Returns the smallest of the given positive finite numbers.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns The minimum value as a PositiveFiniteNumber.
+   * @param values - The positive finite numbers to compare (at least one required)
+   * @returns The smallest value as a `PositiveFiniteNumber`
    */
   min: min_,
   /**
-   * Returns the larger of two PositiveFiniteNumber values.
+   * Returns the largest of the given positive finite numbers.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns The maximum value as a PositiveFiniteNumber.
+   * @param values - The positive finite numbers to compare (at least one required)
+   * @returns The largest value as a `PositiveFiniteNumber`
    */
   max: max_,
   /**
-   * Clamps a number to the positive finite range.
+   * Converts an arbitrary `number` into a `PositiveFiniteNumber`, saturating it
+   * into the range `[MIN_VALUE, MAX_VALUE]`.
+   *
+   * Unlike `asPositiveFiniteNumber`, this is total: out-of-range inputs are
+   * clamped to the nearest representable `PositiveFiniteNumber` instead of
+   * throwing.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param value - The value to convert
+   * @returns The value as a `PositiveFiniteNumber`
    */
-  clamp,
+  fromNumber,
   /**
-   * Rounds down a PositiveFiniteNumber to the nearest integer.
+   * Returns the greatest integer less than or equal to a positive finite
+   * number.
    *
-   * @param x The PositiveFiniteNumber to round down.
-   * @returns The floor value as a Uint (can be 0).
+   * @param a - The positive finite number value
+   * @returns The floored value as an integer
    */
   floor,
   /**
-   * Rounds up a PositiveFiniteNumber to the nearest integer.
+   * Returns the smallest integer greater than or equal to a positive finite
+   * number.
    *
-   * @param x The PositiveFiniteNumber to round up.
-   * @returns The ceiling value as a PositiveInt (always >= 1).
+   * @param a - The positive finite number value
+   * @returns The ceiled value as an integer
    */
   ceil,
   /**
-   * Rounds a PositiveFiniteNumber to the nearest integer.
+   * Returns the value of a positive finite number rounded to the nearest
+   * integer.
    *
-   * @param x The PositiveFiniteNumber to round.
-   * @returns The rounded value as a Uint (can be 0 if x < 0.5).
+   * @param a - The positive finite number value
+   * @returns The rounded value as an integer
    */
   round,
   /**
-   * Generates a random PositiveFiniteNumber value.
+   * Generates a random `PositiveFiniteNumber` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random positive finite number.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `PositiveFiniteNumber` in `[min, max]`
    */
   random,
   /**
-   * Raises a PositiveFiniteNumber to the power of another PositiveFiniteNumber.
+   * Raises `a` to the power `b`, returning `a ** b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The base PositiveFiniteNumber.
-   * @param b The exponent PositiveFiniteNumber.
-   * @returns `a ** b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The base positive finite number
+   * @param b - The exponent positive finite number
+   * @returns `a ** b` as a `PositiveFiniteNumber`
    */
   pow,
   /**
-   * Adds two PositiveFiniteNumber values.
+   * Adds two positive finite numbers, returning `a + b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns `a + b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The first positive finite number
+   * @param b - The second positive finite number
+   * @returns The sum of `a` and `b` as a `PositiveFiniteNumber`
    */
   add,
   /**
-   * Subtracts one PositiveFiniteNumber from another.
+   * Subtracts two positive finite numbers, returning `a - b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The minuend PositiveFiniteNumber.
-   * @param b The subtrahend PositiveFiniteNumber.
-   * @returns `a - b` clamped to (0, +∞) as a PositiveFiniteNumber (minimum
-   *   MIN_VALUE).
+   * @param a - The first positive finite number
+   * @param b - The second positive finite number
+   * @returns The difference of `a` and `b` as a `PositiveFiniteNumber`
    */
   sub,
   /**
-   * Multiplies two PositiveFiniteNumber values.
+   * Multiplies two positive finite numbers, returning `a * b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns `a * b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The first positive finite number
+   * @param b - The second positive finite number
+   * @returns The product of `a` and `b` as a `PositiveFiniteNumber`
    */
   mul,
   /**
-   * Divides one PositiveFiniteNumber by another.
+   * Divides two positive finite numbers, returning `a / b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The dividend PositiveFiniteNumber.
-   * @param b The divisor PositiveFiniteNumber.
-   * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns `a / b` as a `PositiveFiniteNumber`
    */
   div
 };

package/dist/number/branded-types/positive-finite-number.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"positive-finite-number.mjs","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"sourcesContent":["import {\n  type PositiveInt,\n  type PositiveFiniteNumber as TtfImported_PositiveFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveFiniteNumber = TtfImported_PositiveFiniteNumber;\n\ntype ElementType = PositiveFiniteNumber;\n\nconst typeNameInMessage = 'a positive finite number';\n\nconst {\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  number\n>({\n  MIN_VALUE: Number.MIN_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nconst ceil = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>,\n  PositiveInt\n>('=');\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >,\n  Uint\n>('=');\n\n/**\n * Checks if a number is a PositiveFiniteNumber (a finite number > 0).\n *\n * @param value The value to check.\n * @returns `true` if the value is a PositiveFiniteNumber, `false` otherwise.\n */\nexport const isPositiveFiniteNumber = is;\n\n/**\n * Casts a number to a PositiveFiniteNumber type.\n *\n * @param value The value to cast.\n * @returns The value as a PositiveFiniteNumber type.\n * @throws {TypeError} If the value is not a positive finite number.\n */\nexport const asPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for positive finite\n * numbers.\n *\n * All operations maintain the positive constraint by clamping non-positive\n * results to MIN_VALUE, while ensuring results remain finite (excluding NaN and\n * Infinity). This type is useful for representing quantities that must always\n * be positive, such as probabilities, magnitudes, and physical measurements.\n */\nexport const PositiveFiniteNumber = {\n  /**\n   * Type guard to check if a value is a PositiveFiniteNumber.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a positive finite number, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a positive finite number.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smaller of two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns The minimum value as a PositiveFiniteNumber.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns The maximum value as a PositiveFiniteNumber.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the positive finite range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  clamp,\n\n  /**\n   * Rounds down a PositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The PositiveFiniteNumber to round down.\n   * @returns The floor value as a Uint (can be 0).\n   */\n  floor,\n\n  /**\n   * Rounds up a PositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The PositiveFiniteNumber to round up.\n   * @returns The ceiling value as a PositiveInt (always >= 1).\n   */\n  ceil,\n\n  /**\n   * Rounds a PositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The PositiveFiniteNumber to round.\n   * @returns The rounded value as a Uint (can be 0 if x < 0.5).\n   */\n  round,\n\n  /**\n   * Generates a random PositiveFiniteNumber value.\n   *\n   * @returns A random positive finite number.\n   */\n  random,\n\n  /**\n   * Raises a PositiveFiniteNumber to the power of another PositiveFiniteNumber.\n   *\n   * @param a The base PositiveFiniteNumber.\n   * @param b The exponent PositiveFiniteNumber.\n   * @returns `a ** b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  pow,\n\n  /**\n   * Adds two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns `a + b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  add,\n\n  /**\n   * Subtracts one PositiveFiniteNumber from another.\n   *\n   * @param a The minuend PositiveFiniteNumber.\n   * @param b The subtrahend PositiveFiniteNumber.\n   * @returns `a - b` clamped to (0, +∞) as a PositiveFiniteNumber (minimum\n   *   MIN_VALUE).\n   */\n  sub,\n\n  /**\n   * Multiplies two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns `a * b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  mul,\n\n  /**\n   * Divides one PositiveFiniteNumber by another.\n   *\n   * @param a The dividend PositiveFiniteNumber.\n   * @param b The divisor PositiveFiniteNumber.\n   * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'positive'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'positive'>\n>('<=');\n"],"names":[],"mappings":";;AAYA,MAAM,iBAAA,GAAoB,0BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAIF,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAsBK,MAAM,sBAAA,GAAyB;AAS/B,MAAM,sBAAA,GAAyB;AAW/B,MAAM,oBAAA,GAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlC,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA;AACF;;;;"}
+{"version":3,"file":"positive-finite-number.mjs","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"sourcesContent":["import {\n  type PositiveInt,\n  type PositiveFiniteNumber as TtfImported_PositiveFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveFiniteNumber = TtfImported_PositiveFiniteNumber;\n\ntype ElementType = PositiveFiniteNumber;\n\nconst typeNameInMessage = 'a positive finite number';\n\nconst {\n  MIN_VALUE,\n  add,\n  castType,\n  div,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  number\n>({\n  MIN_VALUE: Number.MIN_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nconst ceil = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>,\n  PositiveInt\n>('=');\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >,\n  Uint\n>('=');\n\n/**\n * Type guard that checks if a value is a positive finite number.\n *\n * Returns `true` only for a finite value — never `NaN`, `Infinity`, or\n * `-Infinity`.\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive finite number, `false` otherwise\n */\nexport const isPositiveFiniteNumber = is;\n\n/**\n * Casts a `number` to the `PositiveFiniteNumber` branded type.\n *\n * Validates that the value is a positive finite number and returns it with the\n * `PositiveFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveFiniteNumber`\n * @throws {TypeError} If the value is not a positive finite number\n */\nexport const asPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveFiniteNumber`\n * branded type.\n *\n * The `PositiveFiniteNumber` type represents a positive finite number.\n */\nexport const PositiveFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a positive finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive finite number, `false` otherwise\n   * @see {@link isPositiveFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveFiniteNumber` (the lower\n   * saturation target of `fromNumber`). The domain is open at `0` (excluded),\n   * so this is `Number.MIN_VALUE` — the smallest positive double — rather than\n   * `0`.\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given positive finite numbers.\n   *\n   * @param values - The positive finite numbers to compare (at least one required)\n   * @returns The smallest value as a `PositiveFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive finite numbers.\n   *\n   * @param values - The positive finite numbers to compare (at least one required)\n   * @returns The largest value as a `PositiveFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `PositiveFiniteNumber`, saturating it\n   * into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asPositiveFiniteNumber`, this is total: out-of-range inputs are\n   * clamped to the nearest representable `PositiveFiniteNumber` instead of\n   * throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `PositiveFiniteNumber`\n   */\n  fromNumber,\n\n  /**\n   * Returns the greatest integer less than or equal to a positive finite\n   * number.\n   *\n   * @param a - The positive finite number value\n   * @returns The floored value as an integer\n   */\n  floor,\n\n  /**\n   * Returns the smallest integer greater than or equal to a positive finite\n   * number.\n   *\n   * @param a - The positive finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a positive finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The positive finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `PositiveFiniteNumber` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `PositiveFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The base positive finite number\n   * @param b - The exponent positive finite number\n   * @returns `a ** b` as a `PositiveFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two positive finite numbers, returning `a + b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The sum of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two positive finite numbers, returning `a - b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The difference of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive finite numbers, returning `a * b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The product of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two positive finite numbers, returning `a / b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `a / b` as a `PositiveFiniteNumber`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'positive'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'positive'>\n>('<=');\n"],"names":[],"mappings":";;AAYA,MAAM,iBAAA,GAAoB,0BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAIF,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAyBK,MAAM,sBAAA,GAAyB;AAY/B,MAAM,sBAAA,GAAyB;AAQ/B,MAAM,oBAAA,GAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlC,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}