Class Decimal

The arithmetic Decimal tier plus powers, logarithms, and trigonometry. Exported as Decimal by both the root and scientific entry points. Calculations preserve library clones and return this tier for application subclasses.

Hierarchy (View Summary)

Decimal
- Decimal

Index

Constructors

constructor

new Decimal(value: DecimalValue): Decimal
Create a Decimal from an exact numeric input.
Parameters
- value: DecimalValue
Returns Decimal
Inherited from Decimal.constructor
- Defined in src/CoreDecimal.ts:116

Properties

`Static`clone

clone: (config?: Partial<DecimalConfig>) => DecimalConstructor

Create an independently configurable constructor for this tier.

Type Declaration

- (config?: Partial<DecimalConfig>): DecimalConstructor
- Create an independently configurable scientific constructor.
  Parameters
  - Optionalconfig: Partial<DecimalConfig>
  Returns DecimalConstructor

`Static`max

max: {
(value: DecimalValueIterable): Decimal;
(value: DecimalValue, ...values: DecimalValue[]): Decimal;
}

Select the greatest value from an iterable or scalar inputs.

Type Declaration

- (value: DecimalValueIterable): Decimal
- Select the greatest value from a non-empty iterable.
  Parameters
  - value: DecimalValueIterable
  Returns Decimal
- (value: DecimalValue, ...values: DecimalValue[]): Decimal
- Select the greatest of one or more scalar values.
  Parameters
  - value: DecimalValue
  - ...values: DecimalValue[]
  Returns Decimal

`Static`min

min: {
(value: DecimalValueIterable): Decimal;
(value: DecimalValue, ...values: DecimalValue[]): Decimal;
}

Select the least value from an iterable or scalar inputs.

Type Declaration

- (value: DecimalValueIterable): Decimal
- Select the least value from a non-empty iterable.
  Parameters
  - value: DecimalValueIterable
  Returns Decimal
- (value: DecimalValue, ...values: DecimalValue[]): Decimal
- Select the least of one or more scalar values.
  Parameters
  - value: DecimalValue
  - ...values: DecimalValue[]
  Returns Decimal

Accessors

`Static`config

get config(): Readonly<DecimalConfig>
Read a frozen snapshot of this constructor's active configuration.

Returns Readonly<DecimalConfig>
- Defined in src/CoreDecimal.ts:75
set config(params: DecimalConfigInput): void
Apply a validated partial configuration update to this constructor.
Parameters
- params: DecimalConfigInput
Returns void
- Defined in src/CoreDecimal.ts:80

`Static`limits

get limits(): DecimalLimits
Hard validation limits shared by every Decimal tier.

Returns DecimalLimits
- Defined in src/CoreDecimal.ts:73

`Static`PI

get PI(): Decimal
Pi at the active precision.

Returns Decimal
- Defined in src/ScientificDecimal.ts:79

Methods

[toPrimitive]

"[toPrimitive]"(hint: "string" | "number" | "default"): string | number
Convert according to JavaScript's primitive hint.
Parameters
- hint: "string" | "number" | "default"
Returns string | number
Inherited from Decimal.[toPrimitive]
- Defined in src/CoreDecimal.ts:220

abs

abs(): Decimal
Return the absolute value.

Returns Decimal
Inherited from Decimal.abs
- Defined in src/ArithmeticDecimal.ts:106

acos

acos(): Decimal
Calculate the inverse cosine in radians.

Returns Decimal
- Defined in src/ScientificDecimal.ts:151

acosh

acosh(): Decimal
Calculate the inverse hyperbolic cosine.

Returns Decimal
- Defined in src/ScientificDecimal.ts:157

add

add(value: DecimalValue): Decimal
Add a value.
Parameters
- value: DecimalValue
Returns Decimal
Inherited from Decimal.add
- Defined in src/ArithmeticDecimal.ts:71

asin

asin(): Decimal
Calculate the inverse sine in radians.

Returns Decimal
- Defined in src/ScientificDecimal.ts:139

asinh

asinh(): Decimal
Calculate the inverse hyperbolic sine.

Returns Decimal
- Defined in src/ScientificDecimal.ts:145

atan

atan(): Decimal
Calculate the inverse tangent in radians.

Returns Decimal
- Defined in src/ScientificDecimal.ts:163

atanh

atanh(): Decimal
Calculate the inverse hyperbolic tangent.

Returns Decimal
- Defined in src/ScientificDecimal.ts:169

cbrt

cbrt(): Decimal
Return the real cube root.

Returns Decimal
- Defined in src/ScientificDecimal.ts:112

ceil

ceil(): Decimal
Round to an integer toward positive Infinity.

Returns Decimal
Inherited from Decimal.ceil
- Defined in src/ArithmeticDecimal.ts:117

cmp

cmp(value: DecimalValue): number
Compare this value with another value.
Parameters
- value: DecimalValue
Returns number
Inherited from Decimal.cmp
- Defined in src/CoreDecimal.ts:151

cos

cos(): Decimal
Calculate the cosine of this radian value.

Returns Decimal
- Defined in src/ScientificDecimal.ts:148

cosh

cosh(): Decimal
Calculate the hyperbolic cosine.

Returns Decimal
- Defined in src/ScientificDecimal.ts:154

div

div(value: DecimalValue): Decimal
Divide by a value using the active precision and rounding mode.
Parameters
- value: DecimalValue
Returns Decimal
Inherited from Decimal.div
- Defined in src/ArithmeticDecimal.ts:86

divToInt

divToInt(value: DecimalValue): Decimal
Divide by a value and truncate the quotient toward zero.
Parameters
- value: DecimalValue
Returns Decimal
Inherited from Decimal.divToInt
- Defined in src/ArithmeticDecimal.ts:91

dp

dp(): number
Returns number
The number of digits after the decimal point, or NaN for a non-finite value.
Inherited from Decimal.dp
- Defined in src/CoreDecimal.ts:139

eq

eq(value: DecimalValue): boolean
Parameters
- value: DecimalValue
Returns boolean
Whether this value compares equal to value.
Inherited from Decimal.eq
- Defined in src/CoreDecimal.ts:159

exp

exp(): Decimal
Raise Euler's number to this value.

Returns Decimal
- Defined in src/ScientificDecimal.ts:130

floor

floor(): Decimal
Round to an integer toward negative Infinity.

Returns Decimal
Inherited from Decimal.floor
- Defined in src/ArithmeticDecimal.ts:122

gt

gt(value: DecimalValue): boolean
Parameters
- value: DecimalValue
Returns boolean
Whether this value is greater than value.
Inherited from Decimal.gt
- Defined in src/CoreDecimal.ts:162

gte

gte(value: DecimalValue): boolean
Parameters
- value: DecimalValue
Returns boolean
Whether this value is greater than or equal to value.
Inherited from Decimal.gte
- Defined in src/CoreDecimal.ts:165

isEven

isEven(): boolean
Returns boolean
Whether this value is a finite even integer.
Inherited from Decimal.isEven
- Defined in src/CoreDecimal.ts:199

isFinite

isFinite(): boolean
Returns boolean
Whether this value is finite.
Inherited from Decimal.isFinite
- Defined in src/CoreDecimal.ts:178

isInt

isInt(): boolean
Returns boolean
Whether this value is a finite integer.
Inherited from Decimal.isInt
- Defined in src/CoreDecimal.ts:181

isNaN

isNaN(): boolean
Returns boolean
Whether this value is NaN.
Inherited from Decimal.isNaN
- Defined in src/CoreDecimal.ts:184

isNeg

isNeg(): boolean
Returns boolean
Whether this value has a negative sign.
Inherited from Decimal.isNeg
- Defined in src/CoreDecimal.ts:187

isOdd

isOdd(): boolean
Returns boolean
Whether this value is a finite odd integer.
Inherited from Decimal.isOdd
- Defined in src/CoreDecimal.ts:196

isPos

isPos(): boolean
Returns boolean
Whether this value has a positive sign.
Inherited from Decimal.isPos
- Defined in src/CoreDecimal.ts:190

isZero

isZero(): boolean
Returns boolean
Whether this value is positive or negative zero.
Inherited from Decimal.isZero
- Defined in src/CoreDecimal.ts:193

ln

ln(): Decimal
Calculate the natural logarithm.

Returns Decimal
- Defined in src/ScientificDecimal.ts:124

log

log(base: DecimalValue): Decimal
Calculate a logarithm in an arbitrary base.
Parameters
- base: DecimalValue
Returns Decimal
- Defined in src/ScientificDecimal.ts:118

lt

lt(value: DecimalValue): boolean
Parameters
- value: DecimalValue
Returns boolean
Whether this value is less than value.
Inherited from Decimal.lt
- Defined in src/CoreDecimal.ts:172

lte

lte(value: DecimalValue): boolean
Parameters
- value: DecimalValue
Returns boolean
Whether this value is less than or equal to value.
Inherited from Decimal.lte
- Defined in src/CoreDecimal.ts:175

mod

mod(value: DecimalValue): Decimal
Calculate a remainder using the configured modulo mode.
Parameters
- value: DecimalValue
Returns Decimal
Inherited from Decimal.mod
- Defined in src/ArithmeticDecimal.ts:96

mul

mul(value: DecimalValue): Decimal
Multiply by a value.
Parameters
- value: DecimalValue
Returns Decimal
Inherited from Decimal.mul
- Defined in src/ArithmeticDecimal.ts:81

neg

neg(): Decimal
Return a new Decimal with the sign inverted.

Returns Decimal
Inherited from Decimal.neg
- Defined in src/ArithmeticDecimal.ts:101

pow

pow(value: DecimalValue): Decimal
Raise this value to a power.
Parameters
- value: DecimalValue
Returns Decimal
- Defined in src/ScientificDecimal.ts:100

precision

precision(includeTrailingIntegerZeros?: boolean): number
Count this value's significant digits.
Parameters
- OptionalincludeTrailingIntegerZeros: boolean
Returns number
Inherited from Decimal.precision
- Defined in src/CoreDecimal.ts:142

round

round(): Decimal
Round to an integer using the configured rounding mode.

Returns Decimal
Inherited from Decimal.round
- Defined in src/ArithmeticDecimal.ts:127

shift

shift(places: number): Decimal
Shift the decimal point by a power of ten.
Parameters
- places: number
Returns Decimal
Inherited from Decimal.shift
- Defined in src/ArithmeticDecimal.ts:111

sign

sign(): number
Returns number
-1, -0, 0, 1, or NaN according to this value's state.
Inherited from Decimal.sign
- Defined in src/CoreDecimal.ts:148

sin

sin(): Decimal
Calculate the sine of this radian value.

Returns Decimal
- Defined in src/ScientificDecimal.ts:136

sinh

sinh(): Decimal
Calculate the hyperbolic sine.

Returns Decimal
- Defined in src/ScientificDecimal.ts:142

sqrt

sqrt(): Decimal
Return the principal square root.

Returns Decimal
- Defined in src/ScientificDecimal.ts:106

sub

sub(value: DecimalValue): Decimal
Subtract a value.
Parameters
- value: DecimalValue
Returns Decimal
Inherited from Decimal.sub
- Defined in src/ArithmeticDecimal.ts:76

tan

tan(): Decimal
Calculate the tangent of this radian value.

Returns Decimal
- Defined in src/ScientificDecimal.ts:160

tanh

tanh(): Decimal
Calculate the hyperbolic tangent.

Returns Decimal
- Defined in src/ScientificDecimal.ts:166

toDP

toDP(dp?: number, rm?: RoundingMode): Decimal
Round to a maximum number of decimal places.
Parameters
- Optionaldp: number
- Optionalrm: RoundingMode
Returns Decimal
Inherited from Decimal.toDP
- Defined in src/ArithmeticDecimal.ts:154

toExponential

toExponential(dp?: number, rm?: RoundingMode): string
Format this value in exponential notation.
Parameters
- Optionaldp: number
- Optionalrm: RoundingMode
Returns string
Inherited from Decimal.toExponential
- Defined in src/CoreDecimal.ts:242

toFixed

toFixed(dp?: number, rm?: RoundingMode): string
Format this value in fixed-point notation.
Parameters
- Optionaldp: number
- Optionalrm: RoundingMode
Returns string
Inherited from Decimal.toFixed
- Defined in src/CoreDecimal.ts:228

toFraction

toFraction(denominator?: DecimalValue): DecimalFraction<Decimal>
Approximate this value as a fraction.
Parameters
- Optionaldenominator: DecimalValue
Returns DecimalFraction<Decimal>
Inherited from Decimal.toFraction
- Defined in src/ArithmeticDecimal.ts:174

toJSON

toJSON(): string
Return the exact string serialized by JSON.

Returns string
Inherited from Decimal.toJSON
- Defined in src/CoreDecimal.ts:217

toNearest

toNearest(value?: DecimalValue, rm?: RoundingMode): Decimal
Round to a multiple of another value.
Parameters
- Optionalvalue: DecimalValue
- Optionalrm: RoundingMode
Returns Decimal
Inherited from Decimal.toNearest
- Defined in src/ArithmeticDecimal.ts:144

toNumber

toNumber(): number
Convert to the nearest JavaScript number.

Returns number
Inherited from Decimal.toNumber
- Defined in src/CoreDecimal.ts:239

toPrecision

toPrecision(sd?: number, rm?: RoundingMode): string
Format this value to a specified number of significant digits.
Parameters
- Optionalsd: number
- Optionalrm: RoundingMode
Returns string
Inherited from Decimal.toPrecision
- Defined in src/CoreDecimal.ts:253

toSD

toSD(sd?: number, rm?: RoundingMode): Decimal
Round to a maximum number of significant digits.
Parameters
- Optionalsd: number
- Optionalrm: RoundingMode
Returns Decimal
Inherited from Decimal.toSD
- Defined in src/ArithmeticDecimal.ts:164

toString

toString(): string
Format this value in canonical fixed or exponential notation.

Returns string
Inherited from Decimal.toString
- Defined in src/CoreDecimal.ts:202

toValue

toValue(): string
Return the exact primitive string value, preserving negative zero.

Returns string
Inherited from Decimal.toValue
- Defined in src/CoreDecimal.ts:208

trunc

trunc(): Decimal
Truncate to an integer toward zero.

Returns Decimal
Inherited from Decimal.trunc
- Defined in src/ArithmeticDecimal.ts:132

valueOf

valueOf(): string
Return the exact string used by default JavaScript coercion.

Returns string
Inherited from Decimal.valueOf
- Defined in src/CoreDecimal.ts:214

`Static`atan2

atan2(y: DecimalValue, x: DecimalValue): Decimal
Calculate the angle from the positive x-axis to (x, y).
Parameters
- y: DecimalValue
- x: DecimalValue
Returns Decimal
- Defined in src/ScientificDecimal.ts:94

Class Decimal

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Decimal

Properties

Staticclone

Type Declaration

Parameters

Returns DecimalConstructor

Staticmax

Type Declaration

Parameters

Returns Decimal

Parameters

Returns Decimal

Staticmin

Type Declaration

Parameters

Returns Decimal

Parameters

Returns Decimal

Accessors

Staticconfig

Returns Readonly<DecimalConfig>

Parameters

Returns void

Staticlimits

Returns DecimalLimits

StaticPI

Returns Decimal

Methods

[toPrimitive]

Parameters

Returns string | number

abs

Returns Decimal

acos

Returns Decimal

acosh

Returns Decimal

add

Parameters

Returns Decimal

asin

Returns Decimal

asinh

Returns Decimal

atan

Returns Decimal

atanh

Returns Decimal

cbrt

Returns Decimal

ceil

Returns Decimal

cmp

Parameters

Returns number

cos

Returns Decimal

cosh

Returns Decimal

div

Parameters

Returns Decimal

divToInt

Parameters

Returns Decimal

dp

Returns number

eq

Parameters

Returns boolean

`Static`clone

`Static`max

`Static`min

`Static`config

`Static`limits

`Static`PI