Auto-generated commit

base/flags/README.md

@@ -0,0 +1,160 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2023 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# flags
+
+> Return the flags of a provided [ndarray][@stdlib/ndarray/base/ctor].
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var flags = require( '@stdlib/ndarray/base/flags' );
+```
+
+#### flags( x, copy )
+
+Returns the flags of a provided [ndarray][@stdlib/ndarray/base/ctor].
+
+```javascript
+var zeros = require( '@stdlib/ndarray/zeros' );
+
+var x = zeros( [ 3, 2, 3 ] );
+// returns <ndarray>
+
+var o = flags( x, false );
+// returns {...}
+```
+
+When `copy` is `false`, changes to the returned object may mutate the input [ndarray][@stdlib/ndarray/base/ctor] flags. If there is a chance that the returned object will be mutated (either directly or by downstream consumers), set `copy` to `true` to prevent unintended side effects.
+
+```javascript
+var zeros = require( '@stdlib/ndarray/zeros' );
+
+var x = zeros( [ 3, 2, 3 ] );
+// returns <ndarray>
+
+var o = flags( x, true );
+// returns {...}
+
+var bool = ( x.flags === o );
+// returns false
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+<!-- eslint-disable new-cap -->
+
+```javascript
+var zeros = require( '@stdlib/ndarray/zeros' );
+var slice = require( '@stdlib/ndarray/slice' );
+var E = require( '@stdlib/slice/multi' );
+var S = require( '@stdlib/slice/ctor' );
+var flags = require( '@stdlib/ndarray/base/flags' );
+
+// Create an array:
+var x = zeros( [ 10, 10, 10, 10 ] );
+// returns <ndarray>
+
+// Define some slices:
+var slices = [
+    // :,:,:,:
+    E( null, null, null, null ),
+
+    // 5:10,4,2:4,::-1
+    E( S( 5, 10 ), 4, S( 2, 4 ), S( null, null, -1 ) ),
+
+    // :,:,2,:
+    E( null, null, 2, null ),
+
+    // 1,2,3,:
+    E( 1, 2, 3, null ),
+
+    // 1,3,::2,4::2
+    E( 1, 3, S( null, null, 2 ), S( 4, null, 2 ) )
+];
+
+// Retrieve the flags for each slice...
+var s;
+var i;
+for ( i = 0; i < slices.length; i++ ) {
+    s = slice( x, slices[ i ] );
+    console.log( '%s', JSON.stringify( flags( s, false ) ) );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- 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. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/ndarray/base/ctor]: https://github.com/stdlib-js/ndarray/tree/main/base/ctor
+
+</section>
+
+<!-- /.links -->

base/flags/benchmark/benchmark.js

@@ -0,0 +1,82 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var zeros = require( './../../../zeros' );
+var isPlainObject = require( '@stdlib/assert/is-plain-object' );
+var pkg = require( './../package.json' ).name;
+var flags = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+':copy=false', function benchmark( b ) {
+	var values;
+	var out;
+	var i;
+
+	values = [
+		zeros( [ 10, 10, 10, 1 ] ),
+		zeros( [ 5, 5, 5, 1, 1 ] ),
+		zeros( [ 3, 4, 5 ] )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = flags( values[ i%values.length ], false );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isPlainObject( out ) ) {
+		b.fail( 'should return an object' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+':copy=true', function benchmark( b ) {
+	var values;
+	var out;
+	var i;
+
+	values = [
+		zeros( [ 10, 10, 10, 1 ] ),
+		zeros( [ 5, 5, 5, 1, 1 ] ),
+		zeros( [ 3, 4, 5 ] )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = flags( values[ i%values.length ], true );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isPlainObject( out ) ) {
+		b.fail( 'should return an object' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

base/flags/docs/repl.txt

@@ -0,0 +1,30 @@
+
+{{alias}}( x, copy )
+    Returns the flags of a provided ndarray.
+
+    Parameters
+    ----------
+    x: ndarray
+        Input ndarray.
+
+    copy: boolean
+        Boolean indicating whether to explicitly copy the value assigned to the
+        input ndarray's `flags` property. When `copy` is `false`, changes to the
+        returned object may mutate the input ndarray strides. If there is a
+        chance that the returned object will be mutated (either directly or by
+        downstream consumers), set `copy` to `true` to prevent unintended side
+        effects.
+
+    Returns
+    -------
+    out: Object
+        Flags.
+
+    Examples
+    --------
+    > var out = {{alias}}( {{alias:@stdlib/ndarray/zeros}}( [ 3, 3, 3 ] ), false )
+    {...}
+
+    See Also
+    --------
+

base/flags/docs/types/index.d.ts

@@ -0,0 +1,67 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Flags and other meta information (e.g., memory layout of the array).
+*/
+interface Flags {
+	/**
+	* Boolean indicating if an array is row-major contiguous.
+	*/
+	ROW_MAJOR_CONTIGUOUS?: boolean;
+
+	/**
+	* Boolean indicating if an array is column-major contiguous.
+	*/
+	COLUMN_MAJOR_CONTIGUOUS?: boolean;
+
+	/**
+	* Boolean indicating if an array is read-only.
+	*/
+	READONLY?: boolean;
+}
+
+/**
+* Returns the flags of a provided ndarray.
+*
+* ## Notes
+*
+* -   When `copy` is `false`, changes to the returned object may mutate the input ndarray flags. If there is a chance that the returned object will be mutated (either directly or by downstream consumers), set `copy` to `true` to prevent unintended side effects.
+*
+* @param x - input ndarray
+* @param copy - boolean indicating whether to explicitly copy the value assigned to the input ndarray's `flags` property
+* @returns flags
+*
+* @example
+* var zeros = require( `@stdlib/ndarray/zeros` );
+*
+* var o = flags( zeros( [ 3, 3, 3 ] ), false );
+* // returns {...}
+*/
+declare function flags( x: ndarray, copy: boolean ): Flags;
+
+
+// EXPORTS //
+
+export = flags;