README
Assert
Base ndarray assertion utilities.
Installation
npm install @stdlib/ndarray-base-assert
Usage
var ns = require( '@stdlib/ndarray-base-assert' );
ns
Base ndarray assertion utilities.
var o = ns;
// returns {...}
isAllowedDataTypeCast( from, to, casting )
: determine whether an ndarray data type can be cast to another ndarray data type according to a specified casting mode.isBufferLengthCompatibleShape( len, shape )
: determine if a buffer length is compatible with an array shape.isBufferLengthCompatible( len, shape, strides, offset )
: determine if a buffer length is compatible with ndarray meta data.isCastingMode( value )
: test if an input value is a supported ndarray casting mode.isColumnMajorContiguous( shape, strides, offset )
: determine if an array is column-major contiguous.isColumnMajor( strides )
: given a stride array, determine whether an array is column-major.isContiguous( shape, strides, offset )
: determine if an array is contiguous.isDataType( value )
: test if an input value is a supported ndarray data type.isIndexMode( value )
: test if an input value is a supported ndarray index mode.isOrder( value )
: test if an input value is an ndarray order.isRowMajorContiguous( shape, strides, offset )
: determine if an array is row-major contiguous.isRowMajor( strides )
: given a stride array, determine whether an array is row-major.isSafeDataTypeCast( from, to )
: determine whether an ndarray data type can be safely cast to another ndarray data type.isSameKindDataTypeCast( from, to )
: determine whether an ndarray data type can be safely cast to, or is of the same "kind" as, another ndarray data type.isSingleSegmentCompatible( shape, strides, offset )
: determine if an array is compatible with a single memory segment.
Examples
var objectKeys = require( '@stdlib/utils-keys' );
var ns = require( '@stdlib/ndarray-base-assert' );
console.log( objectKeys( ns ) );
Notice
This package is part of 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, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2022. The Stdlib Authors.