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

The ISliceIterator interface permits to access easily a to a sub-part of an array. More...

Inherits IModelObject.

List of all members.

Public Member Functions

boolean hasNext ()
void next ()
IArray getArrayNext () throws InvalidRangeException
int[] getSliceShape () throws InvalidRangeException
int[] getSlicePosition ()

Detailed Description

The ISliceIterator interface permits to access easily a to a sub-part of an array.

This is a way to iterate over slices of arrays. Each iteration returns an array of dimension dim, representing the last dim dimensions of the input array. So for 3D data consisting of a set of 2D arrays, each of the 2D arrays will be returned.

Author:
nxi

Member Function Documentation

Get the next slice of IArray.

Returns:
CDMA IArray
Exceptions:
InvalidRangeException

Get the slice position in the whole array from which this slice iterator was created.

Returns:
int array of the current position of the slice
Note:
rank of the returned position is the same as the IArray shape we are slicing

Get the shape of any slice that is returned. This could be used when a temporary array of the right shape needs to be created.

Returns:
dimensions of a single slice from the iterator
Exceptions:
InvalidRangeExceptioninvalid range

Check if there is a next slice.

Returns:
Boolean type

Jump to the next slice.


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