com.github.signaflo.data

Class Range

java.lang.Object

com.github.signaflo.data.Range

public final class Range
extends Object

A range of doubles.

Method Summary

Modifier and Type	Method and Description
double[]	asArray() Get the range as an array of doubles.
List<Double>	asList()
double	at(int i) Return the ith element of this range, where indexing begins at 0.
double	end() Get the ending value of this range.
static Range	exclusiveRange(double from, double to) Create a new range of doubles excluding the given to value, with a default spacing between values of 1.0.
static Range	exclusiveRange(double from, double to, double by) Create a new range of doubles excluding the given to value.
static Range	inclusiveRange(double from, double to) Create a new range of doubles including the given to value if possible, with a default spacing between values of 1.0.
static Range	inclusiveRange(double from, double to, double by) Create a new range of doubles including the given to value if possible.
int	size() Get the size, or number of elements, of this range.
double	start() Get the starting value of this range.
double	sum() Get the sum of the data in this range.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

exclusiveRange

public static Range exclusiveRange(double from,
                                   double to,
                                   double by)

Create a new range of doubles excluding the given to value.

Parameters:

from - the starting value of the range.

to - the ending value of the range, not included in the result.

by - the increment amount.

Returns:

a new range of doubles excluding the given to value.

inclusiveRange

public static Range inclusiveRange(double from,
                                   double to,
                                   double by)

Create a new range of doubles including the given to value if possible. Note that the given to value will be included only if (to - from) is an integer multiple of by.

Parameters:

from - the starting value of the range.

to - the ending value of the range, included in the result if possible.

by - the increment amount.

Returns:

a new range of doubles including the given to value if possible.

exclusiveRange

public static Range exclusiveRange(double from,
                                   double to)

Create a new range of doubles excluding the given to value, with a default spacing between values of 1.0.

Parameters:

from - the starting value of the range.

to - the ending value of the range, not included in the result.

Returns:

a new range of doubles excluding the given to value.

inclusiveRange

public static Range inclusiveRange(double from,
                                   double to)

Create a new range of doubles including the given to value if possible, with a default spacing between values of 1.0. Note that the given to value will be included only if (to - from) is an integer multiple of 1.

Parameters:

from - the starting value of the range.

to - the ending value of the range, included in the result if possible.

Returns:

new range of doubles including the given to value if possible.

asArray

public double[] asArray()

Get the range as an array of doubles.

Returns:

the range as an array of doubles.

asList

public List<Double> asList()

sum

public double sum()

Get the sum of the data in this range.

Returns:

the sum of the data in this range.

size

public int size()

Get the size, or number of elements, of this range.

Returns:

the size of this range.

start

public double start()

Get the starting value of this range.

Returns:

the starting value of this range.

end

public double end()

Get the ending value of this range.

Returns:

the ending value of this range.

at

public double at(int i)

Return the ith element of this range, where indexing begins at 0.

Parameters:

i - the index of the range value to retrieve.

Returns:

the ith element of this range.

toString

public String toString()

Overrides:

toString in class Object