Package dap4.core.util

Class Odometer

java.lang.Object

dap4.core.util.Odometer

All Implemented Interfaces:

Iterator<Index>

Direct Known Subclasses:

MultiOdometer, ScalarOdometer

public class Odometer
extends Object
implements Iterator<Index>

A classic implementation of an odometer taken from the netcdf-c code. Extended to provide iterator interface

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Odometer.STATE

Field Summary

Fields

Modifier and Type	Field	Description
protected List<DapDimension>	dimset
protected long[]	endpoint
protected Index	index
protected boolean	ismulti
protected int	rank
protected List<Slice>	slices
protected Odometer.STATE	state

Constructor Summary

Constructors

Constructor	Description
Odometer()
Odometer(List<Slice> set)
Odometer(List<Slice> set, List<DapDimension> dimset)

Method Summary

Modifier and Type	Method	Description
static Odometer	factory(List<Slice> slices)
static Odometer	factory(List<Slice> slices, List<DapDimension> dimset)
static Odometer	factoryScalar()
List<Slice>	getSlices()
List<Odometer>	getSubOdometers()
boolean	hasNext()
long	index()	Compute the linear index from the current odometer indices.
Index	indices()	Return current set of indices
boolean	isMulti()
Index	next()
int	rank()	Return odometer rank
void	remove()
protected void	reset()
Slice	slice(int i)	Return ith slice
int	step(int firstpos, int lastpos)
String	toString()
long	totalSize()	Compute the total number of elements.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

state

protected Odometer.STATE state

ismulti

protected boolean ismulti

rank

protected int rank

slices

protected List<Slice> slices

dimset

protected List<DapDimension> dimset

index

protected Index index

endpoint

protected long[] endpoint

Constructor Detail

Odometer

public Odometer()

Odometer

public Odometer(List<Slice> set)
         throws DapException

Throws:

DapException

Odometer

public Odometer(List<Slice> set,
                List<DapDimension> dimset)
         throws DapException

Throws:

DapException

Method Detail

factoryScalar

public static Odometer factoryScalar()

factory

public static Odometer factory(List<Slice> slices)
                        throws DapException

Throws:

DapException

factory

public static Odometer factory(List<Slice> slices,
                               List<DapDimension> dimset)
                        throws DapException

Throws:

DapException

reset

protected void reset()

toString

public String toString()

Overrides:

toString in class Object

rank

public int rank()

Return odometer rank

slice

public Slice slice(int i)

Return ith slice

getSlices

public List<Slice> getSlices()

index

public long index()

Compute the linear index from the current odometer indices.

indices

public Index indices()

Return current set of indices

totalSize

public long totalSize()

Compute the total number of elements.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Index>

next

public Index next()

Specified by:

next in interface Iterator<Index>

remove

public void remove()

Specified by:

remove in interface Iterator<Index>

step

public int step(int firstpos,
                int lastpos)

getSubOdometers

public List<Odometer> getSubOdometers()

isMulti

public boolean isMulti()