README.md

Assert

Base ndarray assertion utilities.

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