Skip to main content

Class: SimpleMovingAverage

Defined in: src/sdk/math/SimpleMovingAverage.ts:4

A utitlity class for calculating a numerical average of a selected number of samples.

Constructors

Constructor

new SimpleMovingAverage(samples): SimpleMovingAverage

Defined in: src/sdk/math/SimpleMovingAverage.ts:11

Class to return a numerical average from a specified number of inputs.

Parameters

ParameterTypeDescription
samplesnumberis the number of samples.

Returns

SimpleMovingAverage

Methods

getAverage()

getAverage(input): number

Defined in: src/sdk/math/SimpleMovingAverage.ts:18

Returns a numerical average of the inputs.

Parameters

ParameterTypeDescription
inputnumberis the input number.

Returns

number

The numerical average.


reset()

reset(): void

Defined in: src/sdk/math/SimpleMovingAverage.ts:33

Resets the average.

Returns

void