ts-data-forge 11.0.0 → 12.0.0

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

@@ -6,7 +6,7 @@ const {
   MAX_VALUE,
   add,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -19,7 +19,7 @@ const {
   MAX_VALUE: -Number.MIN_VALUE,
   typeNameInMessage
 });
-const abs = (x) => PositiveFiniteNumber.clamp(Math.abs(x));
+const abs = (x) => PositiveFiniteNumber.fromNumber(Math.abs(x));
 const floor = (x) => (
   // eslint-disable-next-line total-functions/no-unsafe-type-assertion
   Math.floor(x)
@@ -38,101 +38,114 @@ const isNegativeFiniteNumber = is;
 const asNegativeFiniteNumber = castType;
 const NegativeFiniteNumber = {
   /**
-   * Type guard to check if a value is a NegativeFiniteNumber.
+   * Type guard that checks if a value is a negative finite number.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a negative finite number, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a negative finite number, `false` otherwise
+   * @see {@link isNegativeFiniteNumber} for usage examples
    */
   is,
   /**
-   * The maximum value for a negative finite number.
-   *
-   * @readonly
+   * The largest value representable as `NegativeFiniteNumber` (the upper
+   * saturation target of `fromNumber`). The domain is open at `0` (excluded),
+   * so this is `-Number.MIN_VALUE` — the negative double closest to `0` —
+   * rather than `0`.
    */
   MAX_VALUE,
   /**
    * Returns the absolute value of a negative finite number.
    *
-   * @param a The negative finite number.
-   * @returns The absolute value as a PositiveFiniteNumber.
+   * The result is non-negative and keeps the `NegativeFiniteNumber` brand.
+   *
+   * @param a - The negative finite number value
+   * @returns The absolute value as a non-negative `NegativeFiniteNumber`
    */
   abs,
   /**
-   * Returns the smaller of two NegativeFiniteNumber values.
+   * Returns the smallest of the given negative finite numbers.
    *
-   * @param a The first NegativeFiniteNumber.
-   * @param b The second NegativeFiniteNumber.
-   * @returns The minimum value as a NegativeFiniteNumber.
+   * @param values - The negative finite numbers to compare (at least one required)
+   * @returns The smallest value as a `NegativeFiniteNumber`
    */
   min: min_,
   /**
-   * Returns the larger of two NegativeFiniteNumber values.
+   * Returns the largest of the given negative finite numbers.
    *
-   * @param a The first NegativeFiniteNumber.
-   * @param b The second NegativeFiniteNumber.
-   * @returns The maximum value as a NegativeFiniteNumber.
+   * @param values - The negative finite numbers to compare (at least one required)
+   * @returns The largest value as a `NegativeFiniteNumber`
    */
   max: max_,
   /**
-   * Clamps a number to the negative finite range.
+   * Converts an arbitrary `number` into a `NegativeFiniteNumber`, saturating it
+   * into the range `[MIN_VALUE, MAX_VALUE]`.
+   *
+   * Unlike `asNegativeFiniteNumber`, this is total: out-of-range inputs are
+   * clamped to the nearest representable `NegativeFiniteNumber` instead of
+   * throwing.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to `(-∞, 0)` as a NegativeFiniteNumber.
+   * @param value - The value to convert
+   * @returns The value as a `NegativeFiniteNumber`
    */
-  clamp,
+  fromNumber,
   /**
-   * Rounds down a NegativeFiniteNumber to the nearest integer.
+   * Returns the greatest integer less than or equal to a negative finite
+   * number.
    *
-   * @param x The NegativeFiniteNumber to round down.
-   * @returns The floor value as a NegativeInt (always `<= -1`).
+   * @param a - The negative finite number value
+   * @returns The floored value as an integer
    */
   floor,
   /**
-   * Rounds up a NegativeFiniteNumber to the nearest integer.
+   * Returns the smallest integer greater than or equal to a negative finite
+   * number.
    *
-   * @param x The NegativeFiniteNumber to round up.
-   * @returns The ceiling value as a NonPositiveInt (can be 0).
+   * @param a - The negative finite number value
+   * @returns The ceiled value as an integer
    */
   ceil,
   /**
-   * Rounds a NegativeFiniteNumber to the nearest integer.
+   * Returns the value of a negative finite number rounded to the nearest
+   * integer.
    *
-   * @param x The NegativeFiniteNumber to round.
-   * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).
+   * @param a - The negative finite number value
+   * @returns The rounded value as an integer
    */
   round,
   /**
-   * Generates a random NegativeFiniteNumber value.
+   * Generates a random `NegativeFiniteNumber` within the given range.
    *
-   * @returns A random negative finite number.
+   * The range is inclusive on both ends.
+   *
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NegativeFiniteNumber` in `[min, max]`
    */
   random,
   /**
-   * Raises a NegativeFiniteNumber to the power of another NegativeFiniteNumber.
+   * Raises `a` to the power `b`, returning `a ** b` as a
+   * `NegativeFiniteNumber`.
    *
-   * @param a The base NegativeFiniteNumber.
-   * @param b The exponent NegativeFiniteNumber.
-   * @returns `a ** b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.
+   * @param a - The base negative finite number
+   * @param b - The exponent negative finite number
+   * @returns `a ** b` as a `NegativeFiniteNumber`
    */
   pow,
   /**
-   * Adds two NegativeFiniteNumber values.
+   * Adds two negative finite numbers, returning `a + b` as a
+   * `NegativeFiniteNumber`.
    *
-   * @param a The first NegativeFiniteNumber.
-   * @param b The second NegativeFiniteNumber.
-   * @returns `a + b` as a NegativeFiniteNumber.
+   * @param a - The first negative finite number
+   * @param b - The second negative finite number
+   * @returns The sum of `a` and `b` as a `NegativeFiniteNumber`
    */
   add,
   /**
-   * Subtracts one NegativeFiniteNumber from another.
-   *
-   * The mathematical result can be positive, so it is clamped to the negative
-   * finite range (maximum `-Number.MIN_VALUE`).
+   * Subtracts two negative finite numbers, returning `a - b` as a
+   * `NegativeFiniteNumber`.
    *
-   * @param a The minuend NegativeFiniteNumber.
-   * @param b The subtrahend NegativeFiniteNumber.
-   * @returns `a - b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.
+   * @param a - The first negative finite number
+   * @param b - The second negative finite number
+   * @returns The difference of `a` and `b` as a `NegativeFiniteNumber`
    */
   sub
 };

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

@@ -1 +1 @@
-{"version":3,"file":"negative-finite-number.mjs","sources":["../../../src/number/branded-types/negative-finite-number.mts"],"sourcesContent":["import { type NegativeFiniteNumber as TtfImported_NegativeFiniteNumber } from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveFiniteNumber } from './positive-finite-number.mjs';\n\nexport type NegativeFiniteNumber = TtfImported_NegativeFiniteNumber;\n\ntype ElementType = NegativeFiniteNumber;\n\nconst typeNameInMessage = 'a negative finite number';\n\nconst {\n  MAX_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  number\n>({\n  nonZero: true,\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: -Number.MIN_VALUE,\n  typeNameInMessage,\n} as const);\n\n/**\n * Returns the absolute value of a negative finite number.\n *\n * The absolute value of a negative finite number is always a positive finite\n * number, so the result is typed as a {@link PositiveFiniteNumber}.\n *\n * @param x - The negative finite number.\n * @returns `|x|` as a PositiveFiniteNumber.\n */\nconst abs = (x: ElementType): PositiveFiniteNumber =>\n  PositiveFiniteNumber.clamp(Math.abs(x));\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst ceil = (\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.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\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\n/**\n * Checks if a number is a NegativeFiniteNumber (a finite number `< 0`).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NegativeFiniteNumber, `false` otherwise.\n */\nexport const isNegativeFiniteNumber = is;\n\n/**\n * Casts a number to a NegativeFiniteNumber type.\n *\n * @param value The value to cast.\n * @returns The value as a NegativeFiniteNumber type.\n * @throws {TypeError} If the value is not a negative finite number.\n */\nexport const asNegativeFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for negative finite\n * numbers.\n *\n * All operations keep results finite (excluding NaN and Infinity). Operations\n * that stay within the negative finite numbers clamp their results to the valid\n * range, while operations whose result leaves the set (`mul`, `div`, `abs`) are\n * typed to reflect the actual sign of the result.\n */\nexport const NegativeFiniteNumber = {\n  /**\n   * Type guard to check if a value is a NegativeFiniteNumber.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a negative finite number, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The maximum value for a negative finite number.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative finite number.\n   *\n   * @param a The negative finite number.\n   * @returns The absolute value as a PositiveFiniteNumber.\n   */\n  abs,\n\n  /**\n   * Returns the smaller of two NegativeFiniteNumber values.\n   *\n   * @param a The first NegativeFiniteNumber.\n   * @param b The second NegativeFiniteNumber.\n   * @returns The minimum value as a NegativeFiniteNumber.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two NegativeFiniteNumber values.\n   *\n   * @param a The first NegativeFiniteNumber.\n   * @param b The second NegativeFiniteNumber.\n   * @returns The maximum value as a NegativeFiniteNumber.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the negative finite range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to `(-∞, 0)` as a NegativeFiniteNumber.\n   */\n  clamp,\n\n  /**\n   * Rounds down a NegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NegativeFiniteNumber to round down.\n   * @returns The floor value as a NegativeInt (always `<= -1`).\n   */\n  floor,\n\n  /**\n   * Rounds up a NegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NegativeFiniteNumber to round up.\n   * @returns The ceiling value as a NonPositiveInt (can be 0).\n   */\n  ceil,\n\n  /**\n   * Rounds a NegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NegativeFiniteNumber to round.\n   * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).\n   */\n  round,\n\n  /**\n   * Generates a random NegativeFiniteNumber value.\n   *\n   * @returns A random negative finite number.\n   */\n  random,\n\n  /**\n   * Raises a NegativeFiniteNumber to the power of another NegativeFiniteNumber.\n   *\n   * @param a The base NegativeFiniteNumber.\n   * @param b The exponent NegativeFiniteNumber.\n   * @returns `a ** b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.\n   */\n  pow,\n\n  /**\n   * Adds two NegativeFiniteNumber values.\n   *\n   * @param a The first NegativeFiniteNumber.\n   * @param b The second NegativeFiniteNumber.\n   * @returns `a + b` as a NegativeFiniteNumber.\n   */\n  add,\n\n  /**\n   * Subtracts one NegativeFiniteNumber from another.\n   *\n   * The mathematical result can be positive, so it is clamped to the negative\n   * finite range (maximum `-Number.MIN_VALUE`).\n   *\n   * @param a The minuend NegativeFiniteNumber.\n   * @param b The subtrahend NegativeFiniteNumber.\n   * @returns `a - b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAQA,MAAM,iBAAA,GAAoB,0BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB;AACF,CAAU,CAAA;AAWV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,oBAAA,CAAqB,MAAM,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAExC,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAEd,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAIb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAUK,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,EAQA,GAAA;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;AAAA;AAAA,EAYA;AACF;;;;"}
+{"version":3,"file":"negative-finite-number.mjs","sources":["../../../src/number/branded-types/negative-finite-number.mts"],"sourcesContent":["import { type NegativeFiniteNumber as TtfImported_NegativeFiniteNumber } from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveFiniteNumber } from './positive-finite-number.mjs';\n\nexport type NegativeFiniteNumber = TtfImported_NegativeFiniteNumber;\n\ntype ElementType = NegativeFiniteNumber;\n\nconst typeNameInMessage = 'a negative finite number';\n\nconst {\n  MAX_VALUE,\n  add,\n  castType,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  number\n>({\n  nonZero: true,\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: -Number.MIN_VALUE,\n  typeNameInMessage,\n} as const);\n\nconst abs = (x: ElementType): PositiveFiniteNumber =>\n  PositiveFiniteNumber.fromNumber(Math.abs(x));\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst ceil = (\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.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\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\n/**\n * Type guard that checks if a value is a negative 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 negative finite number, `false` otherwise\n */\nexport const isNegativeFiniteNumber = is;\n\n/**\n * Casts a `number` to the `NegativeFiniteNumber` branded type.\n *\n * Validates that the value is a negative finite number and returns it with the\n * `NegativeFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NegativeFiniteNumber`\n * @throws {TypeError} If the value is not a negative finite number\n */\nexport const asNegativeFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `NegativeFiniteNumber`\n * branded type.\n *\n * The `NegativeFiniteNumber` type represents a negative finite number.\n */\nexport const NegativeFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a negative finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a negative finite number, `false` otherwise\n   * @see {@link isNegativeFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The largest value representable as `NegativeFiniteNumber` (the upper\n   * saturation target of `fromNumber`). The domain is open at `0` (excluded),\n   * so this is `-Number.MIN_VALUE` — the negative double closest to `0` —\n   * rather than `0`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative finite number.\n   *\n   * The result is non-negative and keeps the `NegativeFiniteNumber` brand.\n   *\n   * @param a - The negative finite number value\n   * @returns The absolute value as a non-negative `NegativeFiniteNumber`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given negative finite numbers.\n   *\n   * @param values - The negative finite numbers to compare (at least one required)\n   * @returns The smallest value as a `NegativeFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given negative finite numbers.\n   *\n   * @param values - The negative finite numbers to compare (at least one required)\n   * @returns The largest value as a `NegativeFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NegativeFiniteNumber`, saturating it\n   * into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asNegativeFiniteNumber`, this is total: out-of-range inputs are\n   * clamped to the nearest representable `NegativeFiniteNumber` instead of\n   * throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NegativeFiniteNumber`\n   */\n  fromNumber,\n\n  /**\n   * Returns the greatest integer less than or equal to a negative finite\n   * number.\n   *\n   * @param a - The negative 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 negative finite\n   * number.\n   *\n   * @param a - The negative finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a negative finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The negative finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `NegativeFiniteNumber` 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 `NegativeFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `NegativeFiniteNumber`.\n   *\n   * @param a - The base negative finite number\n   * @param b - The exponent negative finite number\n   * @returns `a ** b` as a `NegativeFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two negative finite numbers, returning `a + b` as a\n   * `NegativeFiniteNumber`.\n   *\n   * @param a - The first negative finite number\n   * @param b - The second negative finite number\n   * @returns The sum of `a` and `b` as a `NegativeFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two negative finite numbers, returning `a - b` as a\n   * `NegativeFiniteNumber`.\n   *\n   * @param a - The first negative finite number\n   * @param b - The second negative finite number\n   * @returns The difference of `a` and `b` as a `NegativeFiniteNumber`\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAQA,MAAM,iBAAA,GAAoB,0BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB;AACF,CAAU,CAAA;AAEV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,oBAAA,CAAqB,WAAW,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAE7C,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAEd,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAIb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAaK,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;AAAA;AAAA,EAUA,GAAA;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;AACF;;;;"}

package/dist/number/branded-types/negative-int.d.mts

@@ -3,18 +3,24 @@ import { PositiveInt } from './positive-int.mjs';
 export type NegativeInt = TtfImported_NegativeInt;
 type ElementType = NegativeInt;
 /**
- * Checks if a number is a NegativeInt (a negative integer `<= -1`).
+ * Type guard that checks if a value is a negative integer.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NegativeInt, `false` otherwise.
+ * Returns `true` for a negative integer — a value with no fractional component,
+ * including values outside the safe integer range (unlike `SafeInt`).
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a negative integer, `false` otherwise
  */
 export declare const isNegativeInt: (a: number) => a is TtfImported_NegativeInt;
 /**
- * Casts a number to a NegativeInt type.
+ * Casts a `number` to the `NegativeInt` branded type.
+ *
+ * Validates that the value is a negative integer and returns it with the
+ * `NegativeInt` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NegativeInt type.
- * @throws {TypeError} If the value is not a negative integer.
+ * @param value - The value to cast
+ * @returns The value as a `NegativeInt`
+ * @throws {TypeError} If the value is not a negative integer
  */
 export declare const asNegativeInt: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -31,88 +37,99 @@ export declare const asNegativeInt: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for negative integers.
+ * Namespace providing type-safe operations for the `NegativeInt` branded type.
  *
- * NegativeInt represents integers that are strictly less than zero (`<= -1`).
- * Operations that stay within the negative integers (such as `add`) clamp their
- * results to the valid range, while operations whose result leaves the set
- * (`mul`, `div`, `abs`) are typed to reflect the actual sign of the result.
+ * The `NegativeInt` type represents a negative integer. Division (`div`) uses
+ * floor division.
+ *
+ * Unlike `SafeInt`, `NegativeInt` allows values outside the safe integer range
+ * (±2^53 − 1), so very large magnitudes may lose precision in JavaScript's
+ * `number` type.
  */
 export declare const NegativeInt: {
     /**
-     * Type guard to check if a value is a NegativeInt.
+     * Type guard that checks if a value is a negative integer.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a negative integer, `false` otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a negative integer, `false` otherwise
+     * @see {@link isNegativeInt} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NegativeInt;
     /**
-     * The maximum value for a negative integer.
-     *
-     * @readonly
+     * The largest value representable as `NegativeInt` (the upper saturation
+     * target of `fromNumber`).
      */
     readonly MAX_VALUE: -1;
     /**
      * Returns the absolute value of a negative integer.
      *
-     * @param a The negative integer.
-     * @returns The absolute value as a PositiveInt.
+     * The result is non-negative and keeps the `NegativeInt` brand. Note that
+     * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so
+     * use `SafeInt` for guaranteed precision.
+     *
+     * @param a - The negative integer value
+     * @returns The absolute value as a non-negative `NegativeInt`
      */
     readonly abs: (x: WithSmallInt<ElementType>) => PositiveInt;
     /**
-     * Returns the smaller of two negative integers.
+     * Returns the smallest of the given negative integers.
      *
-     * @param a The first negative integer.
-     * @param b The second negative integer.
-     * @returns The minimum value as a NegativeInt.
+     * @param values - The negative integers to compare (at least one required)
+     * @returns The smallest value as a `NegativeInt`
      */
     readonly min: (...values: readonly WithSmallInt<TtfImported_NegativeInt>[]) => TtfImported_NegativeInt;
     /**
-     * Returns the larger of two negative integers.
+     * Returns the largest of the given negative integers.
      *
-     * @param a The first negative integer.
-     * @param b The second negative integer.
-     * @returns The maximum value as a NegativeInt.
+     * @param values - The negative integers to compare (at least one required)
+     * @returns The largest value as a `NegativeInt`
      */
     readonly max: (...values: readonly WithSmallInt<TtfImported_NegativeInt>[]) => TtfImported_NegativeInt;
     /**
-     * Clamps a number to the negative integer range.
+     * Converts an arbitrary `number` into a `NegativeInt`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
+     *
+     * Unlike `asNegativeInt`, this is total: out-of-range inputs are clamped to
+     * the nearest representable `NegativeInt` instead of throwing.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to `[-∞, -1]` as a NegativeInt.
+     * @param value - The value to convert
+     * @returns The value as a `NegativeInt`
      */
-    readonly clamp: (x: number) => TtfImported_NegativeInt;
+    readonly fromNumber: (x: number) => TtfImported_NegativeInt;
     /**
-     * Generates a random NegativeInt value within the valid range.
+     * Generates a random `NegativeInt` within the given range.
      *
-     * @returns A random negative integer.
+     * The range is inclusive on both ends.
+     *
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NegativeInt` in `[min, max]`
      */
     readonly random: (min?: WithSmallInt<TtfImported_NegativeInt> | undefined, max?: WithSmallInt<TtfImported_NegativeInt> | undefined) => TtfImported_NegativeInt;
     /**
-     * Raises a negative integer to the power of another negative integer.
+     * Raises `a` to the power `b`, returning `a ** b` as a `NegativeInt` (floored
+     * to an integer).
      *
-     * @param a The base negative integer.
-     * @param b The exponent negative integer.
-     * @returns `a ** b` clamped to the negative integer range.
+     * @param a - The base negative integer
+     * @param b - The exponent negative integer
+     * @returns `a ** b` as a `NegativeInt`
      */
     readonly pow: (x: WithSmallInt<TtfImported_NegativeInt>, y: WithSmallInt<TtfImported_NegativeInt>) => TtfImported_NegativeInt;
     /**
-     * Adds two negative integers.
+     * Adds two negative integers, returning `a + b` as a `NegativeInt`.
      *
-     * @param a The first negative integer.
-     * @param b The second negative integer.
-     * @returns `a + b` as a NegativeInt.
+     * @param a - The first negative integer
+     * @param b - The second negative integer
+     * @returns The sum of `a` and `b` as a `NegativeInt`
      */
     readonly add: (x: WithSmallInt<TtfImported_NegativeInt>, y: WithSmallInt<TtfImported_NegativeInt>) => TtfImported_NegativeInt;
     /**
-     * Subtracts one negative integer from another.
-     *
-     * The mathematical result can be positive, so it is clamped to the negative
-     * integer range (maximum `-1`).
+     * Subtracts two negative integers, returning `a - b` as a `NegativeInt`.
      *
-     * @param a The minuend negative integer.
-     * @param b The subtrahend negative integer.
-     * @returns `a - b` clamped to the negative integer range.
+     * @param a - The first negative integer
+     * @param b - The second negative integer
+     * @returns The difference of `a` and `b` as a `NegativeInt`
      */
     readonly sub: (x: WithSmallInt<TtfImported_NegativeInt>, y: WithSmallInt<TtfImported_NegativeInt>) => TtfImported_NegativeInt;
 };

package/dist/number/branded-types/negative-int.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"negative-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/negative-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,WAAW,IAAI,uBAAuB,EAC3C,KAAK,YAAY,EAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,MAAM,WAAW,GAAG,uBAAuB,CAAC;AAElD,KAAK,WAAW,GAAG,WAAW,CAAC;AAuC/B;;;;;GAKG;AACH,eAAO,MAAM,aAAa,6CAAK,CAAC;AAEhC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;MAAW,CAAC;AAEtC;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW;IACtB;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;sBAjDW,YAAY,CAAC,WAAW,CAAC,KAAG,WAAW;IAoDrD;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;;OASG;;CAEK,CAAC"}
+{"version":3,"file":"negative-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/negative-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,WAAW,IAAI,uBAAuB,EAC3C,KAAK,YAAY,EAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,MAAM,WAAW,GAAG,uBAAuB,CAAC;AAElD,KAAK,WAAW,GAAG,WAAW,CAAC;AA8B/B;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,6CAAK,CAAC;AAEhC;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;MAAW,CAAC;AAEtC;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW;IACtB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;;;;;;;OASG;sBA7DW,YAAY,CAAC,WAAW,CAAC,KAAG,WAAW;IAgErD;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;CAEK,CAAC"}

package/dist/number/branded-types/negative-int.mjs

@@ -6,7 +6,7 @@ const {
   MAX_VALUE,
   add,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -20,84 +20,93 @@ const {
   MAX_VALUE: -1,
   typeNameInMessage
 });
-const abs = (x) => PositiveInt.clamp(Math.abs(x));
+const abs = (x) => PositiveInt.fromNumber(Math.abs(x));
 const isNegativeInt = is;
 const asNegativeInt = castType;
 const NegativeInt = {
   /**
-   * Type guard to check if a value is a NegativeInt.
+   * Type guard that checks if a value is a negative integer.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a negative integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a negative integer, `false` otherwise
+   * @see {@link isNegativeInt} for usage examples
    */
   is,
   /**
-   * The maximum value for a negative integer.
-   *
-   * @readonly
+   * The largest value representable as `NegativeInt` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
   /**
    * Returns the absolute value of a negative integer.
    *
-   * @param a The negative integer.
-   * @returns The absolute value as a PositiveInt.
+   * The result is non-negative and keeps the `NegativeInt` brand. Note that
+   * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so
+   * use `SafeInt` for guaranteed precision.
+   *
+   * @param a - The negative integer value
+   * @returns The absolute value as a non-negative `NegativeInt`
    */
   abs,
   /**
-   * Returns the smaller of two negative integers.
+   * Returns the smallest of the given negative integers.
    *
-   * @param a The first negative integer.
-   * @param b The second negative integer.
-   * @returns The minimum value as a NegativeInt.
+   * @param values - The negative integers to compare (at least one required)
+   * @returns The smallest value as a `NegativeInt`
    */
   min: min_,
   /**
-   * Returns the larger of two negative integers.
+   * Returns the largest of the given negative integers.
    *
-   * @param a The first negative integer.
-   * @param b The second negative integer.
-   * @returns The maximum value as a NegativeInt.
+   * @param values - The negative integers to compare (at least one required)
+   * @returns The largest value as a `NegativeInt`
    */
   max: max_,
   /**
-   * Clamps a number to the negative integer range.
+   * Converts an arbitrary `number` into a `NegativeInt`, rounding to the
+   * nearest integer and saturating the result into the range `[MIN_VALUE,
+   * MAX_VALUE]`.
+   *
+   * Unlike `asNegativeInt`, this is total: out-of-range inputs are clamped to
+   * the nearest representable `NegativeInt` instead of throwing.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to `[-∞, -1]` as a NegativeInt.
+   * @param value - The value to convert
+   * @returns The value as a `NegativeInt`
    */
-  clamp,
+  fromNumber,
   /**
-   * Generates a random NegativeInt value within the valid range.
+   * Generates a random `NegativeInt` within the given range.
    *
-   * @returns A random negative integer.
+   * The range is inclusive on both ends.
+   *
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NegativeInt` in `[min, max]`
    */
   random,
   /**
-   * Raises a negative integer to the power of another negative integer.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NegativeInt` (floored
+   * to an integer).
    *
-   * @param a The base negative integer.
-   * @param b The exponent negative integer.
-   * @returns `a ** b` clamped to the negative integer range.
+   * @param a - The base negative integer
+   * @param b - The exponent negative integer
+   * @returns `a ** b` as a `NegativeInt`
    */
   pow,
   /**
-   * Adds two negative integers.
+   * Adds two negative integers, returning `a + b` as a `NegativeInt`.
    *
-   * @param a The first negative integer.
-   * @param b The second negative integer.
-   * @returns `a + b` as a NegativeInt.
+   * @param a - The first negative integer
+   * @param b - The second negative integer
+   * @returns The sum of `a` and `b` as a `NegativeInt`
    */
   add,
   /**
-   * Subtracts one negative integer from another.
-   *
-   * The mathematical result can be positive, so it is clamped to the negative
-   * integer range (maximum `-1`).
+   * Subtracts two negative integers, returning `a - b` as a `NegativeInt`.
    *
-   * @param a The minuend negative integer.
-   * @param b The subtrahend negative integer.
-   * @returns `a - b` clamped to the negative integer range.
+   * @param a - The first negative integer
+   * @param b - The second negative integer
+   * @returns The difference of `a` and `b` as a `NegativeInt`
    */
   sub
 };

package/dist/number/branded-types/negative-int.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"negative-int.mjs","sources":["../../../src/number/branded-types/negative-int.mts"],"sourcesContent":["import {\n  type NegativeInt as TtfImported_NegativeInt,\n  type WithSmallInt,\n} from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveInt } from './positive-int.mjs';\n\nexport type NegativeInt = TtfImported_NegativeInt;\n\ntype ElementType = NegativeInt;\n\nconst typeNameInMessage = 'a negative integer';\n\nconst {\n  MAX_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  -1\n>({\n  integerOrSafeInteger: 'Integer',\n  nonZero: true,\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: -1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Returns the absolute value of a negative integer.\n *\n * The absolute value of a negative integer is always a positive integer\n * (`>= 1`), so the result is typed as a {@link PositiveInt}.\n *\n * @param x - The negative integer.\n * @returns `|x|` as a PositiveInt.\n */\nconst abs = (x: WithSmallInt<ElementType>): PositiveInt =>\n  PositiveInt.clamp(Math.abs(x));\n\n/**\n * Checks if a number is a NegativeInt (a negative integer `<= -1`).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NegativeInt, `false` otherwise.\n */\nexport const isNegativeInt = is;\n\n/**\n * Casts a number to a NegativeInt type.\n *\n * @param value The value to cast.\n * @returns The value as a NegativeInt type.\n * @throws {TypeError} If the value is not a negative integer.\n */\nexport const asNegativeInt = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for negative integers.\n *\n * NegativeInt represents integers that are strictly less than zero (`<= -1`).\n * Operations that stay within the negative integers (such as `add`) clamp their\n * results to the valid range, while operations whose result leaves the set\n * (`mul`, `div`, `abs`) are typed to reflect the actual sign of the result.\n */\nexport const NegativeInt = {\n  /**\n   * Type guard to check if a value is a NegativeInt.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a negative integer, `false` otherwise.\n   */\n  is,\n\n  /**\n   * The maximum value for a negative integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative integer.\n   *\n   * @param a The negative integer.\n   * @returns The absolute value as a PositiveInt.\n   */\n  abs,\n\n  /**\n   * Returns the smaller of two negative integers.\n   *\n   * @param a The first negative integer.\n   * @param b The second negative integer.\n   * @returns The minimum value as a NegativeInt.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two negative integers.\n   *\n   * @param a The first negative integer.\n   * @param b The second negative integer.\n   * @returns The maximum value as a NegativeInt.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the negative integer range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to `[-∞, -1]` as a NegativeInt.\n   */\n  clamp,\n\n  /**\n   * Generates a random NegativeInt value within the valid range.\n   *\n   * @returns A random negative integer.\n   */\n  random,\n\n  /**\n   * Raises a negative integer to the power of another negative integer.\n   *\n   * @param a The base negative integer.\n   * @param b The exponent negative integer.\n   * @returns `a ** b` clamped to the negative integer range.\n   */\n  pow,\n\n  /**\n   * Adds two negative integers.\n   *\n   * @param a The first negative integer.\n   * @param b The second negative integer.\n   * @returns `a + b` as a NegativeInt.\n   */\n  add,\n\n  /**\n   * Subtracts one negative integer from another.\n   *\n   * The mathematical result can be positive, so it is clamped to the negative\n   * integer range (maximum `-1`).\n   *\n   * @param a The minuend negative integer.\n   * @param b The subtrahend negative integer.\n   * @returns `a - b` clamped to the negative integer range.\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAWA,MAAM,iBAAA,GAAoB,oBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,SAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,SAAA,EAAW,EAAA;AAAA,EACX;AACF,CAAU,CAAA;AAWV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,WAAA,CAAY,MAAM,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAQxB,MAAM,aAAA,GAAgB;AAStB,MAAM,aAAA,GAAgB;AAUtB,MAAM,WAAA,GAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOzB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA;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,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;AAAA;AAAA,EAYA;AACF;;;;"}
+{"version":3,"file":"negative-int.mjs","sources":["../../../src/number/branded-types/negative-int.mts"],"sourcesContent":["import {\n  type NegativeInt as TtfImported_NegativeInt,\n  type WithSmallInt,\n} from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveInt } from './positive-int.mjs';\n\nexport type NegativeInt = TtfImported_NegativeInt;\n\ntype ElementType = NegativeInt;\n\nconst typeNameInMessage = 'a negative integer';\n\nconst {\n  MAX_VALUE,\n  add,\n  castType,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  -1\n>({\n  integerOrSafeInteger: 'Integer',\n  nonZero: true,\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: -1,\n  typeNameInMessage,\n} as const);\n\nconst abs = (x: WithSmallInt<ElementType>): PositiveInt =>\n  PositiveInt.fromNumber(Math.abs(x));\n\n/**\n * Type guard that checks if a value is a negative integer.\n *\n * Returns `true` for a negative integer — a value with no fractional component,\n * including values outside the safe integer range (unlike `SafeInt`).\n *\n * @param value - The value to check\n * @returns `true` if the value is a negative integer, `false` otherwise\n */\nexport const isNegativeInt = is;\n\n/**\n * Casts a `number` to the `NegativeInt` branded type.\n *\n * Validates that the value is a negative integer and returns it with the\n * `NegativeInt` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NegativeInt`\n * @throws {TypeError} If the value is not a negative integer\n */\nexport const asNegativeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `NegativeInt` branded type.\n *\n * The `NegativeInt` type represents a negative integer. Division (`div`) uses\n * floor division.\n *\n * Unlike `SafeInt`, `NegativeInt` allows values outside the safe integer range\n * (±2^53 − 1), so very large magnitudes may lose precision in JavaScript's\n * `number` type.\n */\nexport const NegativeInt = {\n  /**\n   * Type guard that checks if a value is a negative integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a negative integer, `false` otherwise\n   * @see {@link isNegativeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The largest value representable as `NegativeInt` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative integer.\n   *\n   * The result is non-negative and keeps the `NegativeInt` brand. Note that\n   * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so\n   * use `SafeInt` for guaranteed precision.\n   *\n   * @param a - The negative integer value\n   * @returns The absolute value as a non-negative `NegativeInt`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given negative integers.\n   *\n   * @param values - The negative integers to compare (at least one required)\n   * @returns The smallest value as a `NegativeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given negative integers.\n   *\n   * @param values - The negative integers to compare (at least one required)\n   * @returns The largest value as a `NegativeInt`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NegativeInt`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asNegativeInt`, this is total: out-of-range inputs are clamped to\n   * the nearest representable `NegativeInt` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NegativeInt`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `NegativeInt` 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 `NegativeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NegativeInt` (floored\n   * to an integer).\n   *\n   * @param a - The base negative integer\n   * @param b - The exponent negative integer\n   * @returns `a ** b` as a `NegativeInt`\n   */\n  pow,\n\n  /**\n   * Adds two negative integers, returning `a + b` as a `NegativeInt`.\n   *\n   * @param a - The first negative integer\n   * @param b - The second negative integer\n   * @returns The sum of `a` and `b` as a `NegativeInt`\n   */\n  add,\n\n  /**\n   * Subtracts two negative integers, returning `a - b` as a `NegativeInt`.\n   *\n   * @param a - The first negative integer\n   * @param b - The second negative integer\n   * @returns The difference of `a` and `b` as a `NegativeInt`\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAWA,MAAM,iBAAA,GAAoB,oBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,SAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,SAAA,EAAW,EAAA;AAAA,EACX;AACF,CAAU,CAAA;AAEV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,WAAA,CAAY,WAAW,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAW7B,MAAM,aAAA,GAAgB;AAYtB,MAAM,aAAA,GAAgB;AAYtB,MAAM,WAAA,GAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQzB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,GAAA;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;AAAA;AAAA,EAWA,MAAA;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;;;;"}