time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1172B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 /**
     22 * Compute a sample absolute Pearson product-moment correlation coefficient incrementally.
     23 *
     24 * @module @stdlib/stats/incr/apcorr
     25 *
     26 * @example
     27 * var incrapcorr = require( '@stdlib/stats/incr/apcorr' );
     28 *
     29 * var accumulator = incrapcorr();
     30 *
     31 * var ar = accumulator();
     32 * // returns null
     33 *
     34 * ar = accumulator( 2.0, 1.0 );
     35 * // returns 0.0
     36 *
     37 * ar = accumulator( -5.0, 3.14 );
     38 * // returns ~1.0
     39 *
     40 * ar = accumulator();
     41 * // returns ~1.0
     42 */
     43 
     44 // MODULES //
     45 
     46 var incrapcorr = require( './main.js' );
     47 
     48 
     49 // EXPORTS //
     50 
     51 module.exports = incrapcorr;