Assert

Base ndarray assertion utilities.

Usage

var ns = require( '@stdlib/ndarray/base/assert' );

ns

Base ndarray assertion utilities.

var o = ns;
// returns {...}

hasEqualShape( x, y ): test if two ndarrays have the same shape.
isAllowedDataTypeCast( from, to, casting ): determine whether an ndarray data type can be cast to another ndarray data type according to a specified casting mode.
isBooleanDataType( value ): test if an input value is a supported ndarray boolean data type.
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.
isColumnMajorString( value ): test whether an input value is the string representing column-major order.
isColumnMajor( strides ): given a stride array, determine whether an array is column-major.
isComplexFloatingPointDataType( value ): test if an input value is a supported ndarray complex-valued floating-point data type.
isContiguous( shape, strides, offset ): determine if an array is contiguous.
isDataType( value ): test if an input value is a supported ndarray data type.
isFloatingPointDataType( value ): test if an input value is a supported ndarray floating-point data type.
isIndexMode( value ): test if an input value is a supported ndarray index mode.
isIntegerDataType( value ): test if an input value is a supported ndarray integer data type.
isMostlySafeDataTypeCast( from, to ): determine whether an ndarray data type can be safely cast or, for floating-point data types, downcast to another ndarray data type.
isNumericDataType( value ): test if an input value is a supported ndarray numeric data type.
isOrder( value ): test if an input value is an ndarray order.
isReadOnly( arr ): test if an ndarray is read-only.
isRealDataType( value ): test if an input value is a supported ndarray real-valued data type.
isRealFloatingPointDataType( value ): test if an input value is a supported ndarray real-valued floating-point data type.
isRowMajorContiguous( shape, strides, offset ): determine if an array is row-major contiguous.
isRowMajorString( value ): test whether an input value is the string representing row-major order.
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.
isSignedIntegerDataType( value ): test if an input value is a supported ndarray signed integer data type.
isSingleSegmentCompatible( shape, strides, offset ): determine if an array is compatible with a single memory segment.
isUnsignedIntegerDataType( value ): test if an input value is a supported ndarray unsigned integer data type.

Examples

var objectKeys = require( '@stdlib/utils/keys' );
var ns = require( '@stdlib/ndarray/base/assert' );

console.log( objectKeys( ns ) );