Return the flags of a provided ndarray.
npm install @stdlib/ndarray-base-flagsWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return the flags of a provided [ndarray][@stdlib/ndarray/base/ctor].
``bash`
npm install @stdlib/ndarray-base-flags
`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
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
var o = flags( x, true );
// returns {...}
var bool = ( x.flags === o );
// returns false
`
`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
// 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 ) ) );
}
`
*
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-flags.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-flags
[test-image]: https://github.com/stdlib-js/ndarray-base-flags/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/ndarray-base-flags/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-flags/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-flags?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/ndarray-base-flags/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-base-flags/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-base-flags/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-base-flags/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-base-flags/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-base-flags/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-base-flags/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-flags/main/LICENSE
[@stdlib/ndarray/base/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-base-ctor