Skip to content

Commit dff88c9

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent dd05593 commit dff88c9

File tree

13 files changed

+765
-5
lines changed

13 files changed

+765
-5
lines changed

‎dist/index.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/index.js.map

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎flags/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+
# flags
22+
23+
> Return the flags of a provided [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 flags = require( '@stdlib/ndarray/flags' );
41+
```
42+
43+
#### flags( x )
44+
45+
Returns the flags of a provided [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 o = flags( x );
54+
// returns {...}
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 flags = require( '@stdlib/ndarray/flags' );
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,4,2:4,::-1
96+
E( S( 5, 10 ), 4, S( 2, 4 ), S( null, null, -1 ) ),
97+
98+
// :,:,2,:
99+
E( null, null, 2, null ),
100+
101+
// 1,2,3,:
102+
E( 1, 2, 3, null ),
103+
104+
// 1,3,::2,4::2
105+
E( 1, 3, S( null, null, 2 ), S( 4, null, 2 ) )
106+
];
107+
108+
// Retrieve the flags for 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', JSON.stringify( flags( 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/ndarray/tree/main/ctor
142+
143+
</section>
144+
145+
<!-- /.links -->

‎flags/benchmark/benchmark.js

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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( './../../zeros' );
25+
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
26+
var pkg = require( './../package.json' ).name;
27+
var flags = require( './../lib' );
28+
29+
30+
// MAIN //
31+
32+
bench( pkg, function benchmark( b ) {
33+
var values;
34+
var out;
35+
var i;
36+
37+
values = [
38+
zeros( [ 10, 10, 10, 1 ] ),
39+
zeros( [ 5, 5, 5, 1, 1 ] ),
40+
zeros( [ 3, 4, 5 ] )
41+
];
42+
43+
b.tic();
44+
for ( i = 0; i < b.iterations; i++ ) {
45+
out = flags( values[ i%values.length ] );
46+
if ( typeof out !== 'object' ) {
47+
b.fail( 'should return an object' );
48+
}
49+
}
50+
b.toc();
51+
if ( !isPlainObject( out ) ) {
52+
b.fail( 'should return an object' );
53+
}
54+
b.pass( 'benchmark finished' );
55+
b.end();
56+
});

‎flags/docs/repl.txt

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

‎flags/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, Flags } from '@stdlib/types/ndarray';
24+
25+
/**
26+
* Returns the flags of a provided ndarray.
27+
*
28+
* @param x - input ndarray
29+
* @returns flags
30+
*
31+
* @example
32+
* var zeros = require( `@stdlib/ndarray/zeros` );
33+
*
34+
* var o = flags( zeros( [ 3, 3, 3 ] ) );
35+
* // returns {...}
36+
*/
37+
declare function flags<T = unknown>( x: ndarray ): Flags<T>;
38+
39+
40+
// EXPORTS //
41+
42+
export = flags;

‎flags/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( './../../../zeros' );
20+
import flags = require( './index' );
21+
22+
23+
// TESTS //
24+
25+
// The function returns ndarray flags...
26+
{
27+
flags( zeros( [ 3, 2, 1 ] ) ); // $ExpectType Flags<unknown>
28+
}
29+
30+
// The compiler throws an error if the function is provided a first argument which is not an ndarray...
31+
{
32+
flags( '5' ); // $ExpectError
33+
flags( 5 ); // $ExpectError
34+
flags( true ); // $ExpectError
35+
flags( false ); // $ExpectError
36+
flags( null ); // $ExpectError
37+
flags( undefined ); // $ExpectError
38+
flags( [ '1', '2' ] ); // $ExpectError
39+
flags( {} ); // $ExpectError
40+
flags( ( 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+
flags(); // $ExpectError
46+
flags( zeros( [ 2, 2 ] ), {} ); // $ExpectError
47+
}

‎flags/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( './../../zeros' );
24+
var slice = require( './../../slice' );
25+
var E = require( '@stdlib/slice/multi' );
26+
var S = require( '@stdlib/slice/ctor' );
27+
var flags = 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,4,2:4,::-1
39+
E( S( 5, 10 ), 4, S( 2, 4 ), S( null, null, -1 ) ),
40+
41+
// :,:,2,:
42+
E( null, null, 2, null ),
43+
44+
// 1,2,3,:
45+
E( 1, 2, 3, null ),
46+
47+
// 1,3,::2,4::2
48+
E( 1, 3, S( null, null, 2 ), S( 4, null, 2 ) )
49+
];
50+
51+
// Retrieve the flags for 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', JSON.stringify( flags( s ) ) );
57+
}

0 commit comments

Comments
 (0)