ConcurrentPackedLongArray (HdrHistogram 2.1.12 API)

java.lang.Object
- org.HdrHistogram.packedarray.PackedLongArray
- - org.HdrHistogram.packedarray.ConcurrentPackedLongArray

All Implemented Interfaces:

Serializable, Iterable<Long>
```
public class ConcurrentPackedLongArray
extends PackedLongArray
```
A Packed array of signed 64 bit values that supports get(), set(), add() and increment() operations the logical contents of the array.
ConcurrentPackedLongArray supports concurrent accumulation, with the add() and increment() methods providing lossless atomic accumulation in the presence of multiple writers. However, it is impotant to note that add() and increment() are the *only* safe concurrent operations, and that all other operations, including get(), set() and clear() may produce "suprising" results if used on an array that is not at rest. While the add() and increment() methods are not quite wait-free, they come "close" that behvaior in the sense that a given thread will incur a total of no more than a capped fixed number (e.g. 74 in a current implementation) of non-wait-free add or increment operations during the lifetime of an array, regradless of the number of operations done.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConcurrentPackedLongArray(int virtualLength)

ConcurrentPackedLongArray(int virtualLength, int initialPhysicalLength)

Constructors
Constructor and Description
`ConcurrentPackedLongArray(int virtualLength)`
`ConcurrentPackedLongArray(int virtualLength, int initialPhysicalLength)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(org.HdrHistogram.packedarray.AbstractPackedLongArray other)` Add the contents of the other array to this one
`void`	`add(int index, long value)` Add to a value at a virtual index in the array
`void`	`clear()` Clear the array contents
`ConcurrentPackedLongArray`	`copy()` Create a copy of this array, complete with data and everything.
`boolean`	`equals(Object other)` Determine if this array is equivalent to another.
`long`	`get(int index)` Get value at virtual index in the array
`long`	`getEndTimeStamp()` get the end time stamp [optionally] stored with this array
`int`	`getPhysicalLength()` Get the current physical length (in longs) of the array's backing storage
`long`	`getStartTimeStamp()` get the start time stamp [optionally] stored with this array
`int`	`hashCode()`
`void`	`increment(int index)` Increment value at a virrual index in the array
`Iterator<Long>`	`iterator()` An Iterator over all values in the array
`int`	`length()` Get the (virtual) length of the array
`Iterable<IterationValue>`	`nonZeroValues()` An Iterator over all non-Zero values in the array
`void`	`set(int index, long value)` Set the value at a virtual index in the array
`void`	`setEndTimeStamp(long timeStampMsec)` Set the end time stamp value associated with this array to a given value.
`void`	`setStartTimeStamp(long timeStampMsec)` Set the start time stamp value associated with this array to a given value.
`void`	`setVirtualLength(int newVirtualArrayLength)` Set a new virtual length for the array.
`String`	`toString()`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - ConcurrentPackedLongArray
```
public ConcurrentPackedLongArray(int virtualLength)
```
  - ConcurrentPackedLongArray
```
public ConcurrentPackedLongArray(int virtualLength,
                                 int initialPhysicalLength)
```
- Method Detail
  - setVirtualLength
```
public void setVirtualLength(int newVirtualArrayLength)
```
    Set a new virtual length for the array.
    
    Overrides:
    
    setVirtualLength in class PackedLongArray
    
    Parameters:
    
    newVirtualArrayLength - the
  - copy
```
public ConcurrentPackedLongArray copy()
```
    Create a copy of this array, complete with data and everything.
    
    Overrides:
    
    copy in class PackedLongArray
    
    Returns:
    
    A distinct copy of this array.
  - toString
```
public String toString()
```
  - clear
```
public void clear()
```
    Clear the array contents
  - getStartTimeStamp
```
public long getStartTimeStamp()
```
    get the start time stamp [optionally] stored with this array
    
    Returns:
    
    the start time stamp [optionally] stored with this array
  - setStartTimeStamp
```
public void setStartTimeStamp(long timeStampMsec)
```
    Set the start time stamp value associated with this array to a given value.
    
    Parameters:
    
    timeStampMsec - the value to set the time stamp to, [by convention] in msec since the epoch.
  - getEndTimeStamp
```
public long getEndTimeStamp()
```
    get the end time stamp [optionally] stored with this array
    
    Returns:
    
    the end time stamp [optionally] stored with this array
  - setEndTimeStamp
```
public void setEndTimeStamp(long timeStampMsec)
```
    Set the end time stamp value associated with this array to a given value.
    
    Parameters:
    
    timeStampMsec - the value to set the time stamp to, [by convention] in msec since the epoch.
  - get
```
public long get(int index)
```
    Get value at virtual index in the array
    
    Parameters:
    
    index - the virtual array index
    
    Returns:
    
    the array value at the virtual index given
  - increment
```
public void increment(int index)
```
    Increment value at a virrual index in the array
    
    Parameters:
    
    index - virtual index of value to increment
  - add
```
public void add(int index,
                long value)
```
    Add to a value at a virtual index in the array
    
    Parameters:
    
    index - the virtual index of the value to be added to
    
    value - the value to add
  - set
```
public void set(int index,
                long value)
```
    Set the value at a virtual index in the array
    
    Parameters:
    
    index - the virtual index of the value to set
    
    value - the value to set
  - add
```
public void add(org.HdrHistogram.packedarray.AbstractPackedLongArray other)
```
    Add the contents of the other array to this one
    
    Parameters:
    
    other - The to add to this array
  - getPhysicalLength
```
public int getPhysicalLength()
```
    Get the current physical length (in longs) of the array's backing storage
    
    Returns:
    
    the current physical length (in longs) of the array's current backing storage
  - length
```
public int length()
```
    Get the (virtual) length of the array
    
    Returns:
    
    the (virtual) length of the array
  - iterator
```
public Iterator<Long> iterator()
```
    An Iterator over all values in the array
    
    Specified by:
    
    iterator in interface Iterable<Long>
    
    Returns:
    
    an Iterator over all values in the array
  - nonZeroValues
```
public Iterable<IterationValue> nonZeroValues()
```
    An Iterator over all non-Zero values in the array
    
    Returns:
    
    an Iterator over all non-Zero values in the array
  - equals
```
public boolean equals(Object other)
```
    Determine if this array is equivalent to another.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - the other array to compare to
    
    Returns:
    
    True if this array are equivalent with the other.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ConcurrentPackedLongArray

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

ConcurrentPackedLongArray

ConcurrentPackedLongArray

Method Detail

setVirtualLength

copy

toString

clear

getStartTimeStamp

setStartTimeStamp

getEndTimeStamp

setEndTimeStamp

get

increment

add

set

add

getPhysicalLength

length

iterator

nonZeroValues

equals

hashCode