Skip to content

Commit a20882d

Browse files
chore: clean up
2 parents 54712f8 + 0b403a1 commit a20882d

File tree

12 files changed

+28
-44
lines changed

12 files changed

+28
-44
lines changed

lib/node_modules/@stdlib/stats/base/dnanminabs/README.md

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ var Float64Array = require( '@stdlib/array/float64' );
6262

6363
var x = new Float64Array( [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, NaN, NaN ] );
6464

65-
var v = dnanminabs( 4, x, 2 );
65+
var v = dnanminabs( 5, x, 2 );
6666
// returns 1.0
6767
```
6868

@@ -76,7 +76,7 @@ var Float64Array = require( '@stdlib/array/float64' );
7676
var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, NaN, NaN ] );
7777
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
7878

79-
var v = dnanminabs( 4, x1, 2 );
79+
var v = dnanminabs( 5, x1, 2 );
8080
// returns 1.0
8181
```
8282

@@ -104,7 +104,7 @@ var Float64Array = require( '@stdlib/array/float64' );
104104

105105
var x = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, NaN, NaN ] );
106106

107-
var v = dnanminabs.ndarray( 4, x, 2, 1 );
107+
var v = dnanminabs.ndarray( 5, x, 2, 1 );
108108
// returns 1.0
109109
```
110110

@@ -155,22 +155,6 @@ console.log( v );
155155

156156
<!-- /.examples -->
157157

158-
<!-- C interface documentation. -->
159-
160-
* * *
161-
162-
<section class="c">
163-
164-
## C APIs
165-
166-
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
167-
168-
<section class="intro">
169-
170-
</section>
171-
172-
<!-- /.intro -->
173-
174158
<!-- C usage documentation. -->
175159

176160
<section class="usage">
@@ -183,12 +167,12 @@ console.log( v );
183167

184168
#### stdlib_strided_dnanminabs( N, \*X, strideX )
185169

186-
Calculate the minimum absolute value of a double-precision floating-point strided array, ignoring `NaN` values.
170+
Computes the minimum absolute value of a double-precision floating-point strided array `x`, ignoring `NaN` values.
187171

188172
```c
189-
const double x[] = { 1.0, -2.0, 0.0 / 0.0, -4.0 };
173+
const double x[] = { 1.0, -2.0, -3.0, 4.0, -5.0, -6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 };
190174

191-
double v = stdlib_strided_dnanminabs( 4, x, 1 );
175+
double v = stdlib_strided_dnanminabs( 5, x, 2 );
192176
// returns 1.0
193177
```
194178
@@ -207,9 +191,9 @@ double stdlib_strided_dnanminabs( const CBLAS_INT N, const double *X, const CBLA
207191
Computes the minimum absolute value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics.
208192

209193
```c
210-
const double x[] = { 1.0, -2.0, 0.0 / 0.0, -4.0 };
194+
const double x[] = { 1.0, -2.0, -3.0, 4.0, -5.0, -6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 };
211195

212-
double v = stdlib_strided_dnanminabs_ndarray( 4, x, 1, 0 );
196+
double v = stdlib_strided_dnanminabs_ndarray( 5, x, 2, 1 );
213197
// returns 1.0
214198
```
215199

lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24+
var uniform = require( '@stdlib/random/base/uniform' );
25+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2427
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2528
var uniform = require( '@stdlib/random/base/uniform' );
2629
var bernoulli = require( '@stdlib/random/base/bernoulli' );
@@ -35,8 +38,7 @@ var dnanminabs = require( './../lib/dnanminabs.js' );
3538
/**
3639
* Returns a random value or `NaN`.
3740
*
38-
* @private
39-
* @returns {number} random number or `NaN`
41+
* @returns {number} Random number or `NaN`
4042
*/
4143
function rand() {
4244
if ( bernoulli( 0.2 ) ) {

lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.native.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ var opts = {
4444
/**
4545
* Returns a random value or `NaN`.
4646
*
47-
* @private
48-
* @returns {number} random number or `NaN`
47+
* @returns {number} Random number or `NaN`
4948
*/
5049
function rand() {
5150
if ( bernoulli( 0.2 ) ) {

lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24+
var uniform = require( '@stdlib/random/base/uniform' );
25+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2427
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2528
var uniform = require( '@stdlib/random/base/uniform' );
2629
var bernoulli = require( '@stdlib/random/base/bernoulli' );
@@ -35,8 +38,7 @@ var dnanminabs = require( './../lib/ndarray.js' );
3538
/**
3639
* Returns a random value or `NaN`.
3740
*
38-
* @private
39-
* @returns {number} random number or `NaN`
41+
* @returns {number} Random number or `NaN`
4042
*/
4143
function rand() {
4244
if ( bernoulli( 0.2 ) ) {

lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.native.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ var opts = {
4444
/**
4545
* Returns a random value or `NaN`.
4646
*
47-
* @private
48-
* @returns {number} random number or `NaN`
47+
* @returns {number} Random number or `NaN`
4948
*/
5049
function rand() {
5150
if ( bernoulli( 0.2 ) ) {

lib/node_modules/@stdlib/stats/base/dnanminabs/docs/repl.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Computes the minimum absolute value of a double-precision floating-point
44
strided array, ignoring `NaN` values.
55

6-
The `N` and stride parameters determine which elements in the strided array
7-
are accessed at runtime.
6+
The `N` and stride parameters determine which elements in the strided
7+
array are accessed at runtime.
88

99
Indexing is relative to the first index. To introduce an offset, use a typed
1010
array view.
@@ -20,7 +20,7 @@
2020
Input array.
2121

2222
strideX: integer
23-
Stride Length.
23+
Stride length.
2424

2525
Returns
2626
-------
@@ -42,7 +42,7 @@
4242
// Using view offsets:
4343
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] );
4444
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
45-
> {{alias}}( 3, x1, 2 )
45+
> {{alias}}( 3, x1,2 )
4646
1.0
4747

4848

@@ -52,7 +52,7 @@
5252
semantics.
5353

5454
While typed array views mandate a view offset based on the underlying
55-
buffer, the `offset` parameter supports indexing semantics based on a
55+
buffer, the offset parameter supports indexing semantics based on a
5656
starting index.
5757

5858
Parameters
@@ -64,7 +64,7 @@
6464
Input array.
6565

6666
strideX: integer
67-
Stride Length.
67+
Stride length.
6868

6969
offsetX: integer
7070
Starting index.
@@ -83,6 +83,7 @@
8383

8484
// Using offset parameter:
8585
> var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] );
86+
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
8687
> {{alias}}.ndarray( 3, x, 2, 1 )
8788
1.0
8889

lib/node_modules/@stdlib/stats/base/dnanminabs/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ interface Routine {
5757
* var v = dnanminabs.ndarray( x.length, x, 1, 0 );
5858
* // returns 1.0
5959
*/
60-
ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number;
60+
ndarray( N: number, x: Float64Array, strideX: number, offset: number ): number;
6161
}
6262

6363
/**

lib/node_modules/@stdlib/stats/base/dnanminabs/include/stdlib/stats/base/dnanminabs.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ extern "C" {
2929
#endif
3030

3131
/**
32-
* Computes the minimum absolute value of a double-precision floating-point strided array, ignoring `NaN` values.
32+
* Computes the minimum absolute value of a double-precision floating-point strided array `x`, ignoring `NaN` values.
3333
*/
3434
double API_SUFFIX(stdlib_strided_dnanminabs)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );
3535

lib/node_modules/@stdlib/stats/base/dnanminabs/lib/ndarray.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ var abs = require( '@stdlib/math/base/special/abs' );
3737
*
3838
* @example
3939
* var Float64Array = require( '@stdlib/array/float64' );
40-
* var floor = require( '@stdlib/math/base/special/floor' );
4140
*
4241
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
4342
*

lib/node_modules/@stdlib/stats/base/dnanminabs/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
#include "stdlib/strided/base/stride2offset.h"
2424

2525
/**
26-
* Computes the minimum absolute value of a double-precision floating-point strided array, ignoring `NaN` values.
26+
* Computes the minimum absolute value of a double-precision floating-point strided array `x`, ignoring `NaN` values.
2727
*
2828
* @param N number of indexed elements
2929
* @param X input array

0 commit comments

Comments
 (0)