Class FixedPointNumber

ReadonlyfractionalDigits

ReadonlyscaledValue

Static ReadonlyNaN

Static ReadonlyNEGATIVE_INFINITY

Static ReadonlyONE

Static ReadonlyPOSITIVE_INFINITY

Static ReadonlyZERO

bi

• get bi(): bigint

• Returns the integer part of this FixedPointNumber value.

  Returns bigint

  the integer part of this FixedPointNumber value.

  Throws

  If the value is not finite.

bytes

• get bytes(): Uint8Array

• Returns the array of bytes representing the Normalization Form Canonical Composition Unicode Equivalence of this value expressed in decimal base.

  Returns Uint8Array

n

• get n(): number

• Return this value approximated as number.

  Returns number

abs

• abs(): FixedPointNumber

• Returns a FixedPointNumber whose value is the absolute value, i.e. the magnitude, of the value of this FixedPointNumber.

  Returns FixedPointNumber

  the absolute value of this FixedPointNumber.

  See

  bignumber.js absoluteValue

comparedTo

• comparedTo(that): number

• Compares this instance with that FixedPointNumber instance.

  • Returns null if either instance is NaN;
  • Returns 0 if this is equal to that FixedPointNumber, including infinite with equal sign;
  • Returns -1, if this is -Infinite or less than that FixedPointNumber;,
  • Returns 1 if this is +Infinite or greater than that FixedPointNumber.

  Parameters

  • that: FixedPointNumber

    The instance to compare with this instance.

  Returns number

  A null if either instance is NaN; -1, 0, or 1 if this instance is less than, equal to, or greater than the specified instance, respectively.

  Remarks

  This method uses internally compareTo wrapping the InvalidOperation exception when comparing between NaN values to behave according the [bignumber.js comparedTo] rules.

compareTo

• compareTo(that): number

• Compares this instance with that FixedPointNumber instance.

  • Returns 0 if this is equal to that FixedPointNumber, including infinite with equal sign;
  • Returns -1, if this is -Infinite or less than that FixedPointNumber;,
  • Returns 1 if this is +Infinite or greater than that FixedPointNumber.

  Parameters

  • that: FixedPointNumber

    The instance to compare with this instance.

  Returns number

  Returns -1, 0, or 1 if this instance is less than, equal to, or greater than the specified instance, respectively.

  Throw

  InvalidOperation If this or that FixedPointNumber is NaN.

  See

  bignumber.js comparedTo

div

• div(that): FixedPointNumber

• Returns a FixedPointNumber whose value is the value of this FixedPointNumber divided by that FixedPointNumber.

  Limit cases

  • 0 / 0 = NaN
  • NaN / ±n = NaN
  • ±Infinity / ±Infinity = NaN
  • +n / NaN = NaN
  • +n / ±Infinity = 0
  • -n / 0 = -Infinity
  • +n / 0 = +Infinity

  Parameters

  • that: FixedPointNumber

    The fixed-point number to divide by.

  Returns FixedPointNumber

  The result of the division.

  Remarks

  The precision is the greater of the precision of the two operands.

  See

  bignumber.js dividedBy

dp

• dp(decimalPlaces): FixedPointNumber

• Adjust the precision of the floating-point number by the specified number of decimal places.

  Parameters

  • decimalPlaces: number | bigint

    The number of decimal places to adjust to, it must be a positive value.

  Returns FixedPointNumber

  A new FixedPointNumber instance with the adjusted precision.

  Throws

  InvalidDataType if decimalPlaces is negative.

eq

• eq(that): boolean

• Returns true if the value of thisFPN is equal to the value of that FixedPointNumber, otherwise returns false.

  As with JavaScript, NaN does not equal NaN.

  Parameters

  • that: FixedPointNumber

    The FixedPointNumber to compare against.

  Returns boolean

  true if the FixedPointNumber numbers are equal, otherwise false.

  Remarks

  This method uses comparedTo internally.

  See

  bigbumber.js isEqualTo

gt

• gt(that): boolean

• Returns true if the value of this FixedPointNumber is greater than that FixedPointNumber, otherwise returns false`.

  @param {FixedPointNumber} that The FixedPointNumber to compare against. @return {boolean} true if this FixedPointNumber is greater than that FixedPointNumber, otherwise false.

  Parameters

  • that: FixedPointNumber

  Returns boolean

  Remarks

  This method uses comparedTo internally.

  See

  bignummber.js isGreaterThan

gte

• gte(that): boolean

• Returns true if the value of this FixedPointNumber is greater or equal than that FixedPointNumber, otherwise returns false`.

  @param {FixedPointNumber} that - The FixedPointNumber to compare against. @return {boolean} true if this FixedPointNumber is greater or equal than that FixedPointNumber, otherwise false.

  Parameters

  • that: FixedPointNumber

  Returns boolean

  Remarks

  This method uses comparedTo internally.

  See

  bignumber.js isGreaterThanOrEqualTo

idiv

• idiv(that): FixedPointNumber

• Returns a fixed-point number whose value is the integer part of dividing the value of this fixed-point number by that fixed point number.

  Limit cases

  • 0 / 0 = NaN
  • NaN / ±n = NaN
  • ±Infinity / ±Infinity = NaN
  • +n / NaN = NaN
  • +n / ±Infinite = 0
  • -n / 0 = -Infinite
  • +n / 0 = +Infinite

  Parameters

  • that: FixedPointNumber

    The fixed-point number to divide by.

  Returns FixedPointNumber

  The result of the division.

  Remarks

  The precision is the greater of the precision of the two operands.

  See

  bignumber.js dividedToIntegerBy

isEqual

• isEqual(that): boolean

• Returns true if the value of thisFPN is equal to the value of that FixedPointNumber, otherwise returns false.

  As with JavaScript, NaN does not equal NaN.

  Parameters

  • that: FixedPointNumber

    The FixedPointNumber to compare against.

  Returns boolean

  true if the FixedPointNumber numbers are equal, otherwise false.

  Remarks

  This method uses eq internally.

isFinite

• isFinite(): boolean

• Returns true if the value of this FixedPointNumber is a finite number, otherwise returns false.

  The only possible non-finite values of a FixedPointNumber are NaN, NEGATIVE_INFINITY and POSITIVE_INFINITY.

  Returns boolean

  true if the value of this FixedPointNumber is a finite number, otherwise returns false.

  See

  bignumber.js isFinite

isInfinite

• isInfinite(): boolean

• Return true if the value of this FixedPointNumber is NEGATIVE_INFINITY or POSITIVE_INFINITY, otherwise returns false.

  Returns boolean

  true` if the value of this FixedPointNumber is NEGATIVE_INFINITY or POSITIVE_INFINITY,

isInteger

• isInteger(): boolean

• Returns true if the value of this FixedPointNumber is an integer, otherwise returns false.

  Returns boolean

  true if the value of this FixedPointNumber is an integer.

  See

  bignumber.js isInteger

isNaN

• isNaN(): boolean

• Returns true if the value of this FixedPointNumber is NaN, otherwise returns false.

  Returns boolean

  true if the value of this FixedPointNumber is NaN, otherwise returns false.

  See

  bignumber.js isNaN

isNegative

• isNegative(): boolean

• Returns true if the sign of this FixedPointNumber is negative, otherwise returns false.

  Returns boolean

  true if the sign of this FixedPointNumber is negative, otherwise returns false.

  See

  bignumber.js isNegative

isNegativeInfinite

• isNegativeInfinite(): boolean

• Returns true if this FixedPointNumber value is NEGATIVE_INFINITY, otherwise returns false.

  Returns boolean

isPositive

• isPositive(): boolean

• Returns true if the sign of this FixedPointNumber is positive, otherwise returns false.

  Returns boolean

  true if the sign of this FixedPointNumber is positive, otherwise returns false.

  See

  bignumber.js isPositive

isPositiveInfinite

• isPositiveInfinite(): boolean

• Returns true if this FixedPointNumber value is POSITIVE_INFINITY, otherwise returns false.

  Returns boolean

  true if this FixedPointNumber value is POSITIVE_INFINITY, otherwise returns false.

isZero

• isZero(): boolean

• Returns true if the value of this FixedPointNumber is zero or minus zero, otherwise returns false.

  Returns boolean

  true if the value of this FixedPointNumber is zero or minus zero, otherwise returns false.

  see bignumber.js isZero

lt

• lt(that): boolean

• Returns true if the value of this FixedPointNumber is less than the value of that FixedPointNumber, otherwise returns false.

  Parameters

  • that: FixedPointNumber

    The FixedPointNumber to compare against.

  Returns boolean

  true if the value of this FixedPointNumber is less than the value of that FixedPointNumber, otherwise returns false.

  Remarks

  This method uses comparedTo internally.

  See

  bignumber.js isLessThan

lte

• lte(that): boolean

• Returns true if the value of this FixedPointNumber is less than or equal to the value of that FixedPointNumber, otherwise returns false.

  Parameters

  • that: FixedPointNumber

    The FixedPointNumber to compare against.

  Returns boolean

  true if the value of this FixedPointNumber is less than or equal to the value of that FixedPointNumber, otherwise returns false.

  Remarks

  This method uses comparedTo internally.

  See

  bignumber.js isLessThanOrEqualTo

minus

• minus(that): FixedPointNumber

• Returns a FixedPointNumber whose value is the value of this FixedPointNumber minus that FixedPointNumber.

  Limit cases

  • NaN - ±n = NaN
  • ±n - NaN = NaN
  • -Infinity - -Infinity = NaN
  • -Infinity - +n = -Infinity
  • +Infinity - +Infinity = NaN
  • +Infinity - +n = +Infinity

  Parameters

  • that: FixedPointNumber

    The fixed-point number to subtract.

  Returns FixedPointNumber

  The result of the subtraction. The return value is always exact and unrounded.

  Remarks

  The precision is the greater of the precision of the two operands.

  See

  bignumber.js minus

modulo

• modulo(that): FixedPointNumber

• Returns a FixedPointNumber whose value is the value of this FixedPointNumber modulo that FixedPointNumber, i.e. the integer remainder of dividing this FixedPointNumber by that.

  Limit cases

  • NaN % ±n = NaN
  • ±n % NaN = NaN
  • ±Infinity % n = NaN
  • n % ±Infinity = NaN

  Parameters

  • that: FixedPointNumber

    {FixedPointNumber} - The fixed-point number to divide by.

  Returns FixedPointNumber

  the integer remainder of dividing this FixedPointNumber by that.

  Remarks

  The precision is the greater of the precision of the two operands.

  See

  bignumber.js modulo

negated

• negated(): FixedPointNumber

• Returns a new instance of FixedPointNumber whose value is the value of this FixedPointNumber value negated, i.e. multiplied by -1.

  Returns FixedPointNumber

  See

  bignumber.js negated

plus

• plus(that): FixedPointNumber

• Returns a FixedPointNumber whose value is the value of this FixedPointNumber plus that FixedPointNumber.

  Limit cases

  • NaN + ±n = NaN
  • ±n + NaN = NaN
  • -Infinity + -Infinity = -Infinity
  • -Infinity + +Infinity = NaN
  • +Infinity + -Infinity = NaN
  • +Infinity + +Infinity = +Infinity

  Parameters

  • that: FixedPointNumber

    The fixed-point number to add to the current number.

  Returns FixedPointNumber

  The result of the addition. The return value is always exact and unrounded.

  Remarks

  The precision is the greater of the precision of the two operands.

  See

  bignumber.js plus

pow

• pow(that): FixedPointNumber

• Returns a FixedPointNumber whose value is the value of this FixedPointNumber raised to the power of that FixedPointNumber.

  This method implements the Exponentiation by Squaring algorithm.

  Limit cases

  • NaN ^ e = NaN
  • b ^ NaN = NaN
  • b ^ -Infinite = 0
  • b ^ 0 = 1
  • b ^ +Infinite = +Infinite
  • ±Infinite ^ -e = 0
  • ±Infinite ^ +e = +Infinite

  Parameters

  • that: FixedPointNumber

    The exponent as a fixed-point number. truncated to its integer component because Exponentiation by Squaring is not valid for rational exponents.

  Returns FixedPointNumber

  • The result of raising this fixed-point number to the power of the given exponent.

  See

  bignumber.js exponentiatedBy

sqrt

• sqrt(): FixedPointNumber

• Returns a FixedPointNumber whose value is the square root of the value of this FixedPointNumber

  Limit cases

  • NaN = NaN
  • +Infinite = +Infinite
  • -n = NaN

  Returns FixedPointNumber

  The square root of the number.

  See

  bignumber.js sqrt

times

• times(that): FixedPointNumber

• Returns a FixedPointNumber whose value is the value of this FixedPointNumber multiplied by that FixedPointNumber.

  Limits cases

  • NaN * n = NaN
  • n * NaN = NaN
  • -Infinite * -n = +Infinite
  • -Infinite * +n = -Infinite
  • +Infinite * -n = -Infinite
  • +Infinite * +n = +Infinite

  Parameters

  • that: FixedPointNumber

    The fixed-point number to multiply with this number.

  Returns FixedPointNumber

  a FixedPointNumber whose value is the value of this FixedPointNumber multiplied by that FixedPointNumber.

  Remarks

  The precision is the greater of the precision of the two operands.

  See

  bignumber.js multipliedBy

toString

• toString(decimalSeparator?): string

• Converts the fixed-point number to its string representation.

  Parameters

  • OptionaldecimalSeparator: string = '.'

    The character to use as the decimal separator in the string representation. Default is '.'.

  Returns string

  A string representation of the fixed-point number.

StaticisIntegerExpression

• isIntegerExpression(exp): boolean

• Checks if a given string expression is an integer in base 10 notation, considering - for negative and + optional for positive values.

  Parameters

  • exp: string

    The string expression to be tested.

  Returns boolean

  true if the expression is an integer, false otherwise.

StaticisNaturalExpression

• isNaturalExpression(exp): boolean

• Checks if a given string expression is a natural (unsigned positive integer) number in base 10 notation.

  Parameters

  • exp: string

    The string expression to be tested.

  Returns boolean

  true if the expression is a natural number, false otherwise.

StaticisNumberExpression

• isNumberExpression(exp): boolean

• Checks if a given string expression is a number in base 10 notation, considering - for negative and + optional for positive values.

  The method returns true for the following cases.

  • Whole numbers:
    • Positive whole numbers, optionally signed: 1, +2, 3, ...
    • Negative whole numbers: -1, -2, -3, ...
  • Decimal numbers:
    • Positive decimal numbers, optionally signed: 1.0, +2.5, 3.14, ...
    • Negative decimal numbers: -1.0, -2.5, -3.14, ...
    • Decimal numbers without whole part:
      • Positive decimal numbers, optionally signed: .1, +.5, .75, ...
      • Negative decimal numbers: -.1, -.5, -.75, ...

  Parameters

  • exp: string

    The string expression to be checked.

  Returns boolean

  true is exp represents a number, otherwise false.

Staticof

• of(exp, decimalPlaces?): FixedPointNumber

• Constructs a new instance of FixedPointNumber (Fixed Point Number) parsing the exp numeric expression in base 10 and representing the value with the precision of decimalPlaces fractional decimal digits.

  Parameters

  • exp:
        | string
        | number
        | bigint
        | FixedPointNumber

    The value to represent. It can be a bigint, number, or string representation of the number.
  • OptionaldecimalPlaces: bigint = ...

    The number of fractional decimal digits to be used to represent the value.

  Returns FixedPointNumber

  A new instance of FixedPointNumber with the given parameters.

  Throws

  If exp is not a numeric expression.