Reservoir.java

/*
 * Copyright 2016 KairosDB Authors
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.kairosdb.util;

/**
 * A statistically representative reservoir of a data stream.
 */
public interface Reservoir {
	/**
	 * Returns the number of values recorded.
	 *
	 * @return the number of values recorded
	 */
	int size();

	/**
	 * Adds a new recorded value to the reservoir.
	 *
	 * @param value a new recorded value
	 */
	void update(double value);

	/**
	 * Returns only the double values of the reservoir (not the timestamps)
	 *
	 * @return the double values of the treemap
	 */
	double[] getValues();
}