# Assert > Base ndarray assertion utilities.
## Usage ```javascript var ns = require( '@stdlib/ndarray/base/assert' ); ``` #### ns Base ndarray assertion utilities. ```javascript var o = ns; // returns {...} ```
- [`hasEqualShape( x, y )`][@stdlib/ndarray/base/assert/has-equal-shape]: test if two ndarrays have the same shape. - [`isAllowedDataTypeCast( from, to, casting )`][@stdlib/ndarray/base/assert/is-allowed-data-type-cast]: determine whether an ndarray data type can be cast to another ndarray data type according to a specified casting mode. - [`isBooleanDataType( value )`][@stdlib/ndarray/base/assert/is-boolean-data-type]: test if an input value is a supported ndarray boolean data type. - [`isBooleanIndexDataType( value )`][@stdlib/ndarray/base/assert/is-boolean-index-data-type]: test if an input value is a supported ndarray boolean index data type. - [`isBufferLengthCompatibleShape( len, shape )`][@stdlib/ndarray/base/assert/is-buffer-length-compatible-shape]: determine if a buffer length is compatible with an array shape. - [`isBufferLengthCompatible( len, shape, strides, offset )`][@stdlib/ndarray/base/assert/is-buffer-length-compatible]: determine if a buffer length is compatible with ndarray meta data. - [`isCastingMode( value )`][@stdlib/ndarray/base/assert/is-casting-mode]: test if an input value is a supported ndarray casting mode. - [`isColumnMajorContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-column-major-contiguous]: determine if an array is column-major contiguous. - [`isColumnMajorString( value )`][@stdlib/ndarray/base/assert/is-column-major-string]: test whether an input value is the string representing column-major order. - [`isColumnMajor( strides )`][@stdlib/ndarray/base/assert/is-column-major]: given a stride array, determine whether an array is column-major. - [`isComplexFloatingPointDataTypeChar( value )`][@stdlib/ndarray/base/assert/is-complex-floating-point-data-type-char]: test if an input value is a supported ndarray complex-valued floating-point data type single letter character abbreviation. - [`isComplexFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-complex-floating-point-data-type]: test if an input value is a supported ndarray complex-valued floating-point data type. - [`isContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-contiguous]: determine if an array is contiguous. - [`isDataTypeObject( value )`][@stdlib/ndarray/base/assert/is-data-type-object]: test if an input value is an ndarray data type object. - [`isDataTypeString( value )`][@stdlib/ndarray/base/assert/is-data-type-string]: test if an input value is a supported built-in ndarray data type string. - [`isDataType( value )`][@stdlib/ndarray/base/assert/is-data-type]: test if an input value is a supported ndarray data type. - [`isEqualDataType( v1, v2 )`][@stdlib/ndarray/base/assert/is-equal-data-type]: test whether two values are equal ndarray data types. - [`isFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-floating-point-data-type]: test if an input value is a supported ndarray floating-point data type. - [`isIndexDataType( value )`][@stdlib/ndarray/base/assert/is-index-data-type]: test if an input value is a supported ndarray index data type. - [`isIndexMode( value )`][@stdlib/ndarray/base/assert/is-index-mode]: test if an input value is a supported ndarray index mode. - [`isInputCastingPolicy( value )`][@stdlib/ndarray/base/assert/is-input-casting-policy]: test if an input value is a supported input ndarray casting policy. - [`isIntegerDataType( value )`][@stdlib/ndarray/base/assert/is-integer-data-type]: test if an input value is a supported ndarray integer data type. - [`isIntegerIndexDataType( value )`][@stdlib/ndarray/base/assert/is-integer-index-data-type]: test if an input value is a supported ndarray integer index data type. - [`isMaskIndexDataType( value )`][@stdlib/ndarray/base/assert/is-mask-index-data-type]: test if an input value is a supported ndarray mask index data type. - [`isMostlySafeDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast]: determine whether an ndarray data type can be safely cast or, for floating-point data types, downcast to another ndarray data type. - [`isNumericDataType( value )`][@stdlib/ndarray/base/assert/is-numeric-data-type]: test if an input value is a supported ndarray numeric data type. - [`isOrder( value )`][@stdlib/ndarray/base/assert/is-order]: test if an input value is an ndarray order. - [`isOutputDataTypePolicy( value )`][@stdlib/ndarray/base/assert/is-output-data-type-policy]: test if an input value is a supported ndarray output data type policy. - [`isReadOnly( arr )`][@stdlib/ndarray/base/assert/is-read-only]: test if an ndarray is **read-only**. - [`isRealDataType( value )`][@stdlib/ndarray/base/assert/is-real-data-type]: test if an input value is a supported ndarray real-valued data type. - [`isRealFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-real-floating-point-data-type]: test if an input value is a supported ndarray real-valued floating-point data type. - [`isRowMajorContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-row-major-contiguous]: determine if an array is row-major contiguous. - [`isRowMajorString( value )`][@stdlib/ndarray/base/assert/is-row-major-string]: test whether an input value is the string representing row-major order. - [`isRowMajor( strides )`][@stdlib/ndarray/base/assert/is-row-major]: given a stride array, determine whether an array is row-major. - [`isSafeDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-safe-data-type-cast]: determine whether an ndarray data type can be safely cast to another ndarray data type. - [`isSameKindDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-same-kind-data-type-cast]: determine whether an ndarray data type can be safely cast to, or is of the same "kind" as, another ndarray data type. - [`isScalarMostlySafeCompatible( value, dtype )`][@stdlib/ndarray/base/assert/is-scalar-mostly-safe-compatible]: determine whether a scalar value can be safely cast or, for floating-point data types, downcast to specified ndarray data type. - [`isSignedIntegerDataType( value )`][@stdlib/ndarray/base/assert/is-signed-integer-data-type]: test if an input value is a supported ndarray signed integer data type. - [`isSingleSegmentCompatible( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-single-segment-compatible]: determine if an array is compatible with a single memory segment. - [`isStructDataType( value )`][@stdlib/ndarray/base/assert/is-struct-data-type]: test if an input value is a supported ndarray struct data type. - [`isUnsignedIntegerDataType( value )`][@stdlib/ndarray/base/assert/is-unsigned-integer-data-type]: test if an input value is a supported ndarray unsigned integer data type.
## Examples ```javascript var objectKeys = require( '@stdlib/utils/keys' ); var ns = require( '@stdlib/ndarray/base/assert' ); console.log( objectKeys( ns ) ); ```
[@stdlib/ndarray/base/assert/has-equal-shape]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/has-equal-shape [@stdlib/ndarray/base/assert/is-allowed-data-type-cast]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-allowed-data-type-cast [@stdlib/ndarray/base/assert/is-boolean-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-boolean-data-type [@stdlib/ndarray/base/assert/is-boolean-index-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-boolean-index-data-type [@stdlib/ndarray/base/assert/is-buffer-length-compatible-shape]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-buffer-length-compatible-shape [@stdlib/ndarray/base/assert/is-buffer-length-compatible]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-buffer-length-compatible [@stdlib/ndarray/base/assert/is-casting-mode]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-casting-mode [@stdlib/ndarray/base/assert/is-column-major-contiguous]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-column-major-contiguous [@stdlib/ndarray/base/assert/is-column-major-string]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-column-major-string [@stdlib/ndarray/base/assert/is-column-major]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-column-major [@stdlib/ndarray/base/assert/is-complex-floating-point-data-type-char]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-complex-floating-point-data-type-char [@stdlib/ndarray/base/assert/is-complex-floating-point-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-complex-floating-point-data-type [@stdlib/ndarray/base/assert/is-contiguous]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-contiguous [@stdlib/ndarray/base/assert/is-data-type-object]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-data-type-object [@stdlib/ndarray/base/assert/is-data-type-string]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-data-type-string [@stdlib/ndarray/base/assert/is-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-data-type [@stdlib/ndarray/base/assert/is-equal-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-equal-data-type [@stdlib/ndarray/base/assert/is-floating-point-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-floating-point-data-type [@stdlib/ndarray/base/assert/is-index-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-index-data-type [@stdlib/ndarray/base/assert/is-index-mode]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-index-mode [@stdlib/ndarray/base/assert/is-input-casting-policy]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-input-casting-policy [@stdlib/ndarray/base/assert/is-integer-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-integer-data-type [@stdlib/ndarray/base/assert/is-integer-index-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-integer-index-data-type [@stdlib/ndarray/base/assert/is-mask-index-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-mask-index-data-type [@stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-mostly-safe-data-type-cast [@stdlib/ndarray/base/assert/is-numeric-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-numeric-data-type [@stdlib/ndarray/base/assert/is-order]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-order [@stdlib/ndarray/base/assert/is-output-data-type-policy]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-output-data-type-policy [@stdlib/ndarray/base/assert/is-read-only]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-read-only [@stdlib/ndarray/base/assert/is-real-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-real-data-type [@stdlib/ndarray/base/assert/is-real-floating-point-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-real-floating-point-data-type [@stdlib/ndarray/base/assert/is-row-major-contiguous]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-row-major-contiguous [@stdlib/ndarray/base/assert/is-row-major-string]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-row-major-string [@stdlib/ndarray/base/assert/is-row-major]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-row-major [@stdlib/ndarray/base/assert/is-safe-data-type-cast]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-safe-data-type-cast [@stdlib/ndarray/base/assert/is-same-kind-data-type-cast]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-same-kind-data-type-cast [@stdlib/ndarray/base/assert/is-scalar-mostly-safe-compatible]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-scalar-mostly-safe-compatible [@stdlib/ndarray/base/assert/is-signed-integer-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-signed-integer-data-type [@stdlib/ndarray/base/assert/is-single-segment-compatible]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-single-segment-compatible [@stdlib/ndarray/base/assert/is-struct-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-struct-data-type [@stdlib/ndarray/base/assert/is-unsigned-integer-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-unsigned-integer-data-type