Modifier and Type	Class and Description
public static class	IntegerSequence.Incrementor Utility that increments a counter until a maximum is reached, at which point, the instance will by default throw a `MaxCountExceededException`.
public static class	IntegerSequence.Range Generates a sequence of integers.

Access	Constructor and Description
private	IntegerSequence() Utility class contains only static methods.

Modifier and Type	Method and Description
public static IntegerSequence.Range	Returns: a range. range(int First value of the range. start, int Last value of the range. end) Creates a sequence `[start ..`
public static IntegerSequence.Range	Returns: a range. range(final int First value of the range. start, final int Last value of the range that satisfies the above construction rule. max, final int Increment. step) Creates a sequence \( a_i, i < 0 <= n \) where \( a_i = start + i * step \) and \( n \) is such that \( a_n <= max \) and \( a_{n+1} > max \).

IntegerSequence	back to summary
private IntegerSequence() Utility class contains only static methods.

range	back to summary
public static IntegerSequence.Range range(int start, int end) Creates a sequence `[start .. end]`. It calls `range(start, end, 1)`. Parameters start:int First value of the range. end:int Last value of the range. Returns:IntegerSequence.Range a range.

range	back to summary
public static IntegerSequence.Range range(final int start, final int max, final int step) Creates a sequence \( a_i, i < 0 <= n \) where \( a_i = start + i * step \) and \( n \) is such that \( a_n <= max \) and \( a_{n+1} > max \). Parameters start:int First value of the range. max:int Last value of the range that satisfies the above construction rule. step:int Increment. Returns:IntegerSequence.Range a range.

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

public Class IntegerSequence.Incrementor

Class Inheritance

extends Object
implements Iterator<Integer>

java.lang.Object
org.apache.commons.math3.util.IntegerSequence.Incrementor

All Implemented Interfaces

java.util.Iterator

Utility that increments a counter until a maximum is reached, at which point, the instance will by default throw a MaxCountExceededException. However, the user is able to override this behaviour by defining a custom callback, in order to e.g. select which exception must be thrown.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	IntegerSequence.Incrementor.MaxCountExceededCallback Defines a method to be called at counter exhaustion.

Field Summary

Modifier and Type	Field and Description
private static final IntegerSequence.Incrementor.MaxCountExceededCallback	CALLBACK Default callback.
private int	count Current count.
private final int	increment Increment.
private final int	init Initial value the counter.
private final IntegerSequence.Incrementor.MaxCountExceededCallback	maxCountCallback Function called at counter exhaustion.
private final int	maximalCount Upper limit for the counter.

Constructor Summary

Access	Constructor and Description
private	Incrementor(int Initial value. start, int Maximal count. max, int Increment. step, IntegerSequence.Incrementor.MaxCountExceededCallback Function to be called when the maximal count has been reached. cb) Creates an incrementor.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `false` if calling `increment()` will trigger a `MaxCountExceededException`, `true` otherwise. canIncrement() Checks whether incrementing the counter `nTimes` is allowed.
public boolean	Returns: `false` if calling `increment(nTimes)` would call the `callback` `true` otherwise. canIncrement(int Number of increments. nTimes) Checks whether incrementing the counter several times is allowed.
public static IntegerSequence.Incrementor	Returns: an new instance. create() Factory method that creates a default instance.
public int	Returns: the current count. getCount() Gets the current count.
public int	Returns: the counter upper limit. getMaximalCount() Gets the upper limit of the counter.
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public void	increment(int Number of increments. nTimes) Performs multiple increments.
public void	increment() Adds the increment value to the current iteration count.
public Integer	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Not applicable.
public IntegerSequence.Incrementor	Returns: a new instance. withCallback(IntegerSequence.Incrementor.MaxCountExceededCallback Callback to be called at counter exhaustion. cb) Creates a new instance with a given callback.
public IntegerSequence.Incrementor	Returns: a new instance. withIncrement(int Increment. step) Creates a new instance with a given increment.
public IntegerSequence.Incrementor	Returns: a new instance. withMaximalCount(int Maximal count. max) Creates a new instance with a given maximal count.
public IntegerSequence.Incrementor	Returns: a new instance. withStart(int Initial value of the counter. start) Creates a new instance with a given initial value.

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

Field Detail

CALLBACK	back to summary
private static final IntegerSequence.Incrementor.MaxCountExceededCallback CALLBACK Default callback.

count	back to summary
private int count Current count.

increment	back to summary
private final int increment Increment.

init	back to summary
private final int init Initial value the counter.

maxCountCallback	back to summary
private final IntegerSequence.Incrementor.MaxCountExceededCallback maxCountCallback Function called at counter exhaustion.

maximalCount	back to summary
private final int maximalCount Upper limit for the counter.

Constructor Detail

Incrementor back to summary

Incrementor	back to summary
private Incrementor(int start, int max, int step, IntegerSequence.Incrementor.MaxCountExceededCallback cb) throws NullArgumentException Creates an incrementor. The counter will be exhausted either when `max` is reached or when `nTimes` increments have been performed. Parameters start:int Initial value. max:int Maximal count. step:int Increment. cb:IntegerSequence.Incrementor.MaxCountExceededCallback Function to be called when the maximal count has been reached. Exceptions NullArgumentException: if `cb` is `null`.

private Incrementor(int start, int max, int step, IntegerSequence.Incrementor.MaxCountExceededCallback cb) throws NullArgumentException

Creates an incrementor. The counter will be exhausted either when max is reached or when nTimes increments have been performed.

Parameters

start:int: Initial value.
max:int: Maximal count.
step:int: Increment.
cb:IntegerSequence.Incrementor.MaxCountExceededCallback: Function to be called when the maximal count has been reached.

Exceptions

NullArgumentException:: if cb is null.

Method Detail

canIncrement back to summary

canIncrement	back to summary
public boolean canIncrement() Checks whether incrementing the counter `nTimes` is allowed. Returns:boolean `false` if calling `increment()` will trigger a `MaxCountExceededException`, `true` otherwise.

public boolean canIncrement()

Checks whether incrementing the counter nTimes is allowed.

Returns:boolean: false if calling increment() will trigger a MaxCountExceededException, true otherwise.

canIncrement back to summary

canIncrement	back to summary
public boolean canIncrement(int nTimes) Checks whether incrementing the counter several times is allowed. Parameters nTimes:int Number of increments. Returns:boolean `false` if calling `increment(nTimes)` would call the `callback` `true` otherwise.

public boolean canIncrement(int nTimes)

Checks whether incrementing the counter several times is allowed.

Parameters

nTimes:int: Number of increments.

Returns:boolean

false if calling increment(nTimes) would call the callback true otherwise.

create back to summary

create	back to summary
public static IntegerSequence.Incrementor create() Factory method that creates a default instance. The initial and maximal values are set to 0. For the new instance to be useful, the maximal count must be set by calling `withMaximalCount`. Returns:IntegerSequence.Incrementor an new instance.

public static IntegerSequence.Incrementor create()

Factory method that creates a default instance. The initial and maximal values are set to 0. For the new instance to be useful, the maximal count must be set by calling withMaximalCount.

Returns:IntegerSequence.Incrementor: an new instance.

getCount	back to summary
public int getCount() Gets the current count. Returns:int the current count.

getCount

back to summary

public int getCount()

Gets the current count.

Returns:int: the current count.

getMaximalCount	back to summary
public int getMaximalCount() Gets the upper limit of the counter. Returns:int the counter upper limit.

getMaximalCount

back to summary

public int getMaximalCount()

Gets the upper limit of the counter.

Returns:int: the counter upper limit.

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

increment back to summary

increment	back to summary
public void increment(int nTimes) throws MaxCountExceededException Performs multiple increments. Parameters nTimes:int Number of increments. Exceptions MaxCountExceededException: at counter exhaustion. NotStrictlyPositiveException: if `nTimes <= 0`. See Also `increment()`

public void increment(int nTimes) throws MaxCountExceededException

Performs multiple increments.

Parameters

nTimes:int: Number of increments.

Exceptions

MaxCountExceededException:: at counter exhaustion.
NotStrictlyPositiveException:: if nTimes <= 0.

See Also

increment()

increment back to summary

increment	back to summary
public void increment() throws MaxCountExceededException Adds the increment value to the current iteration count. At counter exhaustion, this method will call the `trigger` method of the callback object passed to the `withCallback(MaxCountExceededCallback)` method. If not explicitly set, a default callback is used that will throw a `MaxCountExceededException`. Exceptions MaxCountExceededException: at counter exhaustion, unless a custom `callback` has been set. See Also `increment(int)`

public void increment() throws MaxCountExceededException

Adds the increment value to the current iteration count. At counter exhaustion, this method will call the trigger method of the callback object passed to the withCallback(MaxCountExceededCallback) method. If not explicitly set, a default callback is used that will throw a MaxCountExceededException.

Exceptions

MaxCountExceededException:: at counter exhaustion, unless a custom callback has been set.

See Also

increment(int)

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 next element in the iteration

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 next element in the iteration

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Not applicable.

remove

back to summary

public void remove()

Overrides default java.util.Iterator.remove.

Not applicable.

withCallback	back to summary
public IntegerSequence.Incrementor withCallback(IntegerSequence.Incrementor.MaxCountExceededCallback cb) Creates a new instance with a given callback. The counter is reset to the initial value. Parameters cb:IntegerSequence.Incrementor.MaxCountExceededCallback Callback to be called at counter exhaustion. Returns:IntegerSequence.Incrementor a new instance.

withCallback

back to summary

public IntegerSequence.Incrementor withCallback(IntegerSequence.Incrementor.MaxCountExceededCallback cb)

Creates a new instance with a given callback. The counter is reset to the initial value.

Parameters

cb:IntegerSequence.Incrementor.MaxCountExceededCallback: Callback to be called at counter exhaustion.

Returns:IntegerSequence.Incrementor

a new instance.

withIncrement	back to summary
public IntegerSequence.Incrementor withIncrement(int step) Creates a new instance with a given increment. The counter is reset to the initial value. Parameters step:int Increment. Returns:IntegerSequence.Incrementor a new instance.

withIncrement

back to summary

public IntegerSequence.Incrementor withIncrement(int step)

Creates a new instance with a given increment. The counter is reset to the initial value.

Parameters

step:int: Increment.

Returns:IntegerSequence.Incrementor

a new instance.

withMaximalCount	back to summary
public IntegerSequence.Incrementor withMaximalCount(int max) Creates a new instance with a given maximal count. The counter is reset to the initial value. Parameters max:int Maximal count. Returns:IntegerSequence.Incrementor a new instance.

withMaximalCount

back to summary

public IntegerSequence.Incrementor withMaximalCount(int max)

Creates a new instance with a given maximal count. The counter is reset to the initial value.

Parameters

max:int: Maximal count.

Returns:IntegerSequence.Incrementor

a new instance.

withStart	back to summary
public IntegerSequence.Incrementor withStart(int start) Creates a new instance with a given initial value. The counter is reset to the initial value. Parameters start:int Initial value of the counter. Returns:IntegerSequence.Incrementor a new instance.

withStart

back to summary

public IntegerSequence.Incrementor withStart(int start)

Creates a new instance with a given initial value. The counter is reset to the initial value.

Parameters

start:int: Initial value of the counter.

Returns:IntegerSequence.Incrementor

a new instance.

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

public Interface IntegerSequence.Incrementor.MaxCountExceededCallback

Defines a method to be called at counter exhaustion. The trigger method should usually throw an exception.

Method Summary

Modifier and Type	Method and Description
public void	trigger(int Maximal count. maximalCount) Function called when the maximal count has been reached.

Method Detail

trigger	back to summary
public void trigger(int maximalCount) throws MaxCountExceededException Function called when the maximal count has been reached. Parameters maximalCount:int Maximal count. Exceptions MaxCountExceededException: at counter exhaustion

trigger

back to summary

public void trigger(int maximalCount) throws MaxCountExceededException

Function called when the maximal count has been reached.

Parameters

maximalCount:int: Maximal count.

Exceptions

MaxCountExceededException:: at counter exhaustion

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

public Class IntegerSequence.Range

Class Inheritance

extends Object
implements Iterable<Integer>

java.lang.Object
org.apache.commons.math3.util.IntegerSequence.Range

All Implemented Interfaces

java.lang.Iterable

Generates a sequence of integers.

Field Summary

Modifier and Type	Field and Description
private final int	max Final value.
private final int	size Number of integers contained in this range.
private final int	start First value.
private final int	step Increment.

Constructor Summary

Access	Constructor and Description
public	Range(int First value of the range. start, int Last value of the range that satisfies the above construction rule. max, int Increment. step) Creates a sequence \( a_i, i < 0 <= n \) where \( a_i = start + i * step \) and \( n \) is such that \( a_n <= max \) and \( a_{n+1} > max \).

Method Summary

Modifier and Type	Method and Description
public Iterator<Integer>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public int	Returns: the size of the range. size() Gets the number of elements contained in the range.

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

Field Detail

max	back to summary
private final int max Final value.

size	back to summary
private final int size Number of integers contained in this range.

start	back to summary
private final int start First value.

step	back to summary
private final int step Increment.

Constructor Detail

Range	back to summary
public Range(int start, int max, int step) Creates a sequence \( a_i, i < 0 <= n \) where \( a_i = start + i * step \) and \( n \) is such that \( a_n <= max \) and \( a_{n+1} > max \). Parameters start:int First value of the range. max:int Last value of the range that satisfies the above construction rule. step:int Increment.

Range

back to summary

public Range(int start, int max, int step)

Creates a sequence \( a_i, i < 0 <= n \) where \( a_i = start + i * step \) and \( n \) is such that \( a_n <= max \) and \( a_{n+1} > max \).

Parameters

start:int: First value of the range.
max:int: Last value of the range that satisfies the above construction rule.
step:int: Increment.

Method Detail

iterator back to summary

iterator	back to summary
public Iterator<Integer> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:Iterator<Integer> an Iterator.

public Iterator<Integer> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<Integer>: an Iterator.

size	back to summary
public int size() Gets the number of elements contained in the range. Returns:int the size of the range.

size

back to summary

public int size()

Gets the number of elements contained in the range.

Returns:int: the size of the range.