flag

Return a specified flag for a provided ndarray.

Usage

var flag = require( '@stdlib/ndarray/flag' );

flag( x, name )

Returns a specified flag for a provided ndarray.

var zeros = require( '@stdlib/ndarray/zeros' );

var x = zeros( [ 3, 2, 3 ] );
// returns <ndarray>

var o = flag( x, 'READONLY' );
// returns <boolean>

Notes

• This function is intended as a slight performance optimization over @stdlib/ndarray/flags when only a single flag is needed. For retrieving multiple flags, use @stdlib/ndarray/flags directly.

Examples

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 flag = require( '@stdlib/ndarray/flag' );

// 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 ) )
];

// Check whether each slice is row-major contiguous...
var s;
var i;
for ( i = 0; i < slices.length; i++ ) {
    s = slice( x, slices[ i ] );
    console.log( '%s', flag( s, 'ROW_MAJOR_CONTIGUOUS' ) );
}

---

See Also

• @stdlib/ndarray/array: multidimensional arrays.
• @stdlib/ndarray/ctor: multidimensional array constructor.
• @stdlib/ndarray/flags: return the flags of a provided ndarray.