dap4.core.util

Class Odometer

java.lang.Object

dap4.core.util.Odometer

All Implemented Interfaces:

java.util.Iterator<java.lang.Long>

Direct Known Subclasses:

MultiOdometer, ScalarOdometer

public class Odometer
extends java.lang.Object
implements java.util.Iterator<java.lang.Long>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Odometer.STATE

Field Summary

Fields

Modifier and Type	Field and Description
protected int	contiguousdelta
protected DapDimension[]	dimset
protected long[]	endpoint
protected long[]	indices
protected int	rank
protected Slice[]	slices
protected Odometer.STATE	state
protected boolean	usecontiguous

Constructor Summary

Constructors

Constructor and Description
Odometer()
Odometer(java.util.List<DapDimension> dimset, boolean usecontiguous)
Odometer(java.util.List<Slice> set, java.util.List<DapDimension> dimset, boolean usecontiguous)

Method Summary

Modifier and Type	Method and Description
static Odometer	factory(java.util.List<Slice> slices, java.util.List<DapDimension> dimset, boolean usecontiguous)
java.util.List<Slice>	getContiguous()
long[]	getIndices() Get the current set of indices
boolean	hasNext()
long	index() Compute the linear index from the current odometer indices.
boolean	isContiguous()
java.lang.Long	next()
void	remove()
protected void	reset()
java.lang.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

rank

protected int rank

slices

protected Slice[] slices

dimset

protected DapDimension[] dimset

usecontiguous

protected boolean usecontiguous

contiguousdelta

protected int contiguousdelta

indices

protected long[] indices

endpoint

protected long[] endpoint

Constructor Detail

Odometer

public Odometer()

Odometer

public Odometer(java.util.List<DapDimension> dimset,
                boolean usecontiguous)
         throws DapException

Throws:

DapException

Odometer

public Odometer(java.util.List<Slice> set,
                java.util.List<DapDimension> dimset,
                boolean usecontiguous)
         throws DapException

Throws:

DapException

Method Detail

factory

public static Odometer factory(java.util.List<Slice> slices,
                               java.util.List<DapDimension> dimset,
                               boolean usecontiguous)
                        throws DapException

Throws:

DapException

reset

protected void reset()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

index

public long index()

Compute the linear index from the current odometer indices.

totalSize

public long totalSize()

Compute the total number of elements.

getIndices

public long[] getIndices()

Get the current set of indices

Returns:

current set of indices

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<java.lang.Long>

next

public java.lang.Long next()

Specified by:

next in interface java.util.Iterator<java.lang.Long>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<java.lang.Long>

isContiguous

public boolean isContiguous()

getContiguous

public java.util.List<Slice> getContiguous()