org.openimaj.util.array

Class FloatArrayView

java.lang.Object

org.openimaj.util.array.FloatArrayView

All Implemented Interfaces:

Cloneable

public class FloatArrayView
extends Object
implements Cloneable

A wrapper around a java float array that allows views onto the array to be created without the overhead of maintaining copies of the data.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
FloatArrayView(float[] array) Create a view on the entirety of the given array.
FloatArrayView(float[] array, int l, int r) Create a view on the given array from l (inclusive) to r (exclusive).
FloatArrayView(int n) Create a view on an array of length n.

Method Summary

Modifier and Type	Method and Description
FloatArrayView	clone()
float	get(int i) Get the ith element of this array view.
float	getFast(int i) Get the ith element of this array view omitting any bounds checks.
float[]	getUnderlyingStorage() Get access to the underlying array of this view.
void	set(int i, float v) Set the ith element of this array view to the value v.
void	setFast(int i, float v) Set the ith element of this array view to the value v.
int	size() Get the size (number of elements) in the view.
FloatArrayView	subView(int l1, int r1) Get a subview of this view from l1 (inclusive) to r1 (exclusive).
float[]	toArray() Convert this view to an array.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatArrayView

public FloatArrayView(float[] array,
                      int l,
                      int r)

Create a view on the given array from l (inclusive) to r (exclusive).

Parameters:

array - the array

l - start (left) index

r - end (right) index

FloatArrayView

public FloatArrayView(float[] array)

Create a view on the entirety of the given array.

Parameters:

array - the array.

FloatArrayView

public FloatArrayView(int n)

Create a view on an array of length n. The underlying array is initialised automatically.

Parameters:

n - the length of the view and underlying array.

Method Detail

subView

public FloatArrayView subView(int l1,
                              int r1)

Get a subview of this view from l1 (inclusive) to r1 (exclusive).

Parameters:

l1 - start (left) index

r1 - end (right) index

Returns:

subview

get

public float get(int i)

Get the ith element of this array view.

Parameters:

i - the index to get

Returns:

the value at the ith index

getFast

public float getFast(int i)

Get the ith element of this array view omitting any bounds checks.

Parameters:

i - the index to get

Returns:

the value at the ith index

set

public void set(int i,
                float v)

Set the ith element of this array view to the value v.

Parameters:

i - the index to set

v - the value to set

setFast

public void setFast(int i,
                    float v)

Set the ith element of this array view to the value v. Bounds checks are omitted.

Parameters:

i - the index to set

v - the value to set

getUnderlyingStorage

public float[] getUnderlyingStorage()

Get access to the underlying array of this view.

Returns:

the underlying array.

size

public int size()

Get the size (number of elements) in the view.

Returns:

the size

toArray

public float[] toArray()

Convert this view to an array.

Returns:

a copy of the view's data as an array

toString

public String toString()

Overrides:

toString in class Object

clone

public FloatArrayView clone()

Overrides:

clone in class Object