org.openimaj.util.array

Class ShortArrayView

java.lang.Object

org.openimaj.util.array.ShortArrayView

All Implemented Interfaces:

Cloneable

public class ShortArrayView
extends Object
implements Cloneable

A wrapper around a java short 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
ShortArrayView(int n) Create a view on an array of length n.
ShortArrayView(short[] array) Create a view on the entirety of the given array.
ShortArrayView(short[] array, int l, int r) Create a view on the given array from l (inclusive) to r (exclusive).

Method Summary

Modifier and Type	Method and Description
ShortArrayView	clone()
short	get(int i) Get the ith element of this array view.
short	getFast(int i) Get the ith element of this array view omitting any bounds checks.
short[]	getUnderlyingStorage() Get access to the underlying array of this view.
void	set(int i, short v) Set the ith element of this array view to the value v.
void	setFast(int i, short v) Set the ith element of this array view to the value v.
int	size() Get the size (number of elements) in the view.
ShortArrayView	subView(int l1, int r1) Get a subview of this view from l1 (inclusive) to r1 (exclusive).
short[]	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

ShortArrayView

public ShortArrayView(short[] 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

ShortArrayView

public ShortArrayView(short[] array)

Create a view on the entirety of the given array.

Parameters:

array - the array.

ShortArrayView

public ShortArrayView(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 ShortArrayView 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 short 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 short 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,
                short 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,
                    short 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 short[] 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 short[] 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 ShortArrayView clone()

Overrides:

clone in class Object