Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@ The function has the following parameters:
- **strideX**: stride length for `x`.
- **offsetX**: starting index for `x`.
- **out**: output [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
- **strideOut1**: stride length for the first dimension of `out`.
- **strideOut2**: stride length for the second dimension of `out`.
- **strideOut1**: stride length of the first dimension of `out`.
- **strideOut2**: stride length of the second dimension of `out`.
- **offsetOut**: starting index for `out`.

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to access only the last two elements:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ var K = 2;
// FUNCTIONS //

/**
* Create a benchmark function.
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ var K = 2;
// FUNCTIONS //

/**
* Create a benchmark function.
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ var K = 2;
// FUNCTIONS //

/**
* Create a benchmark function.
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ var K = 2;
// FUNCTIONS //

/**
* Create a benchmark function.
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# dcorrelation

> Calculate the [correlation distance][correlation-distance] between two double-precision floating-point strided arrays.
> Compute the [correlation distance][correlation-distance] between two double-precision floating-point strided arrays.

<section class="intro">

Expand All @@ -36,8 +36,6 @@ D(X, Y) = 1 - \frac{\displaystyle\sum_{i=0}^{N-1} (x_i - \bar{x})(y_i - \bar{y})

where `x_i` and `y_i` are the _ith_ components of vectors **X** and **Y**, respectively.

<!-- </equation> -->


</section>

Expand All @@ -53,7 +51,7 @@ var dcorrelation = require( '@stdlib/stats/strided/distances/dcorrelation' );

#### dcorrelation( N, x, strideX, y, strideY )

Computes the [correlation distance][correlation-distance] of two double-precision floating-point strided arrays.
Computes the [correlation distance][correlation-distance] between two double-precision floating-point strided arrays.

```javascript
var Float64Array = require( '@stdlib/array/float64' );
Expand Down Expand Up @@ -104,7 +102,7 @@ var c = dcorrelation( 4, x1, 2, y1, 2 );

#### dcorrelation.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )

Computes the [correlation distance][correlation-distance] of two double-precision floating-point strided arrays using alternative indexing semantics.
Computes the [correlation distance][correlation-distance] between two double-precision floating-point strided arrays using alternative indexing semantics.

```javascript
var Float64Array = require( '@stdlib/array/float64' );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,6 @@ import dcorrelation = require( './index' );
dcorrelation.ndarray( x.length, x ); // $ExpectError
dcorrelation.ndarray( x.length, x, 1 ); // $ExpectError
dcorrelation.ndarray( x.length, x, 1, 0 ); // $ExpectError
dcorrelation.ndarray( x.length, x, 1, 0 ); // $ExpectError
dcorrelation.ndarray( x.length, x, 1, 0, y ); // $ExpectError
dcorrelation.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError
dcorrelation.ndarray( x.length, x, 1, 0, y, 1, 0, 0 ); // $ExpectError
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
* limitations under the License.
*/

#ifndef STDLIB_STATS_STRIDED_DCORRELATION_H
#define STDLIB_STATS_STRIDED_DCORRELATION_H
#ifndef STDLIB_STATS_STRIDED_DISTANCES_DCORRELATION_H
#define STDLIB_STATS_STRIDED_DISTANCES_DCORRELATION_H

#include "stdlib/blas/base/shared.h"

Expand All @@ -42,4 +42,4 @@ double API_SUFFIX(stdlib_strided_dcorrelation_ndarray)( const CBLAS_INT N, const
}
#endif

#endif // !STDLIB_STATS_STRIDED_DCORRELATION_H
#endif // !STDLIB_STATS_STRIDED_DISTANCES_DCORRELATION_H