data.DoubleRange Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-timeseries

Time Series Analysis in Java

There is a newer version: 0.2.1

/*
 * Copyright (c) 2016 Jacob Rachiele
 *
 */
package data;

import stats.Statistics;

/**
 * Represents a range of doubles.
 * @author Jacob Rachiele
 *
 */
final class DoubleRange {
	
	private final double[] range;
	
	private DoubleRange(final int from, final int to, final int by) {
		range = new double[to - from];
		for (int i = 0; i < range.length; i++) {
			range[i] = from + i * by;
		}
	}
	
	/**
	 * Create a new range of doubles excluding the given to value. 
	 * @param from the starting value of the range.
	 * @param to the ending value of the range, not included in the result.
	 * @return a new of doubles excluding the given to value.
	 */
	static DoubleRange newRangeExclusive(final int from, final int to) {
		return new DoubleRange(from, to, 1);
	}
	
	 /**
   * Create a new range of doubles including the given to value. 
   * @param from the starting value of the range.
   * @param to the ending value of the range, included in the result.
   * @return a new of doubles including the given to value.
   */
	static DoubleRange newRangeInclusive(final int from, final int to) {
		return new DoubleRange(from, to + 1, 1);
	}
	
	/**
	 * Get the range as an array of doubles.
	 * @return the range as an array of doubles.
	 */
	double[] asArray() {
		return this.range.clone();
	}

	/**
	 * Get the sum of the data in the range.
	 * @return the sum of the data in the range.
	 */
  double sum() {
		return Statistics.sumOf(range);
	}
}