File: repl.txt

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (43 lines) | stat: -rw-r--r-- 1,096 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

{{alias}}( [mx, my] )
    Returns an accumulator function which incrementally computes a sample
    Pearson product-moment correlation distance.

    The correlation distance is defined as one minus the Pearson product-moment
    correlation coefficient and, thus, resides on the interval [0,2].

    If provided values, the accumulator function returns an updated sample
    correlation distance. If not provided values, the accumulator function
    returns the current sample correlation distance.

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

    Parameters
    ----------
    mx: number (optional)
        Known mean.

    my: number (optional)
        Known mean.

    Returns
    -------
    acc: Function
        Accumulator function.

    Examples
    --------
    > var accumulator = {{alias}}();
    > var d = accumulator()
    null
    > d = accumulator( 2.0, 1.0 )
    1.0
    > d = accumulator( -5.0, 3.14 )
    ~2.0
    > d = accumulator()
    ~2.0

    See Also
    --------