Modifier and Type	Class and Description
public class	MultidimensionalCounter.Iterator Perform iteration over the multidimensional counter.

Modifier and Type	Field and Description
private final int	dimension Number of dimensions.
private final int	last Index of last dimension.
private final int[]	size Counter sizes.
private final int	totalSize Total number of (one-dimensional) slots.
private final int[]	uniCounterOffset Offset for each dimension.

Access	Constructor and Description
public	MultidimensionalCounter(int... Counter sizes (number of slots in each dimension). size) Create a counter.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the index within the unidimensionl counter. getCount(int... Indices in multidimensional counter. c) Convert to unidimensional counter.
public int[]	Returns: the multidimensional counts. getCounts(int Index in unidimensional counter. index) Convert to multidimensional counter.
public int	Returns: the number of dimensions. getDimension() Get the number of dimensions of the multidimensional counter.
public int	Returns: the total size of the unidimensional counter. getSize() Get the total number of elements.
public int[]	Returns: the sizes of the multidimensional counter in each dimension. getSizes() Get the number of multidimensional counter slots in each dimension.
public MultidimensionalCounter.Iterator	Returns: the iterator. iterator() Implements java.lang.Iterable.iterator. Create an iterator over this counter.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

dimension	back to summary
private final int dimension Number of dimensions.

last	back to summary
private final int last Index of last dimension.

size	back to summary
private final int[] size Counter sizes.

totalSize	back to summary
private final int totalSize Total number of (one-dimensional) slots.

uniCounterOffset	back to summary
private final int[] uniCounterOffset Offset for each dimension.

Constructor Detail

MultidimensionalCounter	back to summary
public MultidimensionalCounter(int... size) throws NotStrictlyPositiveException Create a counter. Parameters size:int[] Counter sizes (number of slots in each dimension). Exceptions NotStrictlyPositiveException: if one of the sizes is negative or zero.

MultidimensionalCounter

back to summary

public MultidimensionalCounter(int... size) throws NotStrictlyPositiveException

Create a counter.

Parameters

size:int[]: Counter sizes (number of slots in each dimension).

Exceptions

NotStrictlyPositiveException:: if one of the sizes is negative or zero.

Method Detail

getCount back to summary

getCount	back to summary
public int getCount(int... c) throws OutOfRangeException, DimensionMismatchException Convert to unidimensional counter. Parameters c:int[] Indices in multidimensional counter. Returns:int the index within the unidimensionl counter. Exceptions OutOfRangeException: if a value of `c` is not in the range of the corresponding dimension, as defined in the `constructor`. DimensionMismatchException: if the size of `c` does not match the size of the array given in the constructor.

public int getCount(int... c) throws OutOfRangeException, DimensionMismatchException

Convert to unidimensional counter.

Parameters

c:int[]: Indices in multidimensional counter.

Returns:int

the index within the unidimensionl counter.

Exceptions

OutOfRangeException:: if a value of c is not in the range of the corresponding dimension, as defined in the constructor.
DimensionMismatchException:: if the size of c does not match the size of the array given in the constructor.

getCounts back to summary

getCounts	back to summary
public int[] getCounts(int index) throws OutOfRangeException Convert to multidimensional counter. Parameters index:int Index in unidimensional counter. Returns:int[] the multidimensional counts. Exceptions OutOfRangeException: if `index` is not between `0` and the value returned by `getSize()` (excluded).

public int[] getCounts(int index) throws OutOfRangeException

Convert to multidimensional counter.

Parameters

index:int: Index in unidimensional counter.

Returns:int[]

the multidimensional counts.

Exceptions

OutOfRangeException:: if index is not between 0 and the value returned by getSize() (excluded).

getDimension	back to summary
public int getDimension() Get the number of dimensions of the multidimensional counter. Returns:int the number of dimensions.

getDimension

back to summary

public int getDimension()

Get the number of dimensions of the multidimensional counter.

Returns:int: the number of dimensions.

getSize	back to summary
public int getSize() Get the total number of elements. Returns:int the total size of the unidimensional counter.

getSize

back to summary

public int getSize()

Get the total number of elements.

Returns:int: the total size of the unidimensional counter.

getSizes	back to summary
public int[] getSizes() Get the number of multidimensional counter slots in each dimension. Returns:int[] the sizes of the multidimensional counter in each dimension.

getSizes

back to summary

public int[] getSizes()

Get the number of multidimensional counter slots in each dimension.

Returns:int[]: the sizes of the multidimensional counter in each dimension.

iterator	back to summary
public MultidimensionalCounter.Iterator iterator() Implements java.lang.Iterable.iterator. Create an iterator over this counter. Returns:MultidimensionalCounter.Iterator the iterator.

iterator

back to summary

public MultidimensionalCounter.Iterator iterator()

Implements java.lang.Iterable.iterator.

Create an iterator over this counter.

Returns:MultidimensionalCounter.Iterator: the iterator.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.apache.commons.math3.util back to summary

public Class MultidimensionalCounter.Iterator

Class Inheritance

extends Object
implements Iterator<Integer>

java.lang.Object
org.apache.commons.math3.util.MultidimensionalCounter.Iterator

All Implemented Interfaces

java.util.Iterator

Perform iteration over the multidimensional counter.

Field Summary

Modifier and Type	Field and Description
private int	count Unidimensional counter.
private final int[]	counter Multidimensional counter.
private final int	maxCount Maximum value for `count`.

Constructor Summary

Access	Constructor and Description
pack-priv	Iterator() Create an iterator

Method Summary

Modifier and Type	Method and Description
public int	Returns: the index within the unidimensionl counter. getCount() Get the current unidimensional counter slot.
public int	Returns: the count at the corresponding index for the current state of the iterator. getCount(int Dimension index. dim) Get the current count in the selected dimension.
public int[]	Returns: the indices within the multidimensional counter. getCounts() Get the current multidimensional counter slots.
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Integer	Returns: the unidimensional count after the counter has been incremented by `1`. next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

count	back to summary
private int count Unidimensional counter.

counter	back to summary
private final int[] counter Multidimensional counter.

maxCount	back to summary
private final int maxCount Maximum value for `count`.

Constructor Detail

Iterator back to summary

Iterator	back to summary
pack-priv Iterator() Create an iterator See Also `iterator()`

pack-priv Iterator()

Create an iterator

See Also: iterator()

Method Detail

getCount	back to summary
public int getCount() Get the current unidimensional counter slot. Returns:int the index within the unidimensionl counter.

getCount

back to summary

public int getCount()

Get the current unidimensional counter slot.

Returns:int: the index within the unidimensionl counter.

getCount back to summary

getCount	back to summary
public int getCount(int dim) Get the current count in the selected dimension. Parameters dim:int Dimension index. Returns:int the count at the corresponding index for the current state of the iterator. Exceptions IndexOutOfBoundsException: if `index` is not in the correct interval (as defined by the length of the argument in the `constructor of the enclosing class`).

public int getCount(int dim)

Get the current count in the selected dimension.

Parameters

dim:int: Dimension index.

Returns:int

the count at the corresponding index for the current state of the iterator.

Exceptions

IndexOutOfBoundsException:: if index is not in the correct interval (as defined by the length of the argument in the constructor of the enclosing class).

getCounts	back to summary
public int[] getCounts() Get the current multidimensional counter slots. Returns:int[] the indices within the multidimensional counter.

getCounts

back to summary

public int[] getCounts()

Get the current multidimensional counter slots.

Returns:int[]: the indices within the multidimensional counter.

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean: true if the iteration has more elements

next back to summary

next	back to summary
public Integer next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:Integer the unidimensional count after the counter has been incremented by `1`. Exceptions NoSuchElementException: if `hasNext()` would have returned `false`.

public Integer next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:Integer

the unidimensional count after the counter has been incremented by 1.

Exceptions

NoSuchElementException:: if hasNext() would have returned false.

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Exceptions UnsupportedOperationException: if the `remove` operation is not supported by this iterator

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Exceptions

UnsupportedOperationException:: if the remove operation is not supported by this iterator

public Class MultidimensionalCounter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class MultidimensionalCounter.Iterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail