Interface Decimal

A decimal floating point number. This class provides support for fixed and arbitrary precision numbers. Values are immutable and represented as unscaled * 10^(-scale). Methods without an explicit Rounding parameter use unlimitedPrecision (unless documented otherwise) except for plus(), minus(), times(), divided() and power() whose implicit rounding is subject to the rounding specified in implicitlyRounded().

See also implicitlyRounded()

no type hierarchy

Decimal
- Exponentiable
  - Numeric
    Invertible
    Summable
- Number
  - Comparable
  - Numeric
    Invertible
    Summable

no subtypes hierarchy

Attributes
`float`	Source Code`shared formal Float float` The number, represented as a `Float`. If the magnitude of this number is too large the result will be `infinity` or `-infinity`. If the result is finite, precision may still be lost.
`hash`	Source Code`shared formal Integer hash` The hash value of this `Decimal`. Due to the definition of `equals()` trailing zeros do not contribute to the hash calculation so `1` and `1.0` have the same `hash. Refines `Object.hash`
`implementation`	Source Code`shared formal Object?Go to Null abbreviations X? means Null\|X implementation` The platform-specific implementation object, if any. This is provided for interoperation with the runtime platform.
`integer`	Source Code`shared formal Integer integer` The number, represented as an `Integer`. If the number is too big to fit in an Integer then an Integer corresponding to the lower order bits is returned.
`precision`	Source Code`shared formal Integer precision` The precision of this decimal. This is the number of digits in the unscaled value. See also `scale`
`scale`	Source Code`shared formal Integer scale` The scale of this decimal. This is the number of digits to the right of the decimal point (for a positive scale) or the power of ten by which the unscaled value is multiplied (for a negative scale). See also `unscaled`
`unscaled`	Source Code`shared formal Whole unscaled` The unscaled value of this `Decimal`. See also `scale`
`whole`	Source Code`shared formal Whole whole` The number, represented as a `Whole`, after truncation of any fractional part. See also `Whole`

Inherited Attributes
Attributes inherited from: `Object` `hash`, `string`
Attributes inherited from: `Invertible<Other>` `negated`
Attributes inherited from: `Number<Other>` `absolute`, `fractionalPart`, `magnitude`, `negative`, `positive`, `sign`, `wholePart`

Methods
`divided`	Source Code `shared formal Decimal divided(Decimal other)` The quotient obtained by dividing this `Decimal` by the given `Decimal`. Unless invoked within `implicitlyRounded()` the preferred scale of the result is the difference between this `Decimal`'s scale and the given `Decimal`'s scale; it may be larger if necessary; an exception is thrown if the result would have a nonterminating decimal representation. See also `dividedRounded()` Refines `Numeric.divided`
`dividedAndRemainder`	Source Code `shared formal DividedWithRemainder dividedAndRemainder(Decimal other, Rounding?Go to Null abbreviations X? means Null\|X rounding = null)` A pair containing the same results as calling `dividedTruncated()` and `remainderRounded()` with the given arguments, except the division is only performed once. Parameters: `rounding = null` Throws `Exception` The given divisor is zero See also `dividedTruncated()`, `remainderRounded()`
`dividedRounded`	Source Code `shared formal Decimal dividedRounded(Decimal other, Rounding?Go to Null abbreviations X? means Null\|X rounding = null)` The quotient obtained by dividing this `Decimal` by the given `Decimal` with the given rounding. Parameters: `rounding = null` See also `divided()`
`dividedTruncated`	Source Code `shared formal Decimal dividedTruncated(Decimal other, Rounding?Go to Null abbreviations X? means Null\|X rounding = null)` The integer part of the quotient obtained by dividing this `Decimal` by the given `Decimal` and truncating the result. The scale of the result is the difference of the scales of the operands. Parameters: `rounding = null` Throws `Exception` The integer part of the quotient requires more than the given precision. `Exception` The given divisor is zero See also `dividedTruncated()`
`equals`	Source Code `shared formal Boolean equals(Object that)` Determine whether two instances have equal value.`equals()` considers `1` and `1.0` to be the same, `strictlyEquals()` considers them to be different. See also `strictlyEquals()` Refines `Object.equals`
`minus`	Source Code `shared formal Decimal minus(Decimal other)` The difference between this `Decimal` and the given `Decimal`. Unless invoked within `implicitlyRounded()` the scale of the result is the greater of the scales of the operands. See also `minusRounded()` Refines `Invertible.minus`
`minusRounded`	Source Code `shared formal Decimal minusRounded(Decimal other, Rounding?Go to Null abbreviations X? means Null\|X rounding = null)` The difference between this `Decimal` and the given `Decimal` with the given rounding. Parameters: `rounding = null` See also `minus()`
`plus`	Source Code `shared formal Decimal plus(Decimal other)` The sum of this `Decimal` and the given `Decimal`. Unless invoked within `implicitlyRounded()` the scale of the result is the greater of the scales of the operands. See also `plusRounded()` Refines `Summable.plus`
`plusRounded`	Source Code `shared formal Decimal plusRounded(Decimal other, Rounding?Go to Null abbreviations X? means Null\|X rounding = null)` The sum of this `Decimal` and the given `Decimal` with the given rounding. Parameters: `rounding = null` See also `plus()`
`power`	Source Code `shared formal Decimal power(Integer other)` The result of raising this number to the given power. Unless invoked within `implicitlyRounded()` the result is computed to unlimited precision and negative powers are not supported. Throws `Exception` The exponent has a non-zero fractional part `Exception` The exponent is too large or too small `Exception` The exponent was negative when attempting to compute a result to unlimited precision See also `powerRounded()` Refines `Exponentiable.power`
`powerRounded`	Source Code `shared formal Decimal powerRounded(Integer other, Rounding?Go to Null abbreviations X? means Null\|X rounding = null)` The result of raising this number to the given power with the given rounding. Fractional powers are not supported. Parameters: `rounding = null` See also `power()`
`remainderRounded`	Source Code `shared formal Decimal remainderRounded(Decimal other, Rounding?Go to Null abbreviations X? means Null\|X rounding = null)` The Decimal remainder after the division of this `Decimal` by the given `Decimal`, that is: `this - this.dividedTruncated(other, rounding) * other This is not equivalent to the `%` operator (`Decimal` does not satisfy `Integral`), and the result may be negative. Parameters: `rounding = null` Throws `Exception` The integer part of the quotient requires more than the given precision. `Exception` The given divisor is zero
`round`	Source Code `shared formal Decimal round(Rounding rounding)` This value rounded according to the given context.
`strictlyEquals`	Source Code `shared formal Boolean strictlyEquals(Decimal that)` Determine whether two instances have equal value and scale. `strictlyEquals()` considers `1` and `1.0` to be different, `equals()` considers them to be the same. See also `equals()`
`times`	Source Code `shared formal Decimal times(Decimal other)` The product of this `Decimal` and the given `Decimal`. Unless invoked within `implicitlyRounded()` the scale of the result is the sum of the scales of the operands. See also `timesRounded()` Refines `Numeric.times`
`timesRounded`	Source Code `shared formal Decimal timesRounded(Decimal other, Rounding?Go to Null abbreviations X? means Null\|X rounding = null)` The product of this `Decimal` and the given `Decimal` with the given rounding. Parameters: `rounding = null` See also `times()`

Inherited Methods
Methods inherited from: `Object` `equals()`
Methods inherited from: `Comparable<Other>` `compare()`, `largerThan()`, `notLargerThan()`, `notSmallerThan()`, `smallerThan()`
Methods inherited from: `Exponentiable<This,Other>` `power()`
Methods inherited from: `Invertible<Other>` `minus()`
Methods inherited from: `Number<Other>` `compare()`, `plusInteger()`, `powerOfInteger()`, `timesInteger()`
Methods inherited from: `Numeric<Other>` `divided()`, `times()`
Methods inherited from: `Summable<Other>` `plus()`

Keyboard Shortcuts

Documentation:

Search page:

Filter declarations by tags