@digitalwalletcorp/utils 0.2.0 → 0.4.0

package/src/number-util.ts

@@ -1,41 +1,12 @@
-import { Big } from 'big.js';
+import { Decimal, ROUNDING_MODE } from './decimal';
+import type { NumberSource, RoundingMode } from './decimal';
 
-/**
- * 数値として扱える値の型
- */
-export type NumberSource = number | string | bigint;
+export { ROUNDING_MODE };
+export type { NumberSource, RoundingMode };
 
 // 64bit整数の範囲
-const MIN_LONG = Big('-9223372036854775808');
-const MAX_LONG = Big('9223372036854775807');
-
-/**
- * 丸めモード
- * 公開APIに内部の算術ライブラリ(big.js)の型を出さないよう、値を直接定義する(big.jsの丸めモードと同じ値)
- */
-export const ROUNDING_MODE = {
-  /**
-   * Rounds towards zero.
-   * I.e. truncate, no rounding.
-   */
-  roundDown: 0,
-  /**
-   * Rounds towards nearest neighbour.
-   * If equidistant, rounds away from zero.
-   */
-  roundHalfUp: 1,
-  /**
-   * Rounds towards nearest neighbour.
-   * If equidistant, rounds towards even neighbour.
-   */
-  roundHalfEven: 2,
-  /**
-   * Rounds away from zero.
-   */
-  roundUp: 3
-} as const;
-
-export type RoundingMode = typeof ROUNDING_MODE[keyof typeof ROUNDING_MODE];
+const MIN_LONG = new Decimal('-9223372036854775808');
+const MAX_LONG = new Decimal('9223372036854775807');
 
 /** 数値パターン */
 const NUMBER_PATTERN = new RegExp('([\+\-]?)([0-9]*)[\.]?([0-9]*)');
@@ -43,10 +14,8 @@ const NUMBER_PATTERN = new RegExp('([\+\-]?)([0-9]*)[\.]?([0-9]*)');
 /** 数値として解釈できる文字列のパターン(符号・小数点・指数表記) */
 const NUMERIC_STRING_PATTERN = /^[+-]?(\d+\.?\d*|\.\d+)(e[+-]?\d+)?$/i;
 
-function toBig(value: NumberSource): Big {
-  // @types/big.js の型定義が bigint を含まないため、文字列にして渡す
-  return Big(typeof value === 'bigint' ? value.toString() : value);
-}
+// 空文字・空白のみの文字列はtrueを返す
+const isBlank = (value: unknown): value is string => typeof value === 'string' && value.trim() === '';
 
 /**
  * long(64bit)の範囲(-9223372036854775808〜9223372036854775807)の値か判定する
@@ -63,21 +32,15 @@ function toBig(value: NumberSource): Big {
 export function isLongValue(value: string | bigint, options?: {
   minValue?: number;
 }): boolean {
-  let min;
-  if (options?.minValue != null) {
-    try {
-      min = Big(options.minValue);
-    } catch (error) {
-      min = MIN_LONG;
-    }
-  } else {
-    min = MIN_LONG;
+  if (value == null || isBlank(value)) {
+    return false;
   }
+  const min = Number.isFinite(options?.minValue) ? new Decimal(options!.minValue) : MIN_LONG;
   try {
     // -9223372036854775808 <= value <= 9223372036854775807
-    return min.lte(value.toString()) && MAX_LONG.gte(value.toString());
+    return min.lte(value) && MAX_LONG.gte(value);
   } catch (error) {
-    // 数値以外やnullが渡された場合エラーになるためfalseを返却([big.js] Invalid number)
+    // 数値として解釈できない値
     return false;
   }
 }
@@ -104,8 +67,8 @@ export function formatComma(value: NumberSource | null | undefined, scale?: numb
         // "NaN" / "Infinity" / "-Infinity" を返却
         return String(value);
       }
-      // toString()は1e21以上や1e-7以下を指数表記にするため、Bigで通常の表記に展開する
-      strValue = Big(value).toFixed();
+      // toString()は1e21以上や1e-7以下を指数表記にするため、Decimalで通常の表記に展開する
+      strValue = new Decimal(value).toString();
       break;
     case 'string':
       strValue = removeComma(value).trim();
@@ -114,9 +77,9 @@ export function formatComma(value: NumberSource | null | undefined, scale?: numb
         return value;
       }
       if (/e/i.test(strValue)) {
-        // 指数表記を通常の表記に展開する。Big.jsは '+' を受け付けないため外して渡し、表示用に付け直す
+        // 指数表記を通常の表記に展開する。表示用に '+' を付け直す
         const plusSign = strValue.startsWith('+') ? '+' : '';
-        strValue = `${plusSign}${Big(strValue.replace(/^\+/, '')).toFixed()}`;
+        strValue = `${plusSign}${new Decimal(strValue).toString()}`;
       }
       break;
     default:
@@ -128,11 +91,10 @@ export function formatComma(value: NumberSource | null | undefined, scale?: numb
   let natural = matches[2] || '0';
   let decimal = matches[3];
   let dp: number;
-  // Big.jsに渡すとき '+' が付いているとエラーになる
-  let big = new Big(`${sign === '-' ? '-' : ''}${natural}.${decimal}`);
+  let decimalValue = new Decimal(`${sign === '-' ? '-' : ''}${natural}.${decimal}`);
   if (scale != null) {
-    big = big.round(scale, roundingMode ?? ROUNDING_MODE.roundHalfUp);
-    const roundedMatches = NUMBER_PATTERN.exec(big.toFixed()) as RegExpExecArray;
+    decimalValue = decimalValue.round(scale, roundingMode ?? ROUNDING_MODE.roundHalfUp);
+    const roundedMatches = NUMBER_PATTERN.exec(decimalValue.toString()) as RegExpExecArray;
     natural = roundedMatches[2];
     decimal = roundedMatches[3];
     dp = scale;
@@ -140,7 +102,7 @@ export function formatComma(value: NumberSource | null | undefined, scale?: numb
     dp = decimal.length;
   }
   // 丸めた結果がゼロになる場合('-0.001' を小数2桁にするなど)に "-0.00" とならないよう、丸めた後の値で判定する
-  const displaySign = big.eq(0) ? '' : sign;
+  const displaySign = decimalValue.eq(0) ? '' : sign;
   natural = natural.replace(/(\d)(?=(\d{3})+$)/g, '$1,');
   decimal = `${decimal}${'0'.repeat(dp)}`.substring(0, dp);
   return decimal === ''
@@ -177,51 +139,6 @@ export interface OperationItem {
   value: NumberSource | null | undefined;
 }
 
-// null/undefined/空文字/NaNはtrueを返す
-const isLikelyUndefined = (b: NumberSource | null | undefined): b is null | undefined | '' => b == null || b === '' || (typeof b === 'number' && Number.isNaN(b));
-
-// 演算の初期値。null/undefined/空文字/NaNはゼロとみなす
-const toInitialBig = (value: NumberSource | null | undefined): Big => isLikelyUndefined(value) ? Big(0) : toBig(value);
-
-const operators: Record<Operator, (a: Big, b: NumberSource | null | undefined) => Big> = {
-  // null/undefined/空文字/NaNはゼロとみなす
-  add: (a, b) => a.add(isLikelyUndefined(b) ? 0 : toBig(b)),
-  // null/undefined/空文字/NaNはゼロとみなす
-  sub: (a, b) => a.sub(isLikelyUndefined(b) ? 0 : toBig(b)),
-  /**
-   * 乗算の場合の'b'の値は、計算したい対象によってゼロとみなすのか無視して元の値を保持したいのかの概念が異なる
-   * ゼロとみなしたい場合の例：
-   *   手数料 x 件数
-   *     → このとき件数が未定義(≒ 0)だったら手数料総計は0が適切
-   * 無視して元の値を保持したい場合の例：
-   *   商品価格 x 割引率
-   *     → このとき割引率が未定義(≒ 1)だったら販売価格は元の値(商品価格)が適切
-   *
-   * この関数のデフォルトの挙動は「ゼロとみなす」とする
-   * 1とみなすと、第1引数のnullはゼロとみなすため times(3, null) = 3、times(null, 3) = 0 のように引数の順序で結果が変わってしまう
-   * 元の値を保持したいケースでは
-   *   NumberUtil.times(price, discount ?? 1)
-   * のように、discountが未定義だった場合のフォールバック値を指定する
-   */
-  // null/undefined/空文字/NaNはゼロとみなす
-  times: (a, b) => a.times(isLikelyUndefined(b) ? 0 : toBig(b)),
-  /**
-   * 除算の場合`isLikelyUndefined(b) = true`をゼロとみなす挙動にすると、0, null, undefined, 空文字などすべてゼロ除算エラーになってしまうため
-   * 割る値に限り1とみなし、元の値を保持する挙動とする(明示的に0を指定した場合はゼロ除算エラー)
-   *   例) 割引率で割る計算で、割引率が未定義なら元の値が適切
-   */
-  // null/undefined/空文字/NaNは1とみなす(a / 1 = a)。0を演算対象にするとゼロ除算エラーが発生する
-  div: (a, b) => isLikelyUndefined(b) ? a : a.div(toBig(b))
-};
-
-function calcAsBig(initialValue: NumberSource | null | undefined, operationItems: OperationItem[]): Big {
-  let bigvalue = toInitialBig(initialValue);
-  for (const item of operationItems) {
-    bigvalue = operators[item.operator](bigvalue, item.value);
-  }
-  return bigvalue;
-}
-
 /**
  * 複数の演算をまとめて計算する
  * 計算途中は精度を保持し、最後にnumberへ変換する
@@ -243,7 +160,6 @@ function calcAsBig(initialValue: NumberSource | null | undefined, operationItems
  * 146 * 2 = 292
  * 292 / 3 = 97.33333333
  *
- * 数学的な感覚だと 123 + 123 - ((100 * 2) / 3) = 229.33333333 となるが、この関数はそのような計算を行わない
  * null等の扱いは add / sub / times / div と同じ
  * 戻り値はnumberのため、Number.MAX_SAFE_INTEGERを超える結果は精度が落ちる
  *
@@ -260,11 +176,14 @@ export function calc(initialValue: NumberSource | null | undefined, operationIte
   scale?: number;
   roundingMode?: RoundingMode;
 }): number {
-  let bigvalue = calcAsBig(initialValue, operationItems);
+  let decimal = new Decimal(initialValue);
+  for (const item of operationItems) {
+    decimal = decimal[item.operator](item.value);
+  }
   if (options?.scale != null) {
-    bigvalue = bigvalue.round(options.scale, options.roundingMode ?? ROUNDING_MODE.roundHalfUp);
+    decimal = decimal.round(options.scale, options.roundingMode ?? ROUNDING_MODE.roundHalfUp);
   }
-  return bigvalue.toNumber();
+  return decimal.toNumber();
 }
 
 /**
@@ -277,11 +196,11 @@ export function calc(initialValue: NumberSource | null | undefined, operationIte
  * @returns {number}
  */
 export function add(value1: NumberSource | null | undefined, ...value2: (NumberSource | null | undefined)[]): number {
-  let bigvalue = toInitialBig(value1);
+  let decimal = new Decimal(value1);
   for (const value of value2) {
-    bigvalue = operators.add(bigvalue, value);
+    decimal = decimal.add(value);
   }
-  return bigvalue.toNumber();
+  return decimal.toNumber();
 }
 
 /**
@@ -294,11 +213,11 @@ export function add(value1: NumberSource | null | undefined, ...value2: (NumberS
  * @returns {number}
  */
 export function sub(value1: NumberSource | null | undefined, ...value2: (NumberSource | null | undefined)[]): number {
-  let bigvalue = toInitialBig(value1);
+  let decimal = new Decimal(value1);
   for (const value of value2) {
-    bigvalue = operators.sub(bigvalue, value);
+    decimal = decimal.sub(value);
   }
-  return bigvalue.toNumber();
+  return decimal.toNumber();
 }
 
 /**
@@ -312,11 +231,11 @@ export function sub(value1: NumberSource | null | undefined, ...value2: (NumberS
  * @returns {number}
  */
 export function times(value1: NumberSource | null | undefined, ...value2: (NumberSource | null | undefined)[]): number {
-  let bigvalue = toInitialBig(value1);
+  let decimal = new Decimal(value1);
   for (const value of value2) {
-    bigvalue = operators.times(bigvalue, value);
+    decimal = decimal.times(value);
   }
-  return bigvalue.toNumber();
+  return decimal.toNumber();
 }
 
 /**
@@ -330,11 +249,89 @@ export function times(value1: NumberSource | null | undefined, ...value2: (Numbe
  * @returns {number}
  */
 export function div(value1: NumberSource | null | undefined, ...value2: (NumberSource | null | undefined)[]): number {
-  let bigvalue = toInitialBig(value1);
+  let decimal = new Decimal(value1);
   for (const value of value2) {
-    bigvalue = operators.div(bigvalue, value);
+    decimal = decimal.div(value);
   }
-  return bigvalue.toNumber();
+  return decimal.toNumber();
+}
+
+/**
+ * 2つの値を数値として比較する
+ * null/undefined/空文字/NaNは0と見做す
+ * 数値として解釈できない文字列やInfinityを指定した場合はTypeErrorになる
+ *
+ * @param {NumberSource | null | undefined} value1
+ * @param {NumberSource | null | undefined} value2
+ * @returns {-1 | 0 | 1} value1がvalue2より小さい場合は-1、等しい場合は0、大きい場合は1
+ */
+export function compareTo(value1: NumberSource | null | undefined, value2: NumberSource | null | undefined): -1 | 0 | 1 {
+  return new Decimal(value1).compareTo(value2);
+}
+
+/**
+ * 2つの値が数値として等しいかを返す
+ * null/undefined/空文字/NaNは0と見做す
+ * 数値として解釈できない文字列やInfinityを指定した場合はTypeErrorになる
+ *
+ * @param {NumberSource | null | undefined} value1
+ * @param {NumberSource | null | undefined} value2
+ * @returns {boolean}
+ */
+export function eq(value1: NumberSource | null | undefined, value2: NumberSource | null | undefined): boolean {
+  return compareTo(value1, value2) === 0;
+}
+
+/**
+ * value1がvalue2より小さいかを返す
+ * null/undefined/空文字/NaNは0と見做す
+ * 数値として解釈できない文字列やInfinityを指定した場合はTypeErrorになる
+ *
+ * @param {NumberSource | null | undefined} value1
+ * @param {NumberSource | null | undefined} value2
+ * @returns {boolean}
+ */
+export function lt(value1: NumberSource | null | undefined, value2: NumberSource | null | undefined): boolean {
+  return compareTo(value1, value2) < 0;
+}
+
+/**
+ * value1がvalue2以下かを返す
+ * null/undefined/空文字/NaNは0と見做す
+ * 数値として解釈できない文字列やInfinityを指定した場合はTypeErrorになる
+ *
+ * @param {NumberSource | null | undefined} value1
+ * @param {NumberSource | null | undefined} value2
+ * @returns {boolean}
+ */
+export function lte(value1: NumberSource | null | undefined, value2: NumberSource | null | undefined): boolean {
+  return compareTo(value1, value2) <= 0;
+}
+
+/**
+ * value1がvalue2より大きいかを返す
+ * null/undefined/空文字/NaNは0と見做す
+ * 数値として解釈できない文字列やInfinityを指定した場合はTypeErrorになる
+ *
+ * @param {NumberSource | null | undefined} value1
+ * @param {NumberSource | null | undefined} value2
+ * @returns {boolean}
+ */
+export function gt(value1: NumberSource | null | undefined, value2: NumberSource | null | undefined): boolean {
+  return 0 < compareTo(value1, value2);
+}
+
+/**
+ * value1がvalue2以上かを返す
+ * null/undefined/空文字/NaNは0と見做す
+ * 数値として解釈できない文字列やInfinityを指定した場合はTypeErrorになる
+ *
+ * @param {NumberSource | null | undefined} value1
+ * @param {NumberSource | null | undefined} value2
+ * @returns {boolean}
+ */
+export function gte(value1: NumberSource | null | undefined, value2: NumberSource | null | undefined): boolean {
+  return 0 <= compareTo(value1, value2);
 }
 
 /**
@@ -345,7 +342,7 @@ export function div(value1: NumberSource | null | undefined, ...value2: (NumberS
  *
  * @param {NumberSource | null | undefined} value
  * @param {number} scale
- * @param {RoundingMode} roundingMode
+ * @param {RoundingMode} [roundingMode] デフォルトは 1: 四捨五入
  *   0 切り捨て
  *   1 四捨五入
  *   2 ISO丸め
@@ -356,33 +353,33 @@ export function div(value1: NumberSource | null | undefined, ...value2: (NumberS
 export function round(
   value: NumberSource | null | undefined,
   scale: number,
-  roundingMode: RoundingMode
+  roundingMode?: RoundingMode
 ): number | null {
   if (value == null) {
     return null;
   }
+  const rm = roundingMode ?? ROUNDING_MODE.roundHalfUp;
   switch (typeof value) {
     case 'number':
       if (!Number.isFinite(value)) {
-        // Big.jsはNaN/Infinityを扱えないため
+        // NaN/Infinityはそのまま返す
         return value;
       }
-      return Big(value).round(scale, roundingMode).toNumber();
+      return new Decimal(value).round(scale, rm).toNumber();
     case 'string': {
-      const trimmed = value.trim();
-      if (trimmed === '') {
+      if (isBlank(value)) {
         // 空文字は値なしとしてnullと同じ扱いにする
         return null;
       }
       try {
-        return Big(trimmed).round(scale, roundingMode).toNumber();
+        return new Decimal(value).round(scale, rm).toNumber();
       } catch (error) {
-        // 数値として解釈できない文字列([big.js] Invalid number)
+        // 数値として解釈できない文字列
         return Number.NaN;
       }
     }
     default:
-      return toBig(value).round(scale, roundingMode).toNumber();
+      return new Decimal(value).round(scale, rm).toNumber();
   }
 }
 
@@ -408,70 +405,20 @@ export function toString(
   if (value == null) {
     return '';
   }
+  if (isBlank(value) || (typeof value === 'number' && !Number.isFinite(value))) {
+    // 空文字・NaN・Infinityは数値として扱わない
+    return String(value);
+  }
   try {
-    const big = toBig(value);
+    const decimal = new Decimal(value);
     return options?.scale != null
-      ? big.toFixed(options.scale, options.roundingMode ?? ROUNDING_MODE.roundHalfUp)
-      : big.toFixed();
+      ? decimal.toFixed(options.scale, options.roundingMode ?? ROUNDING_MODE.roundHalfUp)
+      : decimal.toString();
   } catch (error) {
     return String(value);
   }
 }
 
-/**
- * 数値型をビットの配列に変換する
- * 例)
- * 7 => [1, 2, 4]
- *
- * 第二引数に候補値の配列を渡した場合、対象リストの中から該当するもののうち、値の大きなものから抽出して配列で返す
- * 例)
- * 86, [2, 4, 80] => [2, 4, 80]
- * この例で第二引数を渡さない場合は 86 => [2, 4, 16, 64] になる
- * 候補値はそのビットがすべて立っている場合のみ該当とする(16, [80] => [])
- * いずれの候補値にも分類できないビットは無視される
- * 小数は切り捨て、0以下は空配列を返す
- *
- * @param {number} a
- * @param {(number | string)[]} [candidates]
- * @returns {number[]}
- */
-export function bitArray(a: number, candidates?: (number | string)[]): number[] {
-  const array: number[] = [];
-  const integer = Math.trunc(a);
-  if (!Number.isFinite(integer) || integer < 1) {
-    return array;
-  }
-  // ビット演算子は値を32bit整数に切り詰めるため、2^32以上で判定が狂い無限ループになる。BigIntで演算する
-  let val = BigInt(integer);
-  if (candidates) {
-    const cloneArray = candidates.map(a => Number(a)).filter(a => Number.isInteger(a) && 0 < a);
-    cloneArray.sort((a: number, b: number) => {
-      return b - a;
-    });
-    for (const clone of cloneArray) {
-      const bits = BigInt(clone);
-      if ((val & bits) === bits) {
-        array.push(clone);
-        val -= bits;
-      }
-    }
-    array.sort((a: number, b: number) => {
-      return a - b;
-    });
-  } else {
-    const zero = BigInt(0);
-    let bit = BigInt(1);
-    while (zero < val) {
-      if ((val & bit) !== zero) {
-        array.push(Number(bit));
-        val -= bit;
-      }
-      bit *= BigInt(2);
-    }
-  }
-  return array;
-}
-
 /**
  * 渡されたバイト数値を桁数に応じてMB,GBなどに単位を変更する
  *
@@ -493,18 +440,18 @@ export function formatBytes(
   if (bytes == null || bytes === '') {
     return [String(bytes), ''];
   }
-  let bigValue: Big;
+  let decimalValue: Decimal;
   switch (typeof bytes) {
     case 'number':
       if (Number.isNaN(bytes)) {
         // "NaN" を返却
         return ['NaN', ''];
       }
-      bigValue = Big(bytes);
+      decimalValue = new Decimal(bytes);
       break;
     case 'string':
       try {
-        bigValue = Big(removeComma(bytes));
+        decimalValue = new Decimal(removeComma(bytes));
       } catch (error) {
         // 元の文字列を返却
         return [bytes, ''];
@@ -512,18 +459,18 @@ export function formatBytes(
       break;
     default:
       // bigintの場合
-      bigValue = toBig(bytes);
+      decimalValue = new Decimal(bytes);
   }
   const units = ['B', 'KB', 'MB', 'GB', 'TB'];
   let i = 0;
-  while (bigValue.gte(1024) && i < units.length - 1) {
-    bigValue = bigValue.div(1024);
+  while (decimalValue.gte(1024) && i < units.length - 1) {
+    decimalValue = decimalValue.div(1024);
     i++;
   }
   const scale = options?.scale ?? 2;
   const roundingMode = options?.roundingMode ?? ROUNDING_MODE.roundHalfUp;
   if (options?.format) {
-    return [formatComma(bigValue.toFixed(), scale, roundingMode), units[i]];
+    return [formatComma(decimalValue.toString(), scale, roundingMode), units[i]];
   }
-  return [bigValue.round(scale, roundingMode).toString(), units[i]];
+  return [decimalValue.round(scale, roundingMode).toString(), units[i]];
 }