The Decimal class is a helper class to perform decimal arithmetic in scripts and to represent a decimal number with arbitrary length. The decimal class avoids arithmetic errors, which are typical for calculating with floating numbers, that are based on a binary mantissa.
The class is designed in a way that it can be used very similar to a desktop calculator.
1var d = new Decimal( 10.0 );
2var result = d.add( 2.0 ).sub( 3.0 ).get();The above code will return 9 as result.
| Constructor | Description |
|---|---|
| Decimal() | Constructs a new Decimal with the value 0. |
| Decimal(Number) | Constructs a new decimal using the specified Number value. |
| Decimal(BigInt) | Constructs a new decimal using the specified BigInt value. |
| Decimal(String) | Constructs a new Decimal using the specified string representation of a number. |
| Method | Description |
|---|---|
| abs() | Returns a new Decimal with the absolute value of this Decimal. |
| add(Number) | Adds a Number value to this Decimal and returns the new Decimal. |
| add(Decimal) | Adds a Decimal value to this Decimal and returns the new Decimal. |
| addPercent(Number) | Adds a percentage value to the current value of the decimal. |
| addPercent(Decimal) | Adds a percentage value to the current value of the decimal. |
| divide(Number) | Divides the specified Number value with this decimal and returns the new decimal. |
| divide(Decimal) | Divides the specified Decimal value with this decimal and returns the new decimal. |
| equals(Object) | Compares two decimal values whether they are equivalent. |
| get() | Returns the value of the Decimal as a Number. |
| hashCode() | Calculates the hash code for this decimal; |
| multiply(Number) | Multiples the specified Number value with this Decimal and returns the new Decimal. |
| multiply(Decimal) | Multiples the specified Decimal value with this Decimal and returns the new Decimal. |
| negate() | Returns a new Decimal with the negated value of this Decimal. |
| round(Number) | Rounds the current value of the decimal using the specified number of decimals. |
| subtract(Number) | Subtracts the specified Number value from this Decimal and returns the new Decimal. |
| subtract(Decimal) | Subtracts the specified Decimal value from this Decimal and returns the new Decimal. |
| subtractPercent(Number) | Subtracts a percentage value from the current value of the decimal. |
| subtractPercent(Decimal) | Subtracts a percentage value from the current value of the decimal. |
| toString() | Returns a string representation of this object. |
| valueOf() | The valueOf() method is called by the ECMAScript interpret to return the “natural” value of an object. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Constructs a new Decimal with the value 0.
Constructs a new decimal using the specified Number value.
Parameters:
Constructs a new decimal using the specified BigInt value.
Parameters:
API Version:
Available from version 22.7.
Note
Constructs a new Decimal using the specified string representation of a number.
Parameters:
Returns a new Decimal with the absolute value of this Decimal.
Returns:
Adds a Number value to this Decimal and returns the new Decimal.
Parameters:
Returns:
Adds a Decimal value to this Decimal and returns the new Decimal.
Parameters:
Returns:
Adds a percentage value to the current value of the decimal. For example a value of 10 represent 10% or a value of 85 represents 85%.
Parameters:
Returns:
Adds a percentage value to the current value of the decimal. For example a value of 10 represent 10% or a value of 85 represents 85%.
Parameters:
Returns:
Divides the specified Number value with this decimal and returns the new decimal.
When performing the division, 34 digits precision and a rounding mode of HALF_EVEN is used to prevent quotients with nonterminating decimal expansions.
Parameters:
Returns:
Divides the specified Decimal value with this decimal and returns the new decimal.
When performing the division, 34 digits precision and a rounding mode of HALF_EVEN is used to prevent quotients with nonterminating decimal expansions.
Parameters:
Returns:
Compares two decimal values whether they are equivalent.
Parameters:
Returns the value of the Decimal as a Number.
Returns:
Calculates the hash code for this decimal;
Multiples the specified Number value with this Decimal and returns the new Decimal.
Parameters:
Returns:
Multiples the specified Decimal value with this Decimal and returns the new Decimal.
Parameters:
Returns:
Returns a new Decimal with the negated value of this Decimal.
Returns:
Rounds the current value of the decimal using the specified number of decimals. The parameter specifies the number of digest after the decimal point.
Parameters:
Returns:
Subtracts the specified Number value from this Decimal and returns the new Decimal.
Parameters:
Returns:
Subtracts the specified Decimal value from this Decimal and returns the new Decimal.
Parameters:
Returns:
Subtracts a percentage value from the current value of the decimal. For example a value of 10 represent 10% or a value of 85 represents 85%.
Parameters:
Returns:
Subtracts a percentage value from the current value of the decimal. For example a value of 10 represent 10% or a value of 85 represents 85%.
Parameters:
Returns:
Returns a string representation of this object.
Returns:
The valueOf() method is called by the ECMAScript interpret to return the "natural" value of an object. The Decimal object returns its current value as number. With this behavior script snippets can be written like:
var d = new Decimal( 10.0 ); var x = 1.0 + d.add( 2.0 );
where x will be at the end 13.0.
Returns:
j