Script: Class dw.util.Decimal
Class Decimal
- Object
- dw.util.Decimal
The Decimal class is a helper class to perform decimal arithmetic in scripts and to represent a decimal number with arbitray 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. var d = new Decimal( 10.0 ); var result = d.add( 2.0 ).sub( 3.0 ).get(); The above code will return 9 as result.
Constructor Summary
Decimal()
Constructs a new Decimal with the value 0.
Constructs a new decimal using the specified Number value.
Constructs a new decimal using the specified BigInt value.
Constructs a new Decimal using the specified string representation of a number.
Method Summary
Returns a new Decimal with the absolute value of this Decimal.
Adds a Number value to this Decimal and returns the new Decimal.
add(value : Decimal) : Decimal
Adds a Decimal value to this Decimal and returns the new Decimal.
addPercent(value : Number) : Decimal
Adds a percentage value to the current value of the decimal.
addPercent(value : Decimal) : Decimal
Adds a percentage value to the current value of the decimal.
divide(value : Number) : Decimal
Divides the specified Number value with this decimal and returns the new decimal.
divide(value : Decimal) : Decimal
Divides the specified Decimal value with this decimal and returns the new decimal.
equals(other : Object) : boolean
Compares two decimal values whether they are equivalent.
Returns the value of the Decimal as a Number.
Calculates the hash code for this decimal;
multiply(value : Number) : Decimal
Multiples the specified Number value with this Decimal and returns the new Decimal.
multiply(value : Decimal) : Decimal
Multiples the specified Decimal value with this Decimal and returns the new Decimal.
Returns a new Decimal with the negated value of this Decimal.
round(decimals : Number) : Decimal
Rounds the current value of the decimal using the specified number of decimals.
subtract(value : Number) : Decimal
Subtracts the specified Number value from this Decimal and returns the new Decimal.
subtract(value : Decimal) : Decimal
Subtracts the specified Decimal value from this Decimal and returns the new Decimal.
subtractPercent(value : Number) : Decimal
Subtracts a percentage value from the current value of the decimal.
subtractPercent(value : Decimal) : Decimal
Subtracts a percentage value from the current value of the decimal.
Returns a string representation of this object.
The valueOf() method is called by the ECMAScript interpret to return the "natural" value of an object.
Methods inherited from class 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
Constructor Detail
Decimal
publicDecimal()
Constructs a new Decimal with the value 0.
Decimal
publicDecimal(value : Number)
Constructs a new decimal using the specified Number value.
Parameters:
value - the value to use.
Decimal
publicDecimal(value : BigInt)
Constructs a new decimal using the specified BigInt value.
API Versioned:
From version 22.7.
Parameters:
value - the value to use.
Decimal
publicDecimal(value : String)
Constructs a new Decimal using the specified string representation of a number.
Parameters:
value - the value to use.
Method Detail
abs
abs() : Decimal
Returns a new Decimal with the absolute value of this Decimal.
Returns:
the new Decimal
add
Adds a Number value to this Decimal and returns the new Decimal.
Parameters:
value - the value to add to this decimal.
Returns:
the new decimal with the value added.
add
add(value : Decimal) : Decimal
Adds a Decimal value to this Decimal and returns the new Decimal.
Parameters:
value - the value to add to this decimal.
Returns:
the new decimal with the value added.
addPercent
addPercent(value : Number) : Decimal
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:
value - the value to add.
Returns:
a new decimal with the added percentage value.
addPercent
addPercent(value : Decimal) : Decimal
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:
value - the value to add.
Returns:
a new decimal with the added percentage value.
divide
divide(value : Number) : Decimal
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:
value - the value to use to divide this decimal.
Returns:
the new decimal.
divide
divide(value : Decimal) : Decimal
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:
value - the value to use to divide this decimal.
Returns:
the new decimal.
equals
equals(other : Object) : boolean
Compares two decimal values whether they are equivalent.
Parameters:
other - the object to comapre against this decimal.
get
get() : Number
Returns the value of the Decimal as a Number.
Returns:
the value of the Decimal.
hashCode
hashCode() : Number
Calculates the hash code for this decimal;
multiply
multiply(value : Number) : Decimal
Multiples the specified Number value with this Decimal and returns the new Decimal.
Parameters:
value - the value to multiply with this decimal.
Returns:
the new decimal.
multiply
multiply(value : Decimal) : Decimal
Multiples the specified Decimal value with this Decimal and returns the new Decimal.
Parameters:
value - the value to multiply with this decimal.
Returns:
the new decimal.
negate
negate() : Decimal
Returns a new Decimal with the negated value of this Decimal.
Returns:
the new Decimal
round
round(decimals : Number) : Decimal
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:
decimals - the number of decimals to use.
Returns:
the decimal that has been rounded.
subtract
subtract(value : Number) : Decimal
Subtracts the specified Number value from this Decimal and returns the new Decimal.
Parameters:
value - the value to add to this decimal.
Returns:
the new decimal with the value subtraced.
subtract
subtract(value : Decimal) : Decimal
Subtracts the specified Decimal value from this Decimal and returns the new Decimal.
Parameters:
value - the value to add to this decimal.
Returns:
the new decimal with the value subtraced.
subtractPercent
subtractPercent(value : Number) : Decimal
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:
value - the value to subtract.
Returns:
a new decimal with the subtracted percentage value.
subtractPercent
subtractPercent(value : Decimal) : Decimal
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:
value - the value to subtract.
Returns:
a new decimal with the subtracted percentage value.
toString
toString() : String
Returns a string representation of this object.
Returns:
a string representation of this object.
valueOf
valueOf() : Object
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:
the value of this object.