AtomicDouble (Mines Java Toolkit)

java.lang.Object
- java.lang.Number
- - edu.mines.jtk.util.AtomicDouble

All Implemented Interfaces:

java.io.Serializable
```
public class AtomicDouble
extends java.lang.Number
implements java.io.Serializable
```
A double value that may be updated atomically. An atomic double works like an atomic integer. (See AtomicInteger.) For example, an atomic double might be used for parallel computation of the dot product of two vectors of doubles.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`AtomicDouble()` Constructs an atomic double with initial value zero.
`AtomicDouble(double value)` Constructs an atomic double with specified initial value.

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`addAndGet(double delta)` Atomically adds a specified value to the value of this double.
`boolean`	`compareAndSet(double expect, double update)` Atomically sets this double to the specified updated value if the current value equals the specified expected value.
`double`	`decrementAndGet()` Atomically decrements by one the value of this double.
`double`	`doubleValue()`
`float`	`floatValue()`
`double`	`get()` Gets the current value of this double.
`double`	`getAndAdd(double delta)` Atomically adds a specified value to the value of this double.
`double`	`getAndDecrement()` Atomically decrements by one the value of this double.
`double`	`getAndIncrement()` Atomically increments by one the value of this double.
`double`	`getAndSet(double value)` Atomically sets the value of this double and returns its old value.
`double`	`incrementAndGet()` Atomically increments by one the value of this double.
`int`	`intValue()`
`long`	`longValue()`
`void`	`set(double value)` Sets the value of this double.
`java.lang.String`	`toString()`
`boolean`	`weakCompareAndSet(double expect, double update)` Atomically sets this double to the specified updated value if the current value equals the specified expected value.

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AtomicDouble
```
public AtomicDouble()
```
    Constructs an atomic double with initial value zero.
  - AtomicDouble
```
public AtomicDouble(double value)
```
    Constructs an atomic double with specified initial value.
    
    Parameters:
    value - the initial value.
- Method Detail
  - get
```
public final double get()
```
    Gets the current value of this double.
    
    Returns:
    the current value.
  - set
```
public final void set(double value)
```
    Sets the value of this double.
    
    Parameters:
    value - the new value.
  - getAndSet
```
public final double getAndSet(double value)
```
    Atomically sets the value of this double and returns its old value.
    
    Parameters:
    value - the new value.
    
    Returns:
    the old value.
  - compareAndSet
```
public final boolean compareAndSet(double expect,
                    double update)
```
    Atomically sets this double to the specified updated value if the current value equals the specified expected value.
    
    Parameters:
    expect - the expected value.
    update - the updated value.
    
    Returns:
    true, if successfully set; false, if the current value was not equal to the expected value.
  - weakCompareAndSet
```
public final boolean weakCompareAndSet(double expect,
                        double update)
```
    Atomically sets this double to the specified updated value if the current value equals the specified expected value.
    My fail spuriously, and does not provide ordering guarantees, so is only rarely useful.
    
    Parameters:
    expect - the expected value.
    update - the updated value.
    
    Returns:
    true, if successfully set; false, if the current value was not equal to the expected value.
  - getAndIncrement
```
public final double getAndIncrement()
```
    Atomically increments by one the value of this double.
    
    Returns:
    the previous value of this double.
  - getAndDecrement
```
public final double getAndDecrement()
```
    Atomically decrements by one the value of this double.
    
    Returns:
    the previous value of this double.
  - getAndAdd
```
public final double getAndAdd(double delta)
```
    Atomically adds a specified value to the value of this double.
    
    Parameters:
    delta - the value to add.
    
    Returns:
    the previous value of this double.
  - incrementAndGet
```
public final double incrementAndGet()
```
    Atomically increments by one the value of this double.
    
    Returns:
    the updated value of this double.
  - decrementAndGet
```
public final double decrementAndGet()
```
    Atomically decrements by one the value of this double.
    
    Returns:
    the updated value of this double.
  - addAndGet
```
public final double addAndGet(double delta)
```
    Atomically adds a specified value to the value of this double.
    
    Parameters:
    delta - the value to add.
    
    Returns:
    the updated value of this double.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - intValue
```
public int intValue()
```
    Specified by:
    
    intValue in class java.lang.Number
  - longValue
```
public long longValue()
```
    Specified by:
    
    longValue in class java.lang.Number
  - floatValue
```
public float floatValue()
```
    Specified by:
    
    floatValue in class java.lang.Number
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in class java.lang.Number

Class AtomicDouble

Constructor Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Constructor Detail

AtomicDouble

AtomicDouble

Method Detail

get

set

getAndSet

compareAndSet

weakCompareAndSet

getAndIncrement

getAndDecrement

getAndAdd

incrementAndGet

decrementAndGet

addAndGet

toString

intValue

longValue

floatValue

doubleValue