About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Compute a sample Pearson product-moment correlation matrix incrementally.
A Pearson product-moment correlation matrix is an M-by-M matrix whose elements specified by indices j
and k
are the Pearson product-moment correlation coefficients between the jth and kth data variables. The Pearson product-moment correlation coefficient between random variables X
and Y
is defined as
where the numerator is the covariance and the denominator is the product of the respective standard deviations.
For a sample of size n
, the sample Pearson product-moment correlation coefficient is defined as
npm install @stdlib/stats-incr-pcorrmat
var incrpcorrmat = require( '@stdlib/stats-incr-pcorrmat' );
Returns an accumulator function
which incrementally computes a sample Pearson product-moment correlation matrix.
// Create an accumulator for computing a 2-dimensional correlation matrix:
var accumulator = incrpcorrmat( 2 );
The out
argument may be either the order of the correlation matrix or a square 2-dimensional ndarray
for storing the correlation matrix.
var Float64Array = require( '@stdlib/array-float64' );
var ndarray = require( '@stdlib/ndarray-ctor' );
var buffer = new Float64Array( 4 );
var shape = [ 2, 2 ];
var strides = [ 2, 1 ];
// Create a 2-dimensional output correlation matrix:
var corr = ndarray( 'float64', buffer, shape, strides, 0, 'row-major' );
var accumulator = incrpcorrmat( corr );
When means are known, the function supports providing a 1-dimensional ndarray
containing mean values.
var Float64Array = require( '@stdlib/array-float64' );
var ndarray = require( '@stdlib/ndarray-ctor' );
var buffer = new Float64Array( 2 );
var shape = [ 2 ];
var strides = [ 1 ];
var means = ndarray( 'float64', buffer, shape, strides, 0, 'row-major' );
means.set( 0, 3.0 );
means.set( 1, -5.5 );
var accumulator = incrpcorrmat( 2, means );
If provided a data vector, the accumulator function returns an updated sample Pearson product-moment correlation matrix. If not provided a data vector, the accumulator function returns the current sample Pearson product-moment correlation matrix.
var Float64Array = require( '@stdlib/array-float64' );
var ndarray = require( '@stdlib/ndarray-ctor' );
var buffer = new Float64Array( 4 );
var shape = [ 2, 2 ];
var strides = [ 2, 1 ];
var corr = ndarray( 'float64', buffer, shape, strides, 0, 'row-major' );
buffer = new Float64Array( 2 );
shape = [ 2 ];
strides = [ 1 ];
var vec = ndarray( 'float64', buffer, shape, strides, 0, 'row-major' );
var accumulator = incrpcorrmat( corr );
vec.set( 0, 2.0 );
vec.set( 1, 1.0 );
var out = accumulator( vec );
// returns <ndarray>
var bool = ( out === corr );
// returns true
vec.set( 0, 1.0 );
vec.set( 1, -5.0 );
out = accumulator( vec );
// returns <ndarray>
vec.set( 0, 3.0 );
vec.set( 1, 3.14 );
out = accumulator( vec );
// returns <ndarray>
out = accumulator();
// returns <ndarray>
var randu = require( '@stdlib/random-base-randu' );
var ndarray = require( '@stdlib/ndarray-ctor' );
var Float64Array = require( '@stdlib/array-float64' );
var incrpcorrmat = require( '@stdlib/stats-incr-pcorrmat' );
var corr;
var rxy;
var ryx;
var rx;
var ry;
var i;
// Initialize an accumulator for a 2-dimensional correlation matrix:
var accumulator = incrpcorrmat( 2 );
// Create a 1-dimensional data vector:
var buffer = new Float64Array( 2 );
var shape = [ 2 ];
var strides = [ 1 ];
var vec = ndarray( 'float64', buffer, shape, strides, 0, 'row-major' );
// For each simulated data vector, update the sample correlation matrix...
for ( i = 0; i < 100; i++ ) {
vec.set( 0, randu()*100.0 );
vec.set( 1, randu()*100.0 );
corr = accumulator( vec );
rx = corr.get( 0, 0 ).toFixed( 4 );
ry = corr.get( 1, 1 ).toFixed( 4 );
rxy = corr.get( 0, 1 ).toFixed( 4 );
ryx = corr.get( 1, 0 ).toFixed( 4 );
console.log( '[ %d, %d\n %d, %d ]', rx, rxy, ryx, ry );
}
-
@stdlib/stats-incr/covmat
: compute an unbiased sample covariance matrix incrementally. -
@stdlib/stats-incr/pcorr
: compute a sample Pearson product-moment correlation coefficient. -
@stdlib/stats-incr/pcorrdistmat
: compute a sample Pearson product-moment correlation distance matrix incrementally.
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.