Package com.landawn.abacus.util
Class MutableDouble
java.lang.Object
java.lang.Number
com.landawn.abacus.util.MutableDouble
- All Implemented Interfaces:
Mutable
,Serializable
,Comparable<MutableDouble>
Note: it's copied from Apache Commons Lang developed at The Apache Software Foundation (http://www.apache.org/), or under the Apache License 2.0. The methods copied from other products/frameworks may be modified in this class.
A mutabledouble
wrapper.
Note that as MutableDouble does not extend Double, it is not treated by String.format as a Double parameter.
MutableDouble
is NOT thread-safe.
- Since:
- 2.1
- Version:
- $Id: MutableDouble.java 1669791 2015-03-28 15:22:59Z britter $
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(double operand) Adds a value to the value of this instance.double
addAndGet
(double delta) Adds the given value to the current value.int
compareTo
(MutableDouble other) Compares this mutable to another in ascending order.void
Decrements the value.double
Decrements by one the current value.double
Returns the value of this MutableDouble as a double.boolean
Compares this object against the specified object.float
Returns the value of this MutableDouble as a float.double
getAndAdd
(double delta) Adds the given value to the current value.double
Decrements by one the current value.double
Increments by one the current value.double
getAndSet
(double value) Gets the and set.double
getValue()
Deprecated.int
hashCode()
Returns a suitable hash code for this mutable.void
Increments the value.double
Increments by one the current value.int
intValue()
Returns the value of this MutableDouble as an int.boolean
Checks whether the double value is infinite.boolean
isNaN()
Checks whether the double value is the special NaN value.long
Returns the value of this MutableDouble as a long.static MutableDouble
of
(double value) double
setAndGet
(double value) Sets the and get.<E extends Exception>
booleansetIf
(double newValue, Throwables.DoublePredicate<E> predicate) Set with the specified new value and returnstrue
ifpredicate
returns true.void
setValue
(double value) Sets the value.void
subtract
(double operand) Subtracts a value from the value of this instance.toString()
Returns the String value of this mutable.double
value()
Methods inherited from class java.lang.Number
byteValue, shortValue
-
Method Details
-
of
- Parameters:
value
-- Returns:
-
value
public double value() -
getValue
Deprecated.replace byvalue()
.Gets the value as a Double instance.- Returns:
-
setValue
public void setValue(double value) Sets the value.- Parameters:
value
- the value to set
-
getAndSet
public double getAndSet(double value) Gets the and set.- Parameters:
value
-- Returns:
-
setAndGet
public double setAndGet(double value) Sets the and get.- Parameters:
value
-- Returns:
-
setIf
public <E extends Exception> boolean setIf(double newValue, Throwables.DoublePredicate<E> predicate) throws E Set with the specified new value and returnstrue
ifpredicate
returns true. Otherwise just returnfalse
without setting the value to new value.- Type Parameters:
E
-- Parameters:
newValue
-predicate
- - test the current value.- Returns:
- Throws:
E
- the e
-
isNaN
public boolean isNaN()Checks whether the double value is the special NaN value.- Returns:
- true if NaN
-
isInfinite
public boolean isInfinite()Checks whether the double value is infinite.- Returns:
- true if infinite
-
increment
public void increment()Increments the value.- Since:
- Commons Lang 2.2
-
decrement
public void decrement()Decrements the value.- Since:
- Commons Lang 2.2
-
add
public void add(double operand) Adds a value to the value of this instance.- Parameters:
operand
- the value to add- Since:
- Commons Lang 2.2
-
subtract
public void subtract(double operand) Subtracts a value from the value of this instance.- Parameters:
operand
- the value to subtract, not null- Since:
- Commons Lang 2.2
-
getAndIncrement
public double getAndIncrement()Increments by one the current value.- Returns:
-
getAndDecrement
public double getAndDecrement()Decrements by one the current value.- Returns:
-
incrementAndGet
public double incrementAndGet()Increments by one the current value.- Returns:
-
decrementAndGet
public double decrementAndGet()Decrements by one the current value.- Returns:
-
getAndAdd
public double getAndAdd(double delta) Adds the given value to the current value.- Parameters:
delta
- the value to add- Returns:
-
addAndGet
public double addAndGet(double delta) Adds the given value to the current value.- Parameters:
delta
- the value to add- Returns:
-
intValue
public int intValue()Returns the value of this MutableDouble as an int. -
longValue
public long longValue()Returns the value of this MutableDouble as a long. -
floatValue
public float floatValue()Returns the value of this MutableDouble as a float.- Specified by:
floatValue
in classNumber
- Returns:
-
doubleValue
public double doubleValue()Returns the value of this MutableDouble as a double.- Specified by:
doubleValue
in classNumber
- Returns:
-
compareTo
Compares this mutable to another in ascending order.- Specified by:
compareTo
in interfaceComparable<MutableDouble>
- Parameters:
other
- the other mutable to compare to, not null- Returns:
- negative if this is less, zero if equal, positive if greater
-
equals
Compares this object against the specified object. The result istrue
if and only if the argument is notnull
and is aDouble
object that represents a double that has the identical bit pattern to the bit pattern of the double represented by this object. For this purpose, twodouble
values are considered to be the same if and only if the methodDouble.doubleToLongBits(double)
returns the same long value when applied to each.Note that in most cases, for two instances of class
Double
,d1
andd2
, the value ofd1.equals(d2)
istrue
if and only ifd1.doubleValue() == d2.doubleValue()
also has the value
true
. However, there are two exceptions:- If
d1
andd2
both representDouble.NaN
, then theequals
method returnstrue
, even thoughDouble.NaN==Double.NaN
has the valuefalse
. - If
d1
represents+0.0
whiled2
represents-0.0
, or vice versa, theequal
test has the valuefalse
, even though+0.0==-0.0
has the valuetrue
. This allows hashtables to operate properly.
- If
-
hashCode
public int hashCode()Returns a suitable hash code for this mutable. -
toString
Returns the String value of this mutable.
-
value()
.