de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike

Class DoubleArray

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.datastructures.arraylike.DoubleArray

All Implemented Interfaces:

ArrayAdapter<java.lang.Double,DoubleArray>, NumberArrayAdapter<java.lang.Double,DoubleArray>

public class DoubleArray
extends java.lang.Object
implements NumberArrayAdapter<java.lang.Double,DoubleArray>

Array of double values (primitive, avoiding the boxing overhead of ArrayList). This class is generated from a code template.

Since:

0.7.0

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
double[]	data (Reused) store for numerical attributes.
private static int	LAST_GROW_SIZE Last value where we can grow by 50%.
private static int	MAX_ARRAY_SIZE Maximum array size permitted by Java.
int	size Number of numerical attributes.

Constructor Summary

Constructors

Constructor and Description
DoubleArray() Constructor.
DoubleArray(DoubleArray existing) Constructor from an existing array.
DoubleArray(int initialsize) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(double attribute) Append a value.
void	clear() Reset the numeric attribute counter.
java.lang.Double	get(DoubleArray array, int off) Get the off'th item from the array.
double	get(int pos) Get the value at this position.
byte	getByte(DoubleArray array, int off) Get the off'th item from the array as byte.
double	getDouble(DoubleArray array, int off) Get the off'th item from the array as double.
float	getFloat(DoubleArray array, int off) Get the off'th item from the array as float.
int	getInteger(DoubleArray array, int off) Get the off'th item from the array as integer.
long	getLong(DoubleArray array, int off) Get the off'th item from the array as long.
short	getShort(DoubleArray array, int off) Get the off'th item from the array as short.
private void	grow() Grow the current array.
void	insert(int pos, double val) Insert a value at the given position.
boolean	isEmpty() Test if the array is empty.
void	remove(int start, int len) Remove a range from the array.
void	set(int pos, double value) Set the value at this position.
int	size() Get the size of the array.
int	size(DoubleArray array) Get the size of the array.
void	sort() Sort the contents.
double[]	toArray() Return a copy of the contents as array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_ARRAY_SIZE

private static final int MAX_ARRAY_SIZE

Maximum array size permitted by Java. This is JVM dependent, but 2^31 - 5 is the usual OpenJDK8 value.

See Also:

Constant Field Values

LAST_GROW_SIZE

private static final int LAST_GROW_SIZE

Last value where we can grow by 50%.

See Also:

Constant Field Values

data

public double[] data

(Reused) store for numerical attributes.

size

public int size

Number of numerical attributes.

Constructor Detail

DoubleArray

public DoubleArray()

Constructor.

DoubleArray

public DoubleArray(int initialsize)

Constructor.

Parameters:

initialsize - Initial size.

DoubleArray

public DoubleArray(DoubleArray existing)

Constructor from an existing array. The new array will be allocated as small as possible, so modifications will cause a resize!

Parameters:

existing - Existing array

Method Detail

clear

public void clear()

Reset the numeric attribute counter.

add

public void add(double attribute)

Append a value.

Parameters:

attribute - Attribute value.

grow

private void grow()
           throws java.lang.OutOfMemoryError

Grow the current array.

Throws:

java.lang.OutOfMemoryError

get

public double get(int pos)

Get the value at this position.

Parameters:

pos - Position

Returns:

Value

set

public void set(int pos,
                double value)

Set the value at this position.

Parameters:

pos - Position

value - Value

remove

public void remove(int start,
                   int len)

Remove a range from the array.

Parameters:

start - Start

len - Length

insert

public void insert(int pos,
                   double val)

Insert a value at the given position.

Parameters:

pos - Insert position

val - Value to insert

size

public int size()

Get the size of the array.

Returns:

Size

isEmpty

public boolean isEmpty()

Test if the array is empty.

Returns:

true if empty.

sort

public void sort()

Sort the contents.

size

public int size(DoubleArray array)

Description copied from interface: ArrayAdapter

Get the size of the array.

Specified by:

size in interface ArrayAdapter<java.lang.Double,DoubleArray>

Specified by:

size in interface NumberArrayAdapter<java.lang.Double,DoubleArray>

Parameters:

array - Array-like thing

Returns:

Size

get

public java.lang.Double get(DoubleArray array,
                            int off)
                     throws java.lang.IndexOutOfBoundsException

Description copied from interface: ArrayAdapter

Get the off'th item from the array.

Specified by:

get in interface ArrayAdapter<java.lang.Double,DoubleArray>

Specified by:

get in interface NumberArrayAdapter<java.lang.Double,DoubleArray>

Parameters:

array - Array to get from

off - Offset

Returns:

Item at offset off

Throws:

java.lang.IndexOutOfBoundsException - for an invalid index.

getDouble

public double getDouble(DoubleArray array,
                        int off)
                 throws java.lang.IndexOutOfBoundsException

Description copied from interface: NumberArrayAdapter

Get the off'th item from the array as double.

Specified by:

getDouble in interface NumberArrayAdapter<java.lang.Double,DoubleArray>

Parameters:

array - Array to get from

off - Offset

Returns:

Item at offset off

Throws:

java.lang.IndexOutOfBoundsException - for an invalid index.

getFloat

public float getFloat(DoubleArray array,
                      int off)
               throws java.lang.IndexOutOfBoundsException

Description copied from interface: NumberArrayAdapter

Get the off'th item from the array as float.

Specified by:

getFloat in interface NumberArrayAdapter<java.lang.Double,DoubleArray>

Parameters:

array - Array to get from

off - Offset

Returns:

Item at offset off

Throws:

java.lang.IndexOutOfBoundsException - for an invalid index.

getInteger

public int getInteger(DoubleArray array,
                      int off)
               throws java.lang.IndexOutOfBoundsException

Description copied from interface: NumberArrayAdapter

Get the off'th item from the array as integer.

Specified by:

getInteger in interface NumberArrayAdapter<java.lang.Double,DoubleArray>

Parameters:

array - Array to get from

off - Offset

Returns:

Item at offset off

Throws:

java.lang.IndexOutOfBoundsException - for an invalid index.

getShort

public short getShort(DoubleArray array,
                      int off)
               throws java.lang.IndexOutOfBoundsException

Description copied from interface: NumberArrayAdapter

Get the off'th item from the array as short.

Specified by:

getShort in interface NumberArrayAdapter<java.lang.Double,DoubleArray>

Parameters:

array - Array to get from

off - Offset

Returns:

Item at offset off

Throws:

java.lang.IndexOutOfBoundsException - for an invalid index.

getLong

public long getLong(DoubleArray array,
                    int off)
             throws java.lang.IndexOutOfBoundsException

Description copied from interface: NumberArrayAdapter

Get the off'th item from the array as long.

Specified by:

getLong in interface NumberArrayAdapter<java.lang.Double,DoubleArray>

Parameters:

array - Array to get from

off - Offset

Returns:

Item at offset off

Throws:

java.lang.IndexOutOfBoundsException - for an invalid index.

getByte

public byte getByte(DoubleArray array,
                    int off)
             throws java.lang.IndexOutOfBoundsException

Description copied from interface: NumberArrayAdapter

Get the off'th item from the array as byte.

Specified by:

getByte in interface NumberArrayAdapter<java.lang.Double,DoubleArray>

Parameters:

array - Array to get from

off - Offset

Returns:

Item at offset off

Throws:

java.lang.IndexOutOfBoundsException - for an invalid index.

toArray

public double[] toArray()

Return a copy of the contents as array.

Returns:

Copy of the contents.