Skip to content

Commit 657947f

Browse files
kgrytekgryte
committed
feat: add ndarray/numel 
1 parent ef501a1 commit 657947f

File tree

10 files changed

+749
-0
lines changed

10 files changed

+749
-0
lines changed

‎lib/node_modules/@stdlib/ndarray/numel/README.md

+145
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2023 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# numel
22+
23+
> Return the number of elements in an [ndarray][@stdlib/ndarray/ctor].
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var numel = require( '@stdlib/ndarray/numel' );
41+
```
42+
43+
#### numel( x )
44+
45+
Returns number of elements in an [ndarray][@stdlib/ndarray/ctor].
46+
47+
```javascript
48+
var zeros = require( '@stdlib/ndarray/zeros' );
49+
50+
var x = zeros( [ 3, 2, 3 ] );
51+
// returns <ndarray>
52+
53+
var n = numel( x );
54+
// returns 18
55+
```
56+
57+
</section>
58+
59+
<!-- /.usage -->
60+
61+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
62+
63+
<section class="notes">
64+
65+
</section>
66+
67+
<!-- /.notes -->
68+
69+
<!-- Package usage examples. -->
70+
71+
<section class="examples">
72+
73+
## Examples
74+
75+
<!-- eslint no-undef: "error" -->
76+
77+
<!-- eslint-disable new-cap -->
78+
79+
```javascript
80+
var zeros = require( '@stdlib/ndarray/zeros' );
81+
var slice = require( '@stdlib/ndarray/slice' );
82+
var E = require( '@stdlib/slice/multi' );
83+
var S = require( '@stdlib/slice/ctor' );
84+
var numel = require( '@stdlib/ndarray/numel' );
85+
86+
// Create an array:
87+
var x = zeros( [ 10, 10, 10, 10 ] );
88+
// returns <ndarray>
89+
90+
// Define some slices:
91+
var slices = [
92+
// :,:,:,:
93+
E( null, null, null, null ),
94+
95+
// 5:10,:,2:4,::-1
96+
E( S( 5, 10 ), null, S( 2, 4 ), S( null, null, -1 ) ),
97+
98+
// :,:,2,:
99+
E( null, null, 2, null ),
100+
101+
// 1,2,3,4
102+
E( 1, 2, 3, 4 ),
103+
104+
// :,:,::2,4::2
105+
E( null, null, S( null, null, 2 ), S( 4, null, 2 ) )
106+
];
107+
108+
// Determine the number of elements in each slice...
109+
var s;
110+
var i;
111+
for ( i = 0; i < slices.length; i++ ) {
112+
s = slice( x, slices[ i ] );
113+
console.log( '%s => %d elements', s.shape.join( 'x' ), numel( s ) );
114+
}
115+
```
116+
117+
</section>
118+
119+
<!-- /.examples -->
120+
121+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
122+
123+
<section class="references">
124+
125+
</section>
126+
127+
<!-- /.references -->
128+
129+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
130+
131+
<section class="related">
132+
133+
</section>
134+
135+
<!-- /.related -->
136+
137+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
138+
139+
<section class="links">
140+
141+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
142+
143+
</section>
144+
145+
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/numel/benchmark/benchmark.js

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var zeros = require( '@stdlib/ndarray/zeros' );
25+
var pkg = require( './../package.json' ).name;
26+
var numel = require( './../lib' );
27+
28+
29+
// MAIN //
30+
31+
bench( pkg, function benchmark( b ) {
32+
var values;
33+
var n;
34+
var i;
35+
36+
values = [
37+
zeros( [ 10, 10, 10 ] ),
38+
zeros( [ 5, 5, 5 ] ),
39+
zeros( [ 3, 4, 5 ] )
40+
];
41+
42+
b.tic();
43+
for ( i = 0; i < b.iterations; i++ ) {
44+
n = numel( values[ i%values.length ] );
45+
if ( n !== n ) {
46+
b.fail( 'should not return NaN' );
47+
}
48+
}
49+
b.toc();
50+
if ( n !== n ) {
51+
b.fail( 'should not return NaN' );
52+
}
53+
b.pass( 'benchmark finished' );
54+
b.end();
55+
});

‎lib/node_modules/@stdlib/ndarray/numel/docs/repl.txt

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
{{alias}}( x )
3+
Returns the number of elements in an ndarray.
4+
5+
Parameters
6+
----------
7+
x: ndarray
8+
Input ndarray.
9+
10+
Returns
11+
-------
12+
n: integer
13+
Number of elements.
14+
15+
Examples
16+
--------
17+
> var n = {{alias}}( {{alias:@stdlib/ndarray/zeros}}( [ 3, 3, 3 ] ) )
18+
27
19+
20+
See Also
21+
--------
22+

‎lib/node_modules/@stdlib/ndarray/numel/docs/types/index.d.ts

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
import { ndarray } from '@stdlib/types/ndarray';
24+
25+
/**
26+
* Returns the number of elements in an ndarray.
27+
*
28+
* @param x - input ndarray
29+
* @returns number of elements
30+
*
31+
* @example
32+
* var zeros = require( `@stdlib/ndarray/zeros` );
33+
*
34+
* var n = numel( zeros( [ 3, 3, 3 ] ) );
35+
* // returns 27
36+
*/
37+
declare function numel( x: ndarray ): number;
38+
39+
40+
// EXPORTS //
41+
42+
export = numel;

‎lib/node_modules/@stdlib/ndarray/numel/docs/types/test.ts

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
import zeros = require( '@stdlib/ndarray/zeros' );
20+
import numel = require( './index' );
21+
22+
23+
// TESTS //
24+
25+
// The function returns a number...
26+
{
27+
numel( zeros( [ 3, 2, 1 ] ) ); // $ExpectType number
28+
}
29+
30+
// The compiler throws an error if the function is provided a value other than an ndarray...
31+
{
32+
numel( '5' ); // $ExpectError
33+
numel( 5 ); // $ExpectError
34+
numel( true ); // $ExpectError
35+
numel( false ); // $ExpectError
36+
numel( null ); // $ExpectError
37+
numel( undefined ); // $ExpectError
38+
numel( [ '1', '2' ] ); // $ExpectError
39+
numel( {} ); // $ExpectError
40+
numel( ( x: number ): number => x ); // $ExpectError
41+
}
42+
43+
// The compiler throws an error if the function is provided an unsupported number of arguments...
44+
{
45+
numel(); // $ExpectError
46+
numel( zeros( [ 2, 2 ] ), {} ); // $ExpectError
47+
}

‎lib/node_modules/@stdlib/ndarray/numel/examples/index.js

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
/* eslint-disable new-cap */
20+
21+
'use strict';
22+
23+
var zeros = require( '@stdlib/ndarray/zeros' );
24+
var slice = require( '@stdlib/ndarray/slice' );
25+
var E = require( '@stdlib/slice/multi' );
26+
var S = require( '@stdlib/slice/ctor' );
27+
var numel = require( './../lib' );
28+
29+
// Create an array:
30+
var x = zeros( [ 10, 10, 10, 10 ] );
31+
// returns <ndarray>
32+
33+
// Define some slices:
34+
var slices = [
35+
// :,:,:,:
36+
E( null, null, null, null ),
37+
38+
// 5:10,:,2:4,::-1
39+
E( S( 5, 10 ), null, S( 2, 4 ), S( null, null, -1 ) ),
40+
41+
// :,:,2,:
42+
E( null, null, 2, null ),
43+
44+
// 1,2,3,4
45+
E( 1, 2, 3, 4 ),
46+
47+
// :,:,::2,4::2
48+
E( null, null, S( null, null, 2 ), S( 4, null, 2 ) )
49+
];
50+
51+
// Determine the number of elements in each slice...
52+
var s;
53+
var i;
54+
for ( i = 0; i < slices.length; i++ ) {
55+
s = slice( x, slices[ i ] );
56+
console.log( '%s => %d elements', s.shape.join( 'x' ), numel( s ) );
57+
}

0 commit comments

Comments
 (0)