org.HdrHistogram.packedarray

Class PackedLongArray

java.lang.Object

org.HdrHistogram.packedarray.PackedLongArray

All Implemented Interfaces:

Serializable, Iterable<Long>

Direct Known Subclasses:

ConcurrentPackedLongArray

public class PackedLongArray
extends Object

A Packed array of signed 64 bit values, and supports get(), set(), add() and increment() operations on the logical contents of the array.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PackedLongArray(int virtualLength)
PackedLongArray(int virtualLength, int initialPhysicalLength)

Method Summary

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
PackedLongArray	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

PackedLongArray

public PackedLongArray(int virtualLength)

PackedLongArray

public PackedLongArray(int virtualLength,
                       int initialPhysicalLength)

Method Detail

setVirtualLength

public void setVirtualLength(int newVirtualArrayLength)

Set a new virtual length for the array.

Parameters:

newVirtualArrayLength - the

copy

public PackedLongArray copy()

Create a copy of this array, complete with data and everything.

Returns:

A distinct copy of this array.

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.

toString

public String toString()

Overrides:

toString in class Object

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

clear

public void clear()

Clear the array contents

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