org.das2.qds

Class IndexListDataSetIterator

java.lang.Object

org.das2.qds.IndexListDataSetIterator

All Implemented Interfaces:

DataSetIterator

public class IndexListDataSetIterator
extends java.lang.Object
implements DataSetIterator

Iterator that uses a rank 2 list of indeces. For example, to iterate over 10 points of a rank 2 dataset, this would be constructed with a dataset[10,2].

Constructor Summary

Constructors

Constructor and Description
IndexListDataSetIterator(QDataSet indeces) Create the iterator

Method Summary

Modifier and Type	Method and Description
DDataSet	createEmptyDs() return a dataset that will have the same geometry at the dataset implied by each dimension iterator.
QDataSet	getRank0Value(QDataSet ds) get the rank 0 data set the current iterator position.
double	getValue(QDataSet ds) get the value from ds at the current iterator position.
boolean	hasNext() return true while the iterator has a next element.
int	index(int dim) return the current index for the dimension.
int	length(int dim) return the length of the dimension, or the length reported by the iterator.
void	next() iterate to the next position.
void	putRank0Value(WritableDataSet ds, QDataSet vds) replace the value in ds at the current iterator position.
void	putValue(WritableDataSet ds, double v) replace the value in ds at the current iterator position.
int	rank() return the rank of the dataset which the iterator will walk through.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexListDataSetIterator

public IndexListDataSetIterator(QDataSet indeces)

Create the iterator

Parameters:

indeces - rank 2 indeces [npoints,rank] or just [npoints] for rank 1 data.

Method Detail

hasNext

public boolean hasNext()

Description copied from interface: DataSetIterator

return true while the iterator has a next element.

Specified by:

hasNext in interface DataSetIterator

Returns:

true while the iterator has a next element.

index

public int index(int dim)

Description copied from interface: DataSetIterator

return the current index for the dimension.

Specified by:

index in interface DataSetIterator

Parameters:

dim - the dimension number (0<=dim<inputRank)

Returns:

the current index.

length

public int length(int dim)

Description copied from interface: DataSetIterator

return the length of the dimension, or the length reported by the iterator. Use caution, because this does not imply that the result of the iteration is a qube and does not account for slices. (TODO: does this mean that as we iterate through, the length depends on the current index?)

Specified by:

length in interface DataSetIterator

Parameters:

dim - the dimension number (0<=dim<inputRank)

Returns:

the length of the dimension

next

public void next()

Description copied from interface: DataSetIterator

iterate to the next position.

Specified by:

next in interface DataSetIterator

rank

public int rank()

Description copied from interface: DataSetIterator

return the rank of the dataset which the iterator will walk through. Note this needn't be the same rank as the dataset! For example, when QubeDataSetIterator walks through ds[:,0,:], the rank is 2 even though ds is rank 3.

Specified by:

rank in interface DataSetIterator

Returns:

the rank of the dataset which the iterator will walk through.

getRank0Value

public QDataSet getRank0Value(QDataSet ds)

Description copied from interface: DataSetIterator

get the rank 0 data set the current iterator position.

Specified by:

getRank0Value in interface DataSetIterator

Returns:

units

getValue

public final double getValue(QDataSet ds)

get the value from ds at the current iterator position.

Specified by:

getValue in interface DataSetIterator

Parameters:

ds - a dataset with compatible geometry as the iterator's geometry.

Returns:

the value of ds at the current iterator position.

putValue

public final void putValue(WritableDataSet ds,
                           double v)

replace the value in ds at the current iterator position.

Specified by:

putValue in interface DataSetIterator

Parameters:

ds - a writable dataset with compatible geometry as the iterator's geometry.

v - the value to insert.

putRank0Value

public void putRank0Value(WritableDataSet ds,
                          QDataSet vds)

Description copied from interface: DataSetIterator

replace the value in ds at the current iterator position.

Specified by:

putRank0Value in interface DataSetIterator

Parameters:

ds - a writable dataset with compatible geometry as the iterator's geometry.

vds - the rank 0 value to insert

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createEmptyDs

public DDataSet createEmptyDs()

Description copied from interface: DataSetIterator

return a dataset that will have the same geometry at the dataset implied by each dimension iterator. This is introduced to encapsulate this dangerous code to here where it could be done correctly. Right now this assumes QUBES. Do not pass the result of this into the putValue of this iterator, the result should have its own iterator.

Specified by:

createEmptyDs in interface DataSetIterator

Returns:

a dataset that will have the same geometry at the dataset implied by each dimension iterator.

See Also:

QubeDataSetIterator.createEmptyDs()