cloud.metaapi.sdk.meta_api.reservoir

Class Reservoir

java.lang.Object

cloud.metaapi.sdk.meta_api.reservoir.Reservoir

public class Reservoir
extends Object

FIFO-like reservoir of a fixed size capable calculating running sums, min/max, average, msdev and stddev msdev and stddev calculation by Naive algorithm (Mean square deviation) msdev = sqrt((∑{i = from 1 to n}(Xi)^2 -(∑{i = from 1 to n}Xi)^2 / N) / N) (Standard deviation) stddev = sqrt((∑{i = from 1 to n}(Xi)^2 -(∑{i = from 1 to n}Xi)^2 / N) / N - 1) link: https://goo.gl/MAEGP2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Reservoir.Statistics

Field Summary

Fields

Modifier and Type	Field and Description
List<Reservoir.Statistics>	array
int	size
Reservoir.Statistics	statistics

Constructor Summary

Constructors

Constructor and Description
Reservoir(int size, int observationIntervalInMS) Constructs Reservoir
Reservoir(int size, int observationIntervalInMS, Reservoir object) Constructs Reservoir

Method Summary

Modifier and Type	Method and Description
Reservoir.Statistics	checkStatisticsOnRestore(Reservoir.Statistics statistics)
Reservoir.Statistics	getStatistics() Returns Reservoir statistics
void	pushMeasurement(long data) Add element to Reservoir

Methods inherited from class java.lang.Object

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

Field Detail

array

public List<Reservoir.Statistics> array

size

public int size

statistics

public Reservoir.Statistics statistics

Constructor Detail

Reservoir

public Reservoir(int size,
                 int observationIntervalInMS)

Constructs Reservoir

Parameters:

size - Reservoir size

observationIntervalInMS - Reservoir observation Interval In ms

Reservoir

public Reservoir(int size,
                 int observationIntervalInMS,
                 Reservoir object)

Constructs Reservoir

Parameters:

size - Reservoir size

observationIntervalInMS - Reservoir observation Interval In ms

object - Object

Method Detail

checkStatisticsOnRestore

public Reservoir.Statistics checkStatisticsOnRestore(Reservoir.Statistics statistics)

pushMeasurement

public void pushMeasurement(long data)

Add element to Reservoir

Parameters:

data - to add

getStatistics

public Reservoir.Statistics getStatistics()

Returns Reservoir statistics

Returns:

Reservoir statistics