Skip to content

Commit ee87e2b

Browse files
committed
fix: function name
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 864303f commit ee87e2b

File tree

8 files changed

+112
-112
lines changed

8 files changed

+112
-112
lines changed

lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ limitations under the License.
1818
1919
-->
2020

21-
# sindexof
21+
# sindexOf
2222

2323
> Return the index of a specified search element in a single-precision floating-point strided array.
2424
@@ -37,10 +37,10 @@ limitations under the License.
3737
## Usage
3838

3939
```javascript
40-
var sindexof = require( '@stdlib/blas/ext/base/sindex-of' );
40+
var sindexOf = require( '@stdlib/blas/ext/base/sindex-of' );
4141
```
4242

43-
#### sindexof( N, searchElement, x, strideX\[, offsetX ] )
43+
#### sindexOf( N, searchElement, x, strideX\[, offsetX ] )
4444

4545
Returns the index of a specified search element in a single-precision floating-point strided array.
4646

@@ -49,7 +49,7 @@ var Float32Array = require( '@stdlib/array/float32' );
4949

5050
var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
5151

52-
var idx = sindexof( x.length, 3.0, x, 1 );
52+
var idx = sindexOf( x.length, 3.0, x, 1 );
5353
// returns 2
5454
```
5555

@@ -61,14 +61,14 @@ The function has the following parameters:
6161
- **strideX**: index increment.
6262
- **offsetX**: starting index (_optional_).
6363

64-
To begin searching from specific index, provide an `offset`.
64+
To begin searching from specific index, provide an `offset` parameter:
6565

6666
```javascript
6767
var Float32Array = require( '@stdlib/array/float32' );
6868

6969
var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
7070

71-
var idx = sindexof( x.length, 3.0, x, 1, 5 );
71+
var idx = sindexOf( x.length, 3.0, x, 1, 5 );
7272
// returns 7
7373
```
7474

@@ -79,7 +79,7 @@ var Float32Array = require( '@stdlib/array/float32' );
7979

8080
var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
8181

82-
var idx = sindexof( x.length, 3.0, x, -1, -2 );
82+
var idx = sindexOf( x.length, 3.0, x, -1, -2 );
8383
// returns 2
8484
```
8585

@@ -90,7 +90,7 @@ var Float32Array = require( '@stdlib/array/float32' );
9090

9191
var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
9292

93-
var idx = sindexof( x.length, 8.0, x, 1 );
93+
var idx = sindexOf( x.length, 8.0, x, 1 );
9494
// returns -1
9595
```
9696

@@ -120,22 +120,22 @@ var idx = sindexof( x.length, 8.0, x, 1 );
120120

121121
```javascript
122122
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
123-
var sindexof = require( '@stdlib/blas/ext/base/sindex-of' );
123+
var sindexOf = require( '@stdlib/blas/ext/base/sindex-of' );
124124

125125
var x = discreteUniform( 10, -100, 100, {
126126
'dtype': 'float32'
127127
});
128128

129-
var idx = sindexof( x.length, 2.0, x, 1 );
129+
var idx = sindexOf( x.length, 2.0, x, 1 );
130130
console.log( idx );
131131

132-
idx = sindexof( x.length, 12.0, x, 2, 5 );
132+
idx = sindexOf( x.length, 12.0, x, 2, 5 );
133133
console.log( idx );
134134

135-
idx = sindexof( x.length, -57.0, x, 1, -2 );
135+
idx = sindexOf( x.length, -57.0, x, 1, -2 );
136136
console.log( idx );
137137

138-
idx = sindexof( x.length, 92.0, x, -1, -2 );
138+
idx = sindexOf( x.length, 92.0, x, -1, -2 );
139139
console.log( idx );
140140
```
141141

lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ var pow = require( '@stdlib/math/base/special/pow' );
2525
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
2626
var oneTo = require( '@stdlib/array/one-to' );
2727
var pkg = require( './../package.json' ).name;
28-
var sindexof = require( './../lib' );
28+
var sindexOf = require( './../lib' );
2929

3030

3131
// FUNCTIONS //
@@ -53,7 +53,7 @@ function createBenchmark( len ) {
5353

5454
b.tic();
5555
for ( i = 0; i < b.iterations; i++ ) {
56-
out = sindexof( x.length, 2.0, x, 1, 0 );
56+
out = sindexOf( x.length, 2.0, x, 1, 0 );
5757
if ( out !== out ) {
5858
b.fail( 'should return an integer' );
5959
}

lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@
3737
* var Float32Array = require( '@stdlib/array/float32' );
3838
* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] );
3939
*
40-
* var idx = sindexof( x.length, 2.0, x, 1 );
40+
* var idx = sindexOf( x.length, 2.0, x, 1 );
4141
* // returns 1
4242
*/
43-
declare function sindexof( N: number, searchElement: number, x: Float32Array, strideX: number, offsetX?: number ): number;
43+
declare function sindexOf( N: number, searchElement: number, x: Float32Array, strideX: number, offsetX?: number ): number;
4444

4545

4646
// EXPORTS //
4747

48-
export = sindexof;
48+
export = sindexOf;

lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts

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

19-
import sindexof = require( './index' );
19+
import sindexOf = require( './index' );
2020

2121

2222
// TESTS //
@@ -25,96 +25,96 @@ import sindexof = require( './index' );
2525
{
2626
var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
2727

28-
sindexof( x.length, 2.0, x, 1 ); // $ExpectType number
29-
sindexof( x.length, 2.0, x, 1, 1 ); // $ExpectType number
28+
sindexOf( x.length, 2.0, x, 1 ); // $ExpectType number
29+
sindexOf( x.length, 2.0, x, 1, 1 ); // $ExpectType number
3030
}
3131

3232
// The compiler throws an error if the function is provided a first argument which is not a number...
3333
{
3434
var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
3535

36-
sindexof( '1', 2.0, x, 1 ); // $ExpectError
37-
sindexof( true, 2.0, x, 1 ); // $ExpectError
38-
sindexof( false, 2.0, x, 1 ); // $ExpectError
39-
sindexof( null, 2.0, x, 1 ); // $ExpectError
40-
sindexof( {}, 2.0, x, 1 ); // $ExpectError
41-
42-
sindexof( '1', 2.0, x, 1, 1 ); // $ExpectError
43-
sindexof( true, 2.0, x, 1, 1 ); // $ExpectError
44-
sindexof( false, 2.0, x, 1, 1 ); // $ExpectError
45-
sindexof( null, 2.0, x, 1, 1 ); // $ExpectError
46-
sindexof( {}, 2.0, x, 1, 1 ); // $ExpectError
36+
sindexOf( '1', 2.0, x, 1 ); // $ExpectError
37+
sindexOf( true, 2.0, x, 1 ); // $ExpectError
38+
sindexOf( false, 2.0, x, 1 ); // $ExpectError
39+
sindexOf( null, 2.0, x, 1 ); // $ExpectError
40+
sindexOf( {}, 2.0, x, 1 ); // $ExpectError
41+
42+
sindexOf( '1', 2.0, x, 1, 1 ); // $ExpectError
43+
sindexOf( true, 2.0, x, 1, 1 ); // $ExpectError
44+
sindexOf( false, 2.0, x, 1, 1 ); // $ExpectError
45+
sindexOf( null, 2.0, x, 1, 1 ); // $ExpectError
46+
sindexOf( {}, 2.0, x, 1, 1 ); // $ExpectError
4747
}
4848

4949
// The compiler throws an error if the function is provided a second argument which is not a number...
5050
{
5151
var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
5252

53-
sindexof( x.length, '1', x, 1 ); // $ExpectError
54-
sindexof( x.length, true, x, 1 ); // $ExpectError
55-
sindexof( x.length, false, x, 1 ); // $ExpectError
56-
sindexof( x.length, null, x, 1 ); // $ExpectError
57-
sindexof( x.length, {}, x, 1 ); // $ExpectError
58-
59-
sindexof( x.length, '1', x, 1, 1 ); // $ExpectError
60-
sindexof( x.length, true, x, 1, 1 ); // $ExpectError
61-
sindexof( x.length, false, x, 1, 1 ); // $ExpectError
62-
sindexof( x.length, null, x, 1, 1 ); // $ExpectError
63-
sindexof( x.length, {}, x, 1, 1 ); // $ExpectError
53+
sindexOf( x.length, '1', x, 1 ); // $ExpectError
54+
sindexOf( x.length, true, x, 1 ); // $ExpectError
55+
sindexOf( x.length, false, x, 1 ); // $ExpectError
56+
sindexOf( x.length, null, x, 1 ); // $ExpectError
57+
sindexOf( x.length, {}, x, 1 ); // $ExpectError
58+
59+
sindexOf( x.length, '1', x, 1, 1 ); // $ExpectError
60+
sindexOf( x.length, true, x, 1, 1 ); // $ExpectError
61+
sindexOf( x.length, false, x, 1, 1 ); // $ExpectError
62+
sindexOf( x.length, null, x, 1, 1 ); // $ExpectError
63+
sindexOf( x.length, {}, x, 1, 1 ); // $ExpectError
6464
}
6565

6666
// The compiler throws an error if the function is provided a third argument which is not a Float32Array...
6767
{
68-
sindexof( x.length, 1.0, '1', 1 ); // $ExpectError
69-
sindexof( x.length, 1.0, true, 1 ); // $ExpectError
70-
sindexof( x.length, 1.0, false, 1 ); // $ExpectError
71-
sindexof( x.length, 1.0, null, 1 ); // $ExpectError
72-
sindexof( x.length, 1.0, {}, 1 ); // $ExpectError
73-
74-
sindexof( x.length, 1.0, '1', 1, 1 ); // $ExpectError
75-
sindexof( x.length, 1.0, true, 1, 1 ); // $ExpectError
76-
sindexof( x.length, 1.0, false, 1, 1 ); // $ExpectError
77-
sindexof( x.length, 1.0, null, 1, 1 ); // $ExpectError
78-
sindexof( x.length, 1.0, {}, 1, 1 ); // $ExpectError
68+
sindexOf( x.length, 1.0, '1', 1 ); // $ExpectError
69+
sindexOf( x.length, 1.0, true, 1 ); // $ExpectError
70+
sindexOf( x.length, 1.0, false, 1 ); // $ExpectError
71+
sindexOf( x.length, 1.0, null, 1 ); // $ExpectError
72+
sindexOf( x.length, 1.0, {}, 1 ); // $ExpectError
73+
74+
sindexOf( x.length, 1.0, '1', 1, 1 ); // $ExpectError
75+
sindexOf( x.length, 1.0, true, 1, 1 ); // $ExpectError
76+
sindexOf( x.length, 1.0, false, 1, 1 ); // $ExpectError
77+
sindexOf( x.length, 1.0, null, 1, 1 ); // $ExpectError
78+
sindexOf( x.length, 1.0, {}, 1, 1 ); // $ExpectError
7979
}
8080

8181
// The compiler throws an error if the function is provided a fourth argument which is not a number...
8282
{
8383
var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
8484

85-
sindexof( x.length, 2.0, x, '1' ); // $ExpectError
86-
sindexof( x.length, 2.0, x, true ); // $ExpectError
87-
sindexof( x.length, 2.0, x, false ); // $ExpectError
88-
sindexof( x.length, 2.0, x, null ); // $ExpectError
89-
sindexof( x.length, 2.0, x, {} ); // $ExpectError
90-
91-
sindexof( x.length, 2.0, x, '1', 1 ); // $ExpectError
92-
sindexof( x.length, 2.0, x, true, 1 ); // $ExpectError
93-
sindexof( x.length, 2.0, x, false, 1 ); // $ExpectError
94-
sindexof( x.length, 2.0, x, null, 1 ); // $ExpectError
95-
sindexof( x.length, 2.0, x, {}, 1 ); // $ExpectError
85+
sindexOf( x.length, 2.0, x, '1' ); // $ExpectError
86+
sindexOf( x.length, 2.0, x, true ); // $ExpectError
87+
sindexOf( x.length, 2.0, x, false ); // $ExpectError
88+
sindexOf( x.length, 2.0, x, null ); // $ExpectError
89+
sindexOf( x.length, 2.0, x, {} ); // $ExpectError
90+
91+
sindexOf( x.length, 2.0, x, '1', 1 ); // $ExpectError
92+
sindexOf( x.length, 2.0, x, true, 1 ); // $ExpectError
93+
sindexOf( x.length, 2.0, x, false, 1 ); // $ExpectError
94+
sindexOf( x.length, 2.0, x, null, 1 ); // $ExpectError
95+
sindexOf( x.length, 2.0, x, {}, 1 ); // $ExpectError
9696
}
9797

9898
// The compiler throws an error if the function is provided a fifth argument which is not a number...
9999
{
100100
var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
101101

102-
sindexof( x.length, 2.0, x, 1, '1' ); // $ExpectError
103-
sindexof( x.length, 2.0, x, 1, true ); // $ExpectError
104-
sindexof( x.length, 2.0, x, 1, false ); // $ExpectError
105-
sindexof( x.length, 2.0, x, 1, null ); // $ExpectError
106-
sindexof( x.length, 2.0, x, 1, {} ); // $ExpectError
107-
108-
sindexof( x.length, 2.0, x, 1, '1' ); // $ExpectError
109-
sindexof( x.length, 2.0, x, 1, true ); // $ExpectError
110-
sindexof( x.length, 2.0, x, 1, false ); // $ExpectError
111-
sindexof( x.length, 2.0, x, 1, null ); // $ExpectError
112-
sindexof( x.length, 2.0, x, 1, {} ); // $ExpectError
102+
sindexOf( x.length, 2.0, x, 1, '1' ); // $ExpectError
103+
sindexOf( x.length, 2.0, x, 1, true ); // $ExpectError
104+
sindexOf( x.length, 2.0, x, 1, false ); // $ExpectError
105+
sindexOf( x.length, 2.0, x, 1, null ); // $ExpectError
106+
sindexOf( x.length, 2.0, x, 1, {} ); // $ExpectError
107+
108+
sindexOf( x.length, 2.0, x, 1, '1' ); // $ExpectError
109+
sindexOf( x.length, 2.0, x, 1, true ); // $ExpectError
110+
sindexOf( x.length, 2.0, x, 1, false ); // $ExpectError
111+
sindexOf( x.length, 2.0, x, 1, null ); // $ExpectError
112+
sindexOf( x.length, 2.0, x, 1, {} ); // $ExpectError
113113
}
114114

115115
// The compiler throws an error if the function is provided an unsupported number of arguments...
116116
{
117-
sindexof(); // $ExpectError
118-
sindexof( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ) ); // $ExpectError
119-
sindexof( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1, 1, {} ); // $ExpectError
117+
sindexOf(); // $ExpectError
118+
sindexOf( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ) ); // $ExpectError
119+
sindexOf( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1, 1, {} ); // $ExpectError
120120
}

lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,20 @@
1919
'use strict';
2020

2121
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
22-
var sindexof = require( './../lib' );
22+
var sindexOf = require( './../lib' );
2323

2424
var x = discreteUniform( 10, -100, 100, {
2525
'dtype': 'float32'
2626
});
2727
console.log( x );
28-
var idx = sindexof( x.length, 2.0, x, 1 );
28+
var idx = sindexOf( x.length, 2.0, x, 1 );
2929
console.log( idx );
3030

31-
idx = sindexof( x.length, 12.0, x, 2, 5 );
31+
idx = sindexOf( x.length, 12.0, x, 2, 5 );
3232
console.log( idx );
3333

34-
idx = sindexof( x.length, -57.0, x, 1, -2 );
34+
idx = sindexOf( x.length, -57.0, x, 1, -2 );
3535
console.log( idx );
3636

37-
idx = sindexof( x.length, 92.0, x, -1, -2 );
37+
idx = sindexOf( x.length, 92.0, x, -1, -2 );
3838
console.log( idx );

lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@
2525
*
2626
* @example
2727
* var Float32Array = require( '@stdlib/array/float32' );
28-
* var sindexof = require( '@stdlib/blas/ext/base/sindex-of' );
28+
* var sindexOf = require( '@stdlib/blas/ext/base/sindex-of' );
2929
*
3030
* var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
3131
*
32-
* var idx = sindexof( x.length, 3.0, x, 1 );
32+
* var idx = sindexOf( x.length, 3.0, x, 1 );
3333
* // returns 2
3434
*/
3535

lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@
3535
*
3636
* var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
3737
*
38-
* var idx = sindexof( x.length, 3.0, x, 1 );
38+
* var idx = sindexOf( x.length, 3.0, x, 1 );
3939
* // returns 2
4040
*/
41-
function sindexof( N, searchElement, x, strideX, offsetX ) {
41+
function sindexOf( N, searchElement, x, strideX, offsetX ) {
4242
var ix;
4343
var i;
4444

@@ -73,4 +73,4 @@ function sindexof( N, searchElement, x, strideX, offsetX ) {
7373

7474
// EXPORTS //
7575

76-
module.exports = sindexof;
76+
module.exports = sindexOf;

0 commit comments

Comments
 (0)