Interface Decimal

interface Decimal {
    abs(): Decimal;
    absoluteValue(): Decimal;
    add(y: Numeric): Decimal;
    cmp(y: Numeric): -1 | 0 | 1;
    comparedTo(y: Numeric): -1 | 0 | 1;
    decimalPlaces(): number;
    div(y: Numeric): Decimal;
    dividedBy(y: Numeric): Decimal;
    dividedToIntegerBy(y: Numeric): Decimal;
    dp(): number;
    eq(y: Numeric): boolean;
    equals(y: Numeric): boolean;
    exp(): Decimal;
    exponent(): number;
    greaterThan(y: Numeric): boolean;
    greaterThanOrEqualTo(y: Numeric): boolean;
    gt(y: Numeric): boolean;
    gte(y: Numeric): boolean;
    idiv(y: Numeric): Decimal;
    isint(): boolean;
    isInteger(): boolean;
    isneg(): boolean;
    isNegative(): boolean;
    ispos(): boolean;
    isPositive(): boolean;
    isZero(): boolean;
    lessThan(y: Numeric): boolean;
    lessThanOrEqualTo(y: Numeric): boolean;
    ln(): Decimal;
    log(base?: Numeric): Decimal;
    logarithm(base?: Numeric): Decimal;
    lt(y: Numeric): boolean;
    lte(y: Numeric): boolean;
    minus(y: Numeric): Decimal;
    mod(y: Numeric): Decimal;
    modulo(y: Numeric): Decimal;
    mul(y: Numeric): Decimal;
    naturalExponetial(): Decimal;
    naturalLogarithm(): Decimal;
    neg(): Decimal;
    negated(): Decimal;
    plus(y: Numeric): Decimal;
    pow(y: Numeric): Decimal;
    precision(zeros: number | boolean): number;
    sd(zeros: number | boolean): number;
    sqrt(): Decimal;
    squareRoot(): Decimal;
    sub(y: Numeric): Decimal;
    times(y: Numeric): Decimal;
    toDecimalPlaces(dp?: number, rm?: number): Decimal;
    todp(dp?: number, rm?: number): Decimal;
    toExponential(dp?: number, rm?: number): string;
    toFixed(dp?: number, rm?: number): string;
    toint(): Decimal;
    toInteger(): Decimal;
    toJSON(): string;
    toNumber(): number;
    toPower(y: Numeric): Decimal;
    toPrecision(sd?: number, rm?: number): string;
    tosd(sd?: number, rm?: number): Decimal;
    toSignificantDigits(sd?: number, rm?: number): Decimal;
    toString(): string;
    val(): string;
    valueOf(): string;
}

Methods

abs

abs(): Decimal
Return a new Decimal whose value is the absolute value of this Decimal.

Returns Decimal

absoluteValue

absoluteValue(): Decimal
Return a new Decimal whose value is the absolute value of this Decimal.

Returns Decimal

add

add(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal plus y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

cmp

cmp(y: Numeric): -1 | 0 | 1
Return 1 if the value of this Decimal is greater than the value of y, -1 if the value of this Decimal is less than the value of y, 0 if they have the same value
Parameters
- y: Numeric
Returns -1 | 0 | 1

comparedTo

comparedTo(y: Numeric): -1 | 0 | 1
Return 1 if the value of this Decimal is greater than the value of y, -1 if the value of this Decimal is less than the value of y, 0 if they have the same value
Parameters
- y: Numeric
Returns -1 | 0 | 1

decimalPlaces

decimalPlaces(): number
Return the number of decimal places of the value of this Decimal.

Returns number

div

div(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal divided by y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

dividedBy

dividedBy(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal divided by y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

dividedToIntegerBy

dividedToIntegerBy(y: Numeric): Decimal
Return a new Decimal whose value is the integer part of dividing the value of this Decimal by the value of y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

dp

dp(): number
Return the number of decimal places of the value of this Decimal.

Returns number

eq

eq(y: Numeric): boolean
Return true if the value of this Decimal is equal to the value of y, otherwise return false.
Parameters
- y: Numeric
Returns boolean

equals

equals(y: Numeric): boolean
Return true if the value of this Decimal is equal to the value of y, otherwise return false.
Parameters
- y: Numeric
Returns boolean

exp

exp(): Decimal
Return a new Decimal whose value is the natural exponential of the value of this Decimal, i.e. the base e raised to the power the value of this Decimal, truncated to precision significant digits.

Returns Decimal

exponent

exponent(): number
Return the (base 10) exponent value of this Decimal (this.e is the base 10000000 exponent).

Returns number

greaterThan

greaterThan(y: Numeric): boolean
Return true if the value of this Decimal is greater than the value of y, otherwise return false.
Parameters
- y: Numeric
Returns boolean

greaterThanOrEqualTo

greaterThanOrEqualTo(y: Numeric): boolean
Return true if the value of this Decimal is greater than or equal to the value of y, otherwise return false.
Parameters
- y: Numeric
Returns boolean

gt

gt(y: Numeric): boolean
Return true if the value of this Decimal is greater than the value of y, otherwise return false.
Parameters
- y: Numeric
Returns boolean

gte

gte(y: Numeric): boolean
Return true if the value of this Decimal is greater than or equal to the value of y, otherwise return false.
Parameters
- y: Numeric
Returns boolean

idiv

idiv(y: Numeric): Decimal
Return a new Decimal whose value is the integer part of dividing the value of this Decimal by the value of y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

isint

isint(): boolean
Return true if the value of this Decimal is an integer, otherwise return false.

Returns boolean

isInteger

isInteger(): boolean
Return true if the value of this Decimal is an integer, otherwise return false.

Returns boolean

isneg

isneg(): boolean
Return true if the value of this Decimal is negative, otherwise return false.

Returns boolean

isNegative

isNegative(): boolean
Return true if the value of this Decimal is negative, otherwise return false.

Returns boolean

ispos

ispos(): boolean
Return true if the value of this Decimal is positive, otherwise return false.

Returns boolean

isPositive

isPositive(): boolean
Return true if the value of this Decimal is positive, otherwise return false.

Returns boolean

isZero

isZero(): boolean
Return true if the value of this Decimal is 0, otherwise return false.

Returns boolean

lessThan

lessThan(y: Numeric): boolean
Return true if the value of this Decimal is less than y, otherwise return false.
Parameters
- y: Numeric
Returns boolean

lessThanOrEqualTo

lessThanOrEqualTo(y: Numeric): boolean
Return true if the value of this Decimal is less than or equal to y, otherwise return false.
Parameters
- y: Numeric
Returns boolean

ln

ln(): Decimal
Return a new Decimal whose value is the natural logarithm of the value of this Decimal, truncated to precision significant digits.

Returns Decimal

log

log(base?: Numeric): Decimal
Return the logarithm of the value of this Decimal to the specified base, truncated to precision significant digits.

If no base is specified, return log10.

logbase = ln(x) / ln(base)

The maximum error of the result is 1 ulp (unit in the last place).
Parameters
- Optionalbase: Numeric
Returns Decimal

logarithm

logarithm(base?: Numeric): Decimal
Return the logarithm of the value of this Decimal to the specified base, truncated to precision significant digits.

If no base is specified, return log10.

logbase = ln(x) / ln(base)

The maximum error of the result is 1 ulp (unit in the last place).
Parameters
- Optionalbase: Numeric
Returns Decimal

lt

lt(y: Numeric): boolean
Return true if the value of this Decimal is less than y, otherwise return false.
Parameters
- y: Numeric
Returns boolean

lte

lte(y: Numeric): boolean
Return true if the value of this Decimal is less than or equal to y, otherwise return false.
Parameters
- y: Numeric
Returns boolean

minus

minus(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal minus y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

mod

mod(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal modulo y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

modulo

modulo(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal modulo y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

mul

mul(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal times y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

naturalExponetial

naturalExponetial(): Decimal
Return a new Decimal whose value is the natural exponential of the value of this Decimal, i.e. the base e raised to the power the value of this Decimal, truncated to precision significant digits.

Returns Decimal

naturalLogarithm

naturalLogarithm(): Decimal
Return a new Decimal whose value is the natural logarithm of the value of this Decimal, truncated to precision significant digits.

Returns Decimal

neg

neg(): Decimal
Return a new Decimal whose value is the value of this Decimal negated, i.e. as if multiplied by -1.

Returns Decimal

negated

negated(): Decimal
Return a new Decimal whose value is the value of this Decimal negated, i.e. as if multiplied by -1.

Returns Decimal

plus

plus(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal plus y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

pow

pow(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal raised to the power y, truncated to precision significant digits.

For non-integer or very large exponents pow(x, y) is calculated using

x^y = exp(y*ln(x))

The maximum error is 1 ulp (unit in last place).
Parameters
- y: Numeric
  The power to which to raise this Decimal.
Returns Decimal

precision

precision(zeros: number | boolean): number
Return the number of significant digits of the value of this Decimal.
Parameters
- zeros: number | boolean
  Whether to count integer-part trailing zeros: true, false, 1 or 0.
Returns number

sd

sd(zeros: number | boolean): number
Return the number of significant digits of the value of this Decimal.
Parameters
- zeros: number | boolean
  Whether to count integer-part trailing zeros: true, false, 1 or 0.
Returns number

sqrt

sqrt(): Decimal
Return a new Decimal whose value is the square root of this Decimal, truncated to precision significant digits.

Returns Decimal

squareRoot

squareRoot(): Decimal
Return a new Decimal whose value is the square root of this Decimal, truncated to precision significant digits.

Returns Decimal

sub

sub(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal minus y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

times

times(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal times y, truncated to precision significant digits.
Parameters
- y: Numeric
Returns Decimal

toDecimalPlaces

toDecimalPlaces(dp?: number, rm?: number): Decimal
Return a new Decimal whose value is the value of this Decimal rounded to a maximum of dp decimal places using rounding mode rm or rounding if rm is omitted.

If dp is omitted, return a new Decimal whose value is the value of this Decimal.
Parameters
- Optionaldp: number
  Decimal places. Integer, 0 to MAX_DIGITS inclusive.
- Optionalrm: number
  Rounding mode. Integer, 0 to 8 inclusive.
Returns Decimal

todp

todp(dp?: number, rm?: number): Decimal
Return a new Decimal whose value is the value of this Decimal rounded to a maximum of dp decimal places using rounding mode rm or rounding if rm is omitted.

If dp is omitted, return a new Decimal whose value is the value of this Decimal.
Parameters
- Optionaldp: number
  Decimal places. Integer, 0 to MAX_DIGITS inclusive.
- Optionalrm: number
  Rounding mode. Integer, 0 to 8 inclusive.
Returns Decimal

toExponential

toExponential(dp?: number, rm?: number): string
Return a string representing the value of this Decimal in exponential notation rounded to dp fixed decimal places using rounding mode rounding.
Parameters
- Optionaldp: number
  Decimal places. Integer, 0 to MAX_DIGITS inclusive.
- Optionalrm: number
  Rounding mode. Integer, 0 to 8 inclusive.
Returns string

toFixed

toFixed(dp?: number, rm?: number): string
Return a string representing the value of this Decimal in normal (fixed-point) notation to dp fixed decimal places and rounded using rounding mode rm or rounding if rm is omitted.

As with JavaScript numbers, (-0).toFixed(0) is '0', but e.g. (-0.00001).toFixed(0) is '-0'.
Parameters
- Optionaldp: number
  Decimal places. Integer, 0 to MAX_DIGITS inclusive.
- Optionalrm: number
  Rounding mode. Integer, 0 to 8 inclusive.
  
  (-0).toFixed(0) is '0', but (-0.1).toFixed(0) is '-0'. (-0).toFixed(1) is '0.0', but (-0.01).toFixed(1) is '-0.0'. (-0).toFixed(3) is '0.000'. (-0.5).toFixed(0) is '-0'.
Returns string

toint

toint(): Decimal
Return a new Decimal whose value is the value of this Decimal rounded to a whole number using rounding mode rounding.

Returns Decimal

toInteger

toInteger(): Decimal
Return a new Decimal whose value is the value of this Decimal rounded to a whole number using rounding mode rounding.

Returns Decimal

toJSON

toJSON(): string
Return a string representing the value of this Decimal.

Return exponential notation if this Decimal has a positive exponent equal to or greater than toExpPos, or a negative exponent equal to or less than toExpNeg.

Returns string

toNumber

toNumber(): number
Return the value of this Decimal converted to a number primitive.

Returns number

toPower

toPower(y: Numeric): Decimal
Return a new Decimal whose value is the value of this Decimal raised to the power y, truncated to precision significant digits.

For non-integer or very large exponents pow(x, y) is calculated using

x^y = exp(y*ln(x))

The maximum error is 1 ulp (unit in last place).
Parameters
- y: Numeric
  The power to which to raise this Decimal.
Returns Decimal

toPrecision

toPrecision(sd?: number, rm?: number): string
Return a string representing the value of this Decimal rounded to sd significant digits using rounding mode rounding.

Return exponential notation if sd is less than the number of digits necessary to represent the integer part of the value in normal notation.
Parameters
- Optionalsd: number
  Significant digits. Integer, 1 to MAX_DIGITS inclusive.
- Optionalrm: number
  Rounding mode. Integer, 0 to 8 inclusive.
Returns string

tosd

tosd(sd?: number, rm?: number): Decimal
Return a new Decimal whose value is the value of this Decimal rounded to a maximum of sd significant digits using rounding mode rm, or to precision and rounding respectively if omitted.
Parameters
- Optionalsd: number
  Significant digits. Integer, 1 to MAX_DIGITS inclusive.
- Optionalrm: number
  Rounding mode. Integer, 0 to 8 inclusive.
Returns Decimal

toSignificantDigits

toSignificantDigits(sd?: number, rm?: number): Decimal
Return a new Decimal whose value is the value of this Decimal rounded to a maximum of sd significant digits using rounding mode rm, or to precision and rounding respectively if omitted.
Parameters
- Optionalsd: number
  Significant digits. Integer, 1 to MAX_DIGITS inclusive.
- Optionalrm: number
  Rounding mode. Integer, 0 to 8 inclusive.
Returns Decimal

toString

toString(): string
Return a string representing the value of this Decimal.

Return exponential notation if this Decimal has a positive exponent equal to or greater than toExpPos, or a negative exponent equal to or less than toExpNeg.

Returns string

val

val(): string
Return a string representing the value of this Decimal.

Return exponential notation if this Decimal has a positive exponent equal to or greater than toExpPos, or a negative exponent equal to or less than toExpNeg.

Returns string

valueOf

valueOf(): string
Return a string representing the value of this Decimal.

Return exponential notation if this Decimal has a positive exponent equal to or greater than toExpPos, or a negative exponent equal to or less than toExpNeg.

Returns string

Interface Decimal

Index

Methods

Methods

abs

Returns Decimal

absoluteValue

Returns Decimal

add

Parameters

Returns Decimal

cmp

Parameters

Returns -1 | 0 | 1

comparedTo

Parameters

Returns -1 | 0 | 1

decimalPlaces

Returns number

div

Parameters

Returns Decimal

dividedBy

Parameters

Returns Decimal

dividedToIntegerBy

Parameters

Returns Decimal

dp

Returns number

eq

Parameters

Returns boolean

equals

Parameters

Returns boolean

exp

Returns Decimal

exponent

Returns number

greaterThan

Parameters

Returns boolean

greaterThanOrEqualTo

Parameters

Returns boolean

gt

Parameters

Returns boolean

gte

Parameters

Returns boolean

idiv

Parameters

Returns Decimal

isint

Returns boolean

isInteger

Returns boolean

isneg

Returns boolean

isNegative

Returns boolean

ispos

Returns boolean

isPositive

Returns boolean

isZero

Returns boolean

lessThan

Parameters

Returns boolean

lessThanOrEqualTo

Parameters

Returns boolean

ln

Returns Decimal

log

Parameters

Returns Decimal