Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Functions

Type aliases

accumulator

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

If provided arguments, returns an updated moving squared sample correlation coefficient.

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

updated moving squared sample correlation coefficient

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 incrmpcorr2

  • Returns an accumulator function which incrementally computes a moving squared sample Pearson product-moment correlation coefficient.

    Notes
    • The W parameter defines the number of values over which to compute the moving squared sample correlation coefficient.
    • As W (x,y) pairs 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

    first argument must be a positive integer

    Parameters

    • W: number

      window size

    • meanx: number

      mean value

    • meany: number

      mean value

    Returns accumulator

    accumulator function

    Example

    var accumulator = incrmpcorr2( 3, -2.0, 10.0 );

  • Returns an accumulator function which incrementally computes a moving squared sample Pearson product-moment correlation coefficient.

    Notes
    • The W parameter defines the number of values over which to compute the moving squared sample correlation coefficient.
    • As W (x,y) pairs 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

    first argument must be a positive integer

    Parameters

    • W: number

      window size

    Returns accumulator

    accumulator function

    Example

    var accumulator = incrmpcorr2( 3 );

var r2 = accumulator();
// returns null

r2 = accumulator( 2.0, 1.0 );
// returns 0.0

r2 = accumulator( -5.0, 3.14 );
// returns ~1.0

r2 = accumulator( 3.0, -1.0 );
// returns ~0.86

r2 = accumulator( 5.0, -9.5 );
// returns ~0.74

r2 = accumulator();
// returns ~0.74