public final class MutableDecimal0f extends AbstractMutableDecimal<Scale0f,MutableDecimal0f> implements Cloneable
All methods for this class throw NullPointerException
when passed a
null
object reference for any input parameter.
Constructor and Description |
---|
MutableDecimal0f()
Constructs a new
MutableDecimal0f with value zero. |
MutableDecimal0f(BigDecimal value)
Constructs a
MutableDecimal0f whose value is calculated by
rounding the specified BigDecimal argument to scale 0 using
HALF_UP rounding. |
MutableDecimal0f(BigInteger value)
Constructs a
MutableDecimal0f whose value is numerically equal to
that of the specified BigInteger value. |
MutableDecimal0f(Decimal<?> value)
|
MutableDecimal0f(Decimal0f value)
Constructs a
MutableDecimal0f whose value is numerically equal to
that of the specified Decimal0f value. |
MutableDecimal0f(double value)
Constructs a
MutableDecimal0f whose value is calculated by
rounding the specified double argument to scale 0 using
HALF_UP rounding. |
MutableDecimal0f(long value)
Constructs a
MutableDecimal0f whose value is numerically equal
to that of the specified long value. |
MutableDecimal0f(String value)
Translates the string representation of a
Decimal into a
MutableDecimal0f . |
Modifier and Type | Method and Description |
---|---|
static MutableDecimal0f |
billion()
Returns a new
MutableDecimal0f whose value is equal to one billion. |
MutableDecimal0f |
clone()
Returns a clone of this mutable Decimal numerically identical to this
value.
|
protected MutableDecimal0f |
create(long unscaled)
Returns a new
Decimal whose value is
(unscaled × 10-scale). |
protected MutableDecimal0f[] |
createArray(int length)
Returns a new
Decimal array of the specified length . |
static MutableDecimal0f |
eight()
Returns a new
MutableDecimal0f whose value is equal to eight. |
static MutableDecimal0f |
five()
Returns a new
MutableDecimal0f whose value is equal to five. |
static MutableDecimal0f |
four()
Returns a new
MutableDecimal0f whose value is equal to four. |
protected DecimalArithmetic |
getDefaultArithmetic()
Returns the default arithmetic performing unchecked operations with
rounding mode
HALF_UP . |
protected DecimalArithmetic |
getDefaultCheckedArithmetic()
Returns the default arithmetic performing checked operations with
rounding mode
HALF_UP . |
Factory0f |
getFactory()
Returns the factory that can be used to create other Decimal values of the same scale as
this Decimal. |
protected DecimalArithmetic |
getRoundingDownArithmetic()
Returns the arithmetic performing unchecked operations with rounding mode
DOWN . |
protected DecimalArithmetic |
getRoundingFloorArithmetic()
Returns the arithmetic performing unchecked operations with rounding mode
FLOOR . |
protected DecimalArithmetic |
getRoundingHalfEvenArithmetic()
Returns the arithmetic performing unchecked operations with rounding mode
HALF_EVEN . |
protected DecimalArithmetic |
getRoundingUnnecessaryArithmetic()
Returns the arithmetic performing unchecked operations with rounding mode
UNNECESSARY . |
int |
getScale()
Returns the scale associated with this Decimal.
|
Scale0f |
getScaleMetrics()
Returns the metrics associated with the scale of this Decimal.
|
static MutableDecimal0f |
hundred()
Returns a new
MutableDecimal0f whose value is equal to one hundred. |
static MutableDecimal0f |
million()
Returns a new
MutableDecimal0f whose value is equal to one million. |
static MutableDecimal0f |
minusOne()
Returns a new
MutableDecimal0f whose value is equal to minus one. |
Multipliable0f |
multiplyExact()
Returns this
Decimal as a multipliable factor for exact
typed exact multiplication. |
static MutableDecimal0f |
nine()
Returns a new
MutableDecimal0f whose value is equal to nine. |
static MutableDecimal0f |
one()
Returns a new
MutableDecimal0f whose value is equal to one. |
static MutableDecimal0f |
quadrillion()
Returns a new
MutableDecimal0f whose value is equal to one quadrillion. |
static MutableDecimal0f |
quintillion()
Returns a new
MutableDecimal0f whose value is equal to one quintillion. |
protected MutableDecimal0f |
self()
Returns
this decimal value as concrete implementation subtype. |
static MutableDecimal0f |
seven()
Returns a new
MutableDecimal0f whose value is equal to seven. |
static MutableDecimal0f |
six()
Returns a new
MutableDecimal0f whose value is equal to six. |
static MutableDecimal0f |
ten()
Returns a new
MutableDecimal0f whose value is equal to ten. |
static MutableDecimal0f |
thousand()
Returns a new
MutableDecimal0f whose value is equal to one thousand. |
static MutableDecimal0f |
three()
Returns a new
MutableDecimal0f whose value is equal to three. |
Decimal0f |
toImmutableDecimal()
If this
Decimal value is already an ImmutableDecimal it is simply returned. |
MutableDecimal0f |
toMutableDecimal()
If this
Decimal value is already a MutableDecimal it is simply returned. |
static MutableDecimal0f |
trillion()
Returns a new
MutableDecimal0f whose value is equal to one trillion. |
static MutableDecimal0f |
two()
Returns a new
MutableDecimal0f whose value is equal to two. |
static MutableDecimal0f |
ulp()
Returns a new
MutableDecimal0f whose value is equal to one ULP. |
static MutableDecimal0f |
unscaled(long unscaledValue)
Returns a new
MutableDecimal0f whose value is equal to
unscaledValue * 10-0 . |
static MutableDecimal0f |
zero()
Returns a new
MutableDecimal0f whose value is equal to zero. |
createOrAssign, max, min, multiplyExact, scale, scale, scale, scale, set, set, set, set, set, set, set, set, set, set, set, set, setMinusOne, setOne, setUlp, setUnscaled, setUnscaled, setUnscaled, setZero, unscaledValue
abs, abs, add, add, add, add, add, add, add, add, addSquared, addSquared, addSquared, addUnscaled, addUnscaled, addUnscaled, addUnscaled, addUnscaled, avg, avg, byteValueExact, compareTo, compareToNumerically, divide, divide, divide, divide, divide, divide, divide, divide, divideAndRemainder, divideAndRemainder, divideBy, divideBy, divideBy, divideByPowerOfTen, divideByPowerOfTen, divideByPowerOfTen, divideExact, divideToIntegralValue, divideToIntegralValue, divideToLongValue, divideToLongValue, divideTruncate, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, doubleValue, doubleValue, equals, floatValue, floatValue, fractionalPart, getArithmeticFor, getArithmeticFor, getArithmeticFor, getCheckedArithmeticFor, hashCode, integralPart, intValue, intValueExact, invert, invert, invert, isBetweenZeroAndMinusOne, isBetweenZeroAndOne, isEqualTo, isEqualToNumerically, isGreaterThan, isGreaterThanOrEqualTo, isIntegral, isIntegralPartZero, isLessThan, isLessThanOrEqualTo, isMinusOne, isNegative, isNonNegative, isNonPositive, isOne, isPositive, isUlp, isZero, longValue, longValue, longValueExact, max, max, min, min, multiply, multiply, multiply, multiply, multiply, multiply, multiply, multiplyBy, multiplyBy, multiplyBy, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, negate, negate, pow, pow, pow, remainder, round, round, round, shiftLeft, shiftLeft, shiftLeft, shiftRight, shiftRight, shiftRight, shortValueExact, signum, sqrt, sqrt, square, square, square, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtractSquared, subtractSquared, subtractSquared, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled, toBigDecimal, toBigDecimal, toBigInteger, toBigInteger, toBigIntegerExact, toString
byteValue, shortValue
finalize, getClass, notify, notifyAll, wait, wait, wait
abs, abs, add, add, add, add, add, add, add, add, addSquared, addSquared, addSquared, addUnscaled, addUnscaled, addUnscaled, addUnscaled, addUnscaled, avg, avg, divide, divide, divide, divide, divide, divide, divide, divide, divideAndRemainder, divideAndRemainder, divideBy, divideBy, divideBy, divideByPowerOfTen, divideByPowerOfTen, divideByPowerOfTen, divideExact, divideToIntegralValue, divideToIntegralValue, divideTruncate, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, fractionalPart, integralPart, invert, invert, invert, multiply, multiply, multiply, multiply, multiply, multiply, multiply, multiplyBy, multiplyBy, multiplyBy, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, negate, negate, pow, pow, pow, remainder, round, round, round, shiftLeft, shiftLeft, shiftLeft, shiftRight, shiftRight, shiftRight, sqrt, sqrt, square, square, square, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtractSquared, subtractSquared, subtractSquared, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled
byteValue, byteValueExact, compareTo, compareToNumerically, divideToLongValue, divideToLongValue, doubleValue, doubleValue, equals, floatValue, floatValue, hashCode, intValue, intValueExact, isBetweenZeroAndMinusOne, isBetweenZeroAndOne, isEqualTo, isEqualToNumerically, isGreaterThan, isGreaterThanOrEqualTo, isIntegral, isIntegralPartZero, isLessThan, isLessThanOrEqualTo, isMinusOne, isNegative, isNonNegative, isNonPositive, isOne, isPositive, isUlp, isZero, longValue, longValue, longValueExact, max, min, shortValue, shortValueExact, signum, toBigDecimal, toBigDecimal, toBigInteger, toBigInteger, toBigIntegerExact, toString
public MutableDecimal0f()
MutableDecimal0f
with value zero.zero()
public MutableDecimal0f(String value)
Decimal
into a
MutableDecimal0f
. The string representation consists
of an optional sign, '+'
or '-'
, followed by a sequence
of zero or more decimal digits ("the integer"), optionally followed by a
fraction.
The fraction consists of a decimal point followed by zero or more decimal
digits. The string must contain at least one digit in either the integer
or the fraction. If the fraction contains more than 0 digits, the
value is rounded using HALF_UP
rounding. An
exception is thrown if the value is too large to be represented as a
MutableDecimal0f
.
value
- String value to convert into a MutableDecimal0f
NumberFormatException
- if value
does not represent a valid Decimal
or if the value is too large to be represented as a
MutableDecimal0f
AbstractMutableDecimal.set(String, RoundingMode)
public MutableDecimal0f(long value)
MutableDecimal0f
whose value is numerically equal
to that of the specified long
value. An exception is thrown if the
specified value is too large to be represented as a MutableDecimal0f
.value
- long value to convert into a MutableDecimal0f
IllegalArgumentException
- if value
is too large to be represented as a
MutableDecimal0f
public MutableDecimal0f(double value)
MutableDecimal0f
whose value is calculated by
rounding the specified double
argument to scale 0 using
HALF_UP
rounding. An exception is thrown if the
specified value is too large to be represented as a MutableDecimal0f
.value
- double value to convert into a MutableDecimal0f
IllegalArgumentException
- if value
is NaN or infinite or if the magnitude is too large
for the double to be represented as a MutableDecimal0f
AbstractMutableDecimal.set(double, RoundingMode)
,
AbstractMutableDecimal.set(float)
,
AbstractMutableDecimal.set(float, RoundingMode)
public MutableDecimal0f(BigInteger value)
MutableDecimal0f
whose value is numerically equal to
that of the specified BigInteger
value. An exception is thrown if the
specified value is too large to be represented as a MutableDecimal0f
.value
- BigInteger
value to convert into a MutableDecimal0f
IllegalArgumentException
- if value
is too large to be represented as a MutableDecimal0f
public MutableDecimal0f(BigDecimal value)
MutableDecimal0f
whose value is calculated by
rounding the specified BigDecimal
argument to scale 0 using
HALF_UP
rounding. An exception is thrown if the
specified value is too large to be represented as a MutableDecimal0f
.value
- BigDecimal
value to convert into a MutableDecimal0f
IllegalArgumentException
- if value
is too large to be represented as a MutableDecimal0f
AbstractMutableDecimal.set(BigDecimal, RoundingMode)
public MutableDecimal0f(Decimal0f value)
MutableDecimal0f
whose value is numerically equal to
that of the specified Decimal0f
value.value
- Decimal0f
value to convert into a MutableDecimal0f
public MutableDecimal0f(Decimal<?> value)
MutableDecimal0f
whose value is calculated by
rounding the specified Decimal
argument to scale 0 using
HALF_UP
rounding. An exception is thrown if
the specified value is too large to be represented as a MutableDecimal0f
.value
- Decimal value to convert into a MutableDecimal0f
IllegalArgumentException
- if value
is too large to be represented as a MutableDecimal0f
AbstractMutableDecimal.set(Decimal, RoundingMode)
protected final MutableDecimal0f create(long unscaled)
AbstractDecimal
Decimal
whose value is
(unscaled × 10-scale).create
in class AbstractDecimal<Scale0f,MutableDecimal0f>
unscaled
- unscaled value to be returned as a Decimal
protected final MutableDecimal0f[] createArray(int length)
AbstractDecimal
Decimal
array of the specified length
.createArray
in class AbstractDecimal<Scale0f,MutableDecimal0f>
length
- the length of the array to returnnew D[length]
protected final MutableDecimal0f self()
AbstractDecimal
this
decimal value as concrete implementation subtype.self
in class AbstractDecimal<Scale0f,MutableDecimal0f>
this
public final Scale0f getScaleMetrics()
Decimal
long
value underlying this Decimal
.getScaleMetrics
in interface Decimal<Scale0f>
ScaleMetrics.getScale()
,
ScaleMetrics.getScaleFactor()
public final int getScale()
Decimal
long
value underlying this Decimal
.
If the scale is f
then the value represented by a Decimal
instance is
(unscaledValue × 10-f).
This method is a shortcut for getScaleMetrics().getScale()
.
getScale
in interface Decimal<Scale0f>
Decimal.getScaleMetrics()
,
ScaleMetrics.getScale()
,
Decimal.unscaledValue()
public Factory0f getFactory()
Decimal
this
Decimal.getFactory
in interface Decimal<Scale0f>
protected DecimalArithmetic getDefaultArithmetic()
AbstractDecimal
HALF_UP
.getDefaultArithmetic
in class AbstractDecimal<Scale0f,MutableDecimal0f>
HALF_UP
rounding and UNCHECKED
overflow
modeprotected DecimalArithmetic getDefaultCheckedArithmetic()
AbstractDecimal
HALF_UP
.getDefaultCheckedArithmetic
in class AbstractDecimal<Scale0f,MutableDecimal0f>
HALF_UP
rounding and CHECKED
overflow modeprotected DecimalArithmetic getRoundingDownArithmetic()
AbstractDecimal
DOWN
.getRoundingDownArithmetic
in class AbstractDecimal<Scale0f,MutableDecimal0f>
DOWN
rounding and
UNCHECKED
overflow modeprotected DecimalArithmetic getRoundingFloorArithmetic()
AbstractDecimal
FLOOR
.getRoundingFloorArithmetic
in class AbstractDecimal<Scale0f,MutableDecimal0f>
FLOOR
rounding and
UNCHECKED
overflow modeprotected DecimalArithmetic getRoundingHalfEvenArithmetic()
AbstractDecimal
HALF_EVEN
.getRoundingHalfEvenArithmetic
in class AbstractDecimal<Scale0f,MutableDecimal0f>
HALF_UP
rounding and
UNCHECKED
overflow modeprotected DecimalArithmetic getRoundingUnnecessaryArithmetic()
AbstractDecimal
UNNECESSARY
.getRoundingUnnecessaryArithmetic
in class AbstractDecimal<Scale0f,MutableDecimal0f>
UNNECESSARY
rounding and UNCHECKED
overflow
modepublic MutableDecimal0f clone()
MutableDecimal
clone
in interface MutableDecimal<Scale0f>
clone
in class AbstractMutableDecimal<Scale0f,MutableDecimal0f>
public static MutableDecimal0f unscaled(long unscaledValue)
MutableDecimal0f
whose value is equal to
unscaledValue * 10-0
.unscaledValue
- the unscaled decimal value to convertMutableDecimal0f
value initialised with unscaledValue * 10-0
AbstractMutableDecimal.setUnscaled(long, int)
,
AbstractMutableDecimal.setUnscaled(long, int, RoundingMode)
public static MutableDecimal0f zero()
MutableDecimal0f
whose value is equal to zero.MutableDecimal0f
value initialised with 0.public static MutableDecimal0f ulp()
MutableDecimal0f
whose value is equal to one ULP.MutableDecimal0f
value initialised with 10-0=1.public static MutableDecimal0f one()
MutableDecimal0f
whose value is equal to one.MutableDecimal0f
value initialised with 1.public static MutableDecimal0f two()
MutableDecimal0f
whose value is equal to two.MutableDecimal0f
value initialised with 2.public static MutableDecimal0f three()
MutableDecimal0f
whose value is equal to three.MutableDecimal0f
value initialised with 3.public static MutableDecimal0f four()
MutableDecimal0f
whose value is equal to four.MutableDecimal0f
value initialised with 4.public static MutableDecimal0f five()
MutableDecimal0f
whose value is equal to five.MutableDecimal0f
value initialised with 5.public static MutableDecimal0f six()
MutableDecimal0f
whose value is equal to six.MutableDecimal0f
value initialised with 6.public static MutableDecimal0f seven()
MutableDecimal0f
whose value is equal to seven.MutableDecimal0f
value initialised with 7.public static MutableDecimal0f eight()
MutableDecimal0f
whose value is equal to eight.MutableDecimal0f
value initialised with 8.public static MutableDecimal0f nine()
MutableDecimal0f
whose value is equal to nine.MutableDecimal0f
value initialised with 9.public static MutableDecimal0f ten()
MutableDecimal0f
whose value is equal to ten.MutableDecimal0f
value initialised with 10.public static MutableDecimal0f hundred()
MutableDecimal0f
whose value is equal to one hundred.MutableDecimal0f
value initialised with 100.public static MutableDecimal0f thousand()
MutableDecimal0f
whose value is equal to one thousand.MutableDecimal0f
value initialised with 1000.public static MutableDecimal0f million()
MutableDecimal0f
whose value is equal to one million.MutableDecimal0f
value initialised with 106.public static MutableDecimal0f billion()
MutableDecimal0f
whose value is equal to one billion.MutableDecimal0f
value initialised with 109.public static MutableDecimal0f trillion()
MutableDecimal0f
whose value is equal to one trillion.MutableDecimal0f
value initialised with 1012.public static MutableDecimal0f quadrillion()
MutableDecimal0f
whose value is equal to one quadrillion.MutableDecimal0f
value initialised with 1015.public static MutableDecimal0f quintillion()
MutableDecimal0f
whose value is equal to one quintillion.MutableDecimal0f
value initialised with 1018.public static MutableDecimal0f minusOne()
MutableDecimal0f
whose value is equal to minus one.MutableDecimal0f
value initialised with -1.public Multipliable0f multiplyExact()
Decimal
as a multipliable factor for exact
typed exact multiplication. The second factor is passed to one of
the by(..)
methods of the returned multiplier. The scale of
the result is the sum of the scales of this
Decimal and the
second factor passed to the by(..)
method.
The method is similar to multiplyExact(Decimal)
but the result
is retrieved in exact typed form with the correct result scale.
For instance one can write:
Decimal2f product = this.multiplyExact().by(Decimal2f.FIVE);
public Decimal0f toImmutableDecimal()
Decimal
Decimal
value is already an ImmutableDecimal
it is simply returned. Otherwise a new
immutable value with the same scale and numerical value as this
Decimal is created and returned.toImmutableDecimal
in interface Decimal<Scale0f>
this
if immutable and a new ImmutableDecimal
with the same scale and value as
this
Decimal otherwisepublic MutableDecimal0f toMutableDecimal()
Decimal
Decimal
value is already a MutableDecimal
it is simply returned. Otherwise a new mutable
value with the same scale and numerical value as this
Decimal is created and returned.toMutableDecimal
in interface Decimal<Scale0f>
this
if mutable and a new MutableDecimal
with the same scale and value as this
Decimal otherwise