External module "stats/incr/mrss/docs/types/index.d"

Index

Type aliases

accumulator

Functions

incrmrss

Type aliases

accumulator

accumulator: (x?: undefined | number, y?: undefined | number) => number | null

If provided arguments, returns an updated residual sum of squares; otherwise, returns the current residual sum of squares.

Notes

If provided NaN or a value which, when used in computations, results in NaN, the accumulated value is NaN for all future invocations.

param: value
param: value
returns: residual sum of squares

Type declaration

- (x?: undefined | number, y?: undefined | number): number | null
- Parameters
  - Optional x: undefined | number
  - Optional y: undefined | number
  Returns number | null

Functions

Export assignment incrmrss

incrmrss(W: number): accumulator

- Defined in lib/node_modules/@stdlib/stats/incr/mrss/docs/types/index.d.ts:69
Returns an accumulator function which incrementally computes a moving residual sum of squares.

Notes
- The W parameter defines the number of values over which to compute the moving residual sum of squares.
- As W values are needed to fill the window buffer, the first W-1 returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.
throws

must provide a positive integer
Parameters
- W: number
  
  window size
Returns accumulator

accumulator function

Example
```
var accumulator = incrmrss( 3 );

var r = accumulator();
// returns null

r = accumulator( 2.0, 3.0 );
// returns 1.0

r = accumulator( -5.0, 2.0 );
// returns 50.0

r = accumulator( 3.0, 2.0 );
// returns 51.0

r = accumulator( 5.0, -2.0 );
// returns 99.0

r = accumulator();
// returns 99.0
```