Module xyz.jmburns.rangefun

Package xyz.jmburns.rangefun

Class Progressions

java.lang.Object

xyz.jmburns.rangefun.Progressions

public class Progressions
extends java.lang.Object

This class forms most of the public API for this library, and is intended to be the point of creation for all Progression outside of this library. ' Note that all of the methods contained in this class are intended to be statically imported before use, for enhanced readability. For instance, for (int i : range(1, 5)) is far better to read than for (int i : Progressions.range(1, 5)), and should thus be preferred.

Method Summary

Modifier and Type	Method	Description
static Progression	count(int to)	Creates a new Progression instance that behaves like a range of integers, from 0 to the given ending value, exclusive.
static Progression	indices(java.lang.Object array)	Creates a new Progression instance that behaves like a range of all valid indices of the given array.
static Progression	progression(int start, int end, int step)	Creates a new Progression instance with the given starting, ending, and stepping values.
static Progression	range(int start, int end)	Creates a new Progression instance that behaves like a range of integers, with the given starting and ending values.

Methods inherited from class java.lang.Object

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

Method Detail

progression

public static Progression progression(int start,
                                      int end,
                                      int step)

Creates a new Progression instance with the given starting, ending, and stepping values.

Parameters:

start - the first integer in the progression, inclusive

end - the point which no integer in the progression will go over, but may or may not be equal to

step - the amount by which each integer in the progression will differ from the previous one. Cannot be zero

Returns:

a new Progression representing the given start, end, and step values

Throws:

java.lang.IllegalArgumentException - if step == 0

range

public static Progression range(int start,
                                int end)

Creates a new Progression instance that behaves like a range of integers, with the given starting and ending values.

Parameters:

start - the first integer in the progression, inclusive

end - the last integer in the progression, inclusive

Returns:

a new Progression representing the given start and end values

See Also:

progression(int, int, int)

Implementation Note:

This method behaves exactly as if calling Progressions.progression(start, end, 1).

count

public static Progression count(int to)

Creates a new Progression instance that behaves like a range of integers, from 0 to the given ending value, exclusive. This method is intended to be used when looping a certain number of times.

Parameters:

to - the last integer in the progression, exclusive

Returns:

a new Progression representing the given end value

See Also:

range(int, int)

Implementation Note:

This method behaves exactly as if calling Progressions.range(0, to - 1).

indices

public static Progression indices(java.lang.Object array)

Creates a new Progression instance that behaves like a range of all valid indices of the given array.

Parameters:

array - the array for which to generate indices

Returns:

a new Progression representing all valid indices of the given array

Throws:

java.lang.NullPointerException - if the given object is null

java.lang.IllegalArgumentException - if the given object is not an array

See Also:

count(int)

Implementation Note:

This method behaves exactly as if calling Progressions.count(array.length) when passed valid arguments.