Skip to content

Commit 4c10a06

Browse files
committed
fix: align stats/strided/distances/dcorrelation docs and include guard with siblings
https://claude.ai/code/session_01PYMuhnRSCirT5T3Bn4o4Lj
1 parent c5fad82 commit 4c10a06

4 files changed

Lines changed: 7 additions & 10 deletions

File tree

lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# dcorrelation
2222

23-
> Calculate the [correlation distance][correlation-distance] between two double-precision floating-point strided arrays.
23+
> Compute the [correlation distance][correlation-distance] between two double-precision floating-point strided arrays.
2424
2525
<section class="intro">
2626

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

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

39-
<!-- </equation> -->
40-
4139

4240
</section>
4341

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

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

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

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

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

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

109107
```javascript
110108
var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
Indexing is relative to the first index. To introduce an offset, use a typed
1010
array view.
1111

12-
If `N <= 0`, the function returns `NaN`.
12+
If `N <= 1`, the function returns `NaN`.
1313

1414
Parameters
1515
----------

lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/docs/types/test.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,6 @@ import dcorrelation = require( './index' );
242242
dcorrelation.ndarray( x.length, x ); // $ExpectError
243243
dcorrelation.ndarray( x.length, x, 1 ); // $ExpectError
244244
dcorrelation.ndarray( x.length, x, 1, 0 ); // $ExpectError
245-
dcorrelation.ndarray( x.length, x, 1, 0 ); // $ExpectError
246245
dcorrelation.ndarray( x.length, x, 1, 0, y ); // $ExpectError
247246
dcorrelation.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError
248247
dcorrelation.ndarray( x.length, x, 1, 0, y, 1, 0, 0 ); // $ExpectError

lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/include/stdlib/stats/strided/distances/dcorrelation.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
* limitations under the License.
1717
*/
1818

19-
#ifndef STDLIB_STATS_STRIDED_DCORRELATION_H
20-
#define STDLIB_STATS_STRIDED_DCORRELATION_H
19+
#ifndef STDLIB_STATS_STRIDED_DISTANCES_DCORRELATION_H
20+
#define STDLIB_STATS_STRIDED_DISTANCES_DCORRELATION_H
2121

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

@@ -42,4 +42,4 @@ double API_SUFFIX(stdlib_strided_dcorrelation_ndarray)( const CBLAS_INT N, const
4242
}
4343
#endif
4444

45-
#endif // !STDLIB_STATS_STRIDED_DCORRELATION_H
45+
#endif // !STDLIB_STATS_STRIDED_DISTANCES_DCORRELATION_H

0 commit comments

Comments
 (0)