CDMA client API  3.1.0
CDMA core library
org.gumtree.data.interfaces.IIndex Interface Reference

The IIndex interface defines a view on a IArray. More...

Inherits IModelObject.

List of all members.

Public Member Functions

int getRank ()
int[] getShape ()
int[] getOrigin ()
long getSize ()
long[] getStride ()
long currentElement ()
long lastElement ()
IIndex set (int[] index)
void setDim (int dim, int value)
void setOrigin (int[] origin)
void setShape (int[] shape)
void setStride (long[] stride)
IIndex set0 (int v)
IIndex set1 (int v)
IIndex set2 (int v)
IIndex set3 (int v)
IIndex set4 (int v)
IIndex set5 (int v)
IIndex set6 (int v)
IIndex set (int v0)
IIndex set (int v0, int v1)
IIndex set (int v0, int v1, int v2)
IIndex set (int v0, int v1, int v2, int v3)
IIndex set (int v0, int v1, int v2, int v3, int v4)
IIndex set (int v0, int v1, int v2, int v3, int v4, int v5)
IIndex set (int v0, int v1, int v2, int v3, int v4, int v5, int v6)
String toStringDebug ()
int[] getCurrentCounter ()
void setIndexName (int dim, String indexName)
String getIndexName (int dim)
IIndex reduce ()
IIndex reduce (int dim) throws IllegalArgumentException
IIndex clone () throws CloneNotSupportedException

Detailed Description

The IIndex interface defines a view on a IArray.

The IIndex fully describes the IArray's visible part. Whatever the storage is, it defines the shape of the visible part of the storage, its origin, how two consecutive cells should be considered. Manages the stride and the way the parsing will be done.
The IIndex can describe the whole array storage or just a portion of it. It can be used to refer to a particular element of an IArray.

Author:
nxi

Member Function Documentation

IIndex org.gumtree.data.interfaces.IIndex.clone ( ) throws CloneNotSupportedException

Get the current element's index into the 1D backing array.

Returns:
integer value

Return the current location of the index on each dimension.

Returns:
java array of integer

Get the name of one of the indices.

Parameters:
dimwhich index?
Returns:
name of index, or null if none.

Get the origin: first index of array in each dimension.

Returns:
array of integer

Get the number of dimensions in the array.

Returns:
integer value

Get the shape: length of array in each dimension.

Returns:
array of integer

Get the total number of elements in the array.

Returns:
long value

Get the stride: for each dimension number elements to jump in the array between two consecutive element of the same dimension

Returns:
array of integer

Get the last element's index into the 1D backing array.

Returns:
integer value

Remove all index with length one.

Returns:
the new IIndex
IIndex org.gumtree.data.interfaces.IIndex.reduce ( int  dim) throws IllegalArgumentException

Eliminate the specified dimension.

Parameters:
dimdimension to eliminate: must be of length one, else IllegalArgumentException
Returns:
the new index

Set the current element's index.

Parameters:
indexarray of integer
Returns:
this, so you can use A.get(i.set(i))

Set current element at dimension 0 to v0.

Parameters:
v0integer value
Returns:
this, so you can use A.get(i.set(i))

Set current element at dimension 0,1 to v0,v1.

Parameters:
v0integer value
v1integer value
Returns:
this, so you can use A.get(i.set(i,j))
IIndex org.gumtree.data.interfaces.IIndex.set ( int  v0,
int  v1,
int  v2 
)

Set current element at dimension 0,1,2 to v0,v1,v2.

Parameters:
v0integer value
v1integer value
v2integer value
Returns:
this, so you can use A.get(i.set(i,j,k))
IIndex org.gumtree.data.interfaces.IIndex.set ( int  v0,
int  v1,
int  v2,
int  v3 
)

Set current element at dimension 0,1,2,3 to v0,v1,v2,v3.

Parameters:
v0integer value
v1integer value
v2integer value
v3integer value
Returns:
this, so you can use A.get(i.set(i,j,k,l))
IIndex org.gumtree.data.interfaces.IIndex.set ( int  v0,
int  v1,
int  v2,
int  v3,
int  v4 
)

Set current element at dimension 0,1,2,3,4 to v0,v1,v2,v3,v4.

Parameters:
v0integer value
v1integer value
v2integer value
v3integer value
v4integer value
Returns:
this, so you can use A.get(i.set(i,j,k,l,m))
IIndex org.gumtree.data.interfaces.IIndex.set ( int  v0,
int  v1,
int  v2,
int  v3,
int  v4,
int  v5 
)

Set current element at dimension 0,1,2,3,4,5 to v0,v1,v2,v3,v4,v5.

Parameters:
v0integer value
v1integer value
v2integer value
v3integer value
v4integer value
v5integer value
Returns:
this, so you can use A.get(i.set(i,j,k,l,m,n))
IIndex org.gumtree.data.interfaces.IIndex.set ( int  v0,
int  v1,
int  v2,
int  v3,
int  v4,
int  v5,
int  v6 
)

Set current element at dimension 0,1,2,3,4,5,6 to v0,v1,v2,v3,v4,v5,v6.

Parameters:
v0integer value
v1integer value
v2integer value
v3integer value
v4integer value
v5integer value
v6integer value
Returns:
this, so you can use A.get(i.set(i,j,k,l,m,n,p))

Set current element at dimension 0 to v.

Parameters:
vinteger value
Returns:
this, so you can use A.get(i.set(i))

Set current element at dimension 1 to v.

Parameters:
vinteger value
Returns:
this, so you can use A.get(i.set(i))

Set current element at dimension 2 to v.

Parameters:
vinteger value
Returns:
this, so you can use A.get(i.set(i))

Set current element at dimension 3 to v.

Parameters:
vinteger value
Returns:
this, so you can use A.get(i.set(i))

Set current element at dimension 4 to v.

Parameters:
vinteger value
Returns:
this, so you can use A.get(i.set(i))

Set current element at dimension 5 to v.

Parameters:
vinteger value
Returns:
this, so you can use A.get(i.set(i))

Set current element at dimension 6 to v.

Parameters:
vinteger value
Returns:
this, so you can use A.get(i.set(i))
void org.gumtree.data.interfaces.IIndex.setDim ( int  dim,
int  value 
)

Set current element at dimension dim to value.

Parameters:
diminteger value
valueinteger value
void org.gumtree.data.interfaces.IIndex.setIndexName ( int  dim,
String  indexName 
)

Set the name of one of the indices.

Parameters:
dimwhich index
indexNamename of index

Set the origin on each dimension for this index

Parameters:
originarray of integers

Set the given shape for this index

Parameters:
shapearray of integers

Set the stride for this index. The stride is the number of cells between two consecutive cells in the same dimension.

Parameters:
stridearray of integers

String representation.

Returns:
String object

The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Variables