Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Functions

Type aliases

accumulator

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

If provided input values, the accumulator function returns an updated mean squared error. If not provided input values, the accumulator function returns the current mean squared error.

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

input value

param

input value

returns

mean squared error or null

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 incrmse

  • Returns an accumulator function which incrementally computes the mean squared error.

    Returns accumulator

    accumulator function

    Example

    var accumulator = incrmse();

var m = accumulator();
// returns null

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

m = accumulator( -5.0, 2.0 );
// returns 25.0

m = accumulator();
// returns 25.0