DoubleAccumulator Class

Definition

Namespace:

Java.Util.Concurrent.Atomic

Assembly:

Mono.Android.dll

One or more variables that together maintain a running double value updated using a supplied function.

[Android.Runtime.Register("java/util/concurrent/atomic/DoubleAccumulator", ApiSince=24, DoNotGenerateAcw=true)]
public class DoubleAccumulator : Java.Lang.Number, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("java/util/concurrent/atomic/DoubleAccumulator", ApiSince=24, DoNotGenerateAcw=true)>]
type DoubleAccumulator = class
    inherit Number
    interface ISerializable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance

Object

Object

Number

DoubleAccumulator

Attributes

RegisterAttribute

Implements

IJavaObject IJavaPeerable ISerializable IDisposable

Remarks

One or more variables that together maintain a running double value updated using a supplied function. When updates (method #accumulate) are contended across threads, the set of variables may grow dynamically to reduce contention. Method #get (or, equivalently, #doubleValue) returns the current value across the variables maintaining updates.

This class is usually preferable to alternatives when multiple threads update a common value that is used for purposes such as summary statistics that are frequently updated but less frequently read.

The supplied accumulator function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. For predictable results, the accumulator function should be commutative and associative within the floating point tolerance required in usage contexts. The function is applied with an existing value (or identity) as one argument, and a given update as the other argument. For example, to maintain a running maximum value, you could supply Double::max along with Double.NEGATIVE_INFINITY as the identity. The order of accumulation within or across threads is not guaranteed. Thus, this class may not be applicable if numerical stability is required, especially when combining values of substantially different orders of magnitude.

Class DoubleAdder provides analogs of the functionality of this class for the common special case of maintaining sums. The call new DoubleAdder() is equivalent to new DoubleAccumulator((x, y) -> x + y, 0.0).

This class extends Number, but does <em>not</em> define methods such as equals, hashCode and compareTo because instances are expected to be mutated, and so are not useful as collection keys.

Added in 1.8.

Java documentation for java.util.concurrent.atomic.DoubleAccumulator.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

DoubleAccumulator(IDoubleBinaryOperator, Double)	Creates a new instance using the given accumulator function and identity element.
DoubleAccumulator(IntPtr, JniHandleOwnership)

Properties

Class	Returns the runtime class of this Object. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
ThenReset	Equivalent in effect to #get followed by #reset.
ThresholdClass
ThresholdType

Methods

Accumulate(Double)	Updates with the given value.
ByteValue()	Returns the value of the specified number as a byte. (Inherited from Number)
Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
DoubleValue()	Equivalent to #get.
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
FloatValue()	Returns the #get current value as a float after a narrowing primitive conversion.
Get()	Returns the current value.
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
IntValue()	Returns the #get current value as an int after a narrowing primitive conversion.
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
LongValue()	Returns the #get current value as a long after a narrowing primitive conversion.
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
Reset()	Resets variables maintaining updates to the identity value.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ShortValue()	Returns the value of the specified number as a short. (Inherited from Number)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)