About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Base ndarray assertion utilities.
npm install @stdlib/ndarray-base-assertAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch (see README). - If you are using Deno, visit the
denobranch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch (see README).
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var ns = require( '@stdlib/ndarray-base-assert' );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.isOutputDataTypePolicy( value ): test if an input value is a supported ndarray output data type policy.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.isScalarMostlySafeCompatible( value, dtype ): determine whether a scalar value can be safely cast or, for floating-point data types, downcast to specified 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.
var objectKeys = require( '@stdlib/utils-keys' );
var ns = require( '@stdlib/ndarray-base-assert' );
console.log( objectKeys( ns ) );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.
See LICENSE.
Copyright © 2016-2025. The Stdlib Authors.
