assert

Base array assertion utilities.

Installation

npm install @stdlib/array-base-assert

Usage

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

ns

Assertion utilities.

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

The namespace exports the following:

• contains( x, value ): test if an array contains a provided search value.
• hasAlmostEqualValues( x, y, maxULP ): test if two arrays have respective elements which are approximately equal within a specified number of ULPs (units in the last place).
• hasAlmostSameValues( x, y, maxULP ): test if two arrays have respective elements which are approximately the same value within a specified number of ULPs (units in the last place).
• hasEqualValuesIndexed( x, y ): test if two indexed arrays have equal values.
• hasEqualValues( x, y ): test if two arrays have equal values.
• hasSameValues( x, y ): test if two arrays have the same values.
• isAccessorArray( value ): test if an array-like object supports the accessor (get/set) protocol.
• isBooleanDataType( value ): test if an input value is a supported array boolean data type.
• isBooleanArray( value ): test if a value is a BooleanArray.
• isByteOrder( value ): test if an input value is a supported array byte order.
• isComplexFloatingPointDataType( value ): test if an input value is a supported array complex-valued floating-point data type.
• isComplexTypedArray( value ): test if a value is a complex typed array.
• isComplex128Array( value ): test if a value is a Complex128Array.
• isComplex64Array( value ): test if a value is a Complex64Array.
• isDataType( value ): test if an input value is a supported array data type.
• isFloatingPointDataType( value ): test if an input value is a supported array floating-point data type.
• isIntegerDataType( value ): test if an input value is a supported array integer data type.
• isMostlySafeDataTypeCast( from, to ): determine whether an array data type can be safely cast or, for floating-point data types, downcast to another array data type.
• isNumericDataType( value ): test if an input value is a supported array numeric data type.
• isRealDataType( value ): test if an input value is a supported array real-valued data type.
• isRealFloatingPointDataType( value ): test if an input value is a supported array real-valued floating-point data type.
• isSafeDataTypeCast( from, to ): determine whether an array data type can be safely cast to another array data type.
• isSameKindDataTypeCast( from, to ): determine whether an array data type can be safely cast to, or is of the same "kind" as, another array data type.
• isSignedIntegerDataType( value ): test if an input value is a supported array signed integer data type.
• isSortedAscending( x ): test if an array is sorted in ascending order.
• isUnsignedIntegerDataType( value ): test if an input value is a supported array unsigned integer data type.

Examples

var ns = require( '@stdlib/array-base-assert' );
var dtype = require( '@stdlib/array-dtype' );
var Float64Array = require( '@stdlib/array-float64' );
var Int32Array = require( '@stdlib/array-int32' );
var Uint8Array = require( '@stdlib/array-uint8' );
var Complex128Array = require( '@stdlib/array-complex128' );

// Create various arrays:
var arr1 = new Float64Array( [ 1.1, 2.2, 3.3 ] );
var arr2 = new Int32Array( [ 1, 2, 3 ] );
var arr3 = new Uint8Array( [ 1, 2, 3 ] );
var arr4 = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0 ] ); // two complex numbers: 1+1i, 2+2i

// Get data types:
var dt1 = dtype( arr1 );
var dt2 = dtype( arr2 );
var dt3 = dtype( arr3 );
var dt4 = dtype( arr4 );

// Check data types:
console.log( dt1 + ' is floating-point data type: ' + ns.isFloatingPointDataType( dt1 ) );
// => 'float64 is floating-point data type: true'

console.log( dt2 + ' is integer data type: ' + ns.isIntegerDataType( dt2 ) );
// => 'int32 is integer data type: true'

console.log( dt3 + ' is unsigned integer data type: ' + ns.isUnsignedIntegerDataType( dt3 ) );
// => 'uint8 is unsigned integer data type: true'

console.log( dt4 + ' is complex floating-point data type: ' + ns.isComplexFloatingPointDataType( dt4 ) );
// => 'complex128 is complex floating-point data type: true'

// Check if arrays have the same values:
console.log( 'arr2 and arr3 have same values: ' + ns.hasSameValues( arr2, arr3 ) );
// => 'arr2 and arr3 have same values: true'

console.log( 'arr1 and arr2 have same values: ' + ns.hasSameValues( arr1, arr2 ) );
// => 'arr1 and arr2 have same values: false'

// Check safe data type casts:
console.log( 'Can safely cast from ' + dt2 + ' to ' + dt1 + ': ' + ns.isSafeDataTypeCast( dt2, dt1 ) );
// => 'Can safely cast from int32 to float64: true'

console.log( 'Can safely cast from ' + dt1 + ' to ' + dt2 + ': ' + ns.isSafeDataTypeCast( dt1, dt2 ) );
// => 'Can safely cast from float64 to int32: false'

console.log( 'Can safely cast from ' + dt3 + ' to ' + dt2 + ': ' + ns.isSafeDataTypeCast( dt3, dt2 ) );
// => 'Can safely cast from uint8 to int32: true'

console.log( 'Can safely cast from ' + dt4 + ' to ' + dt1 + ': ' + ns.isSafeDataTypeCast( dt4, dt1 ) );
// => 'Can safely cast from complex128 to float64: false'

// Check if arrays contain specific values:
console.log( 'arr1 contains 2.2: ' + ns.contains( arr1, 2.2 ) );
// => 'arr1 contains 2.2: true'

console.log( 'arr2 contains 2: ' + ns.contains( arr2, 2 ) );
// => 'arr2 contains 2: true'

console.log( 'arr2 contains 2.2: ' + ns.contains( arr2, 2.2 ) );
// => 'arr2 contains 2.2: false'

// Check complex array types:
console.log( 'arr4 is Complex128Array: ' + ns.isComplex128Array( arr4 ) );
// => 'arr4 is Complex128Array: true'

console.log( 'arr4 is complex typed array: ' + ns.isComplexTypedArray( arr4 ) );
// => 'arr4 is complex typed array: true'

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-2026. The Stdlib Authors.