Skip to content

feat: update assert TypeScript declarations #9237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Dec 19, 2025
Merged

feat: update assert TypeScript declarations #9237

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 161 additions & 0 deletions lib/node_modules/@stdlib/assert/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,11 @@ import isAlmostEqualComplex128array = require( '@stdlib/assert/is-almost-equal-c
import isAlmostEqualFloat32array = require( '@stdlib/assert/is-almost-equal-float32array' );
import isAlmostEqualFloat64Array = require( '@stdlib/assert/is-almost-equal-float64array' );
import isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' );
import isAlmostSameValueArray = require( '@stdlib/assert/is-almost-same-value-array' );
import isAlmostSameValueComplex64Array = require( '@stdlib/assert/is-almost-same-value-complex64array' );
import isAlmostSameValueComplex128Array = require( '@stdlib/assert/is-almost-same-value-complex128array' );
import isAlmostSameValueFloat32Array = require( '@stdlib/assert/is-almost-same-value-float32array' );
import isAlmostSameValueFloat64Array = require( '@stdlib/assert/is-almost-same-value-float64array' );
import isAlphagram = require( '@stdlib/assert/is-alphagram' );
import isAlphaNumeric = require( '@stdlib/assert/is-alphanumeric' );
import isAnagram = require( '@stdlib/assert/is-anagram' );
Expand Down Expand Up @@ -1553,6 +1558,162 @@ interface Namespace {
*/
isAlmostSameValue: typeof isAlmostSameValue;

/**
* Tests if two arguments are both generic arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).
*
* ## Notes
*
* - The function differs from the `===` operator in that the function treats `-0` and `+0` as distinct and `NaNs` as the same.
*
* @param v1 - first input value
* @param v2 - second input value
* @param maxULP - maximum allowed ULP difference
* @returns boolean indicating whether two arguments are approximately the same value
*
* @example
* var x = [ 1.0, 2.0, 3.0 ];
* var y = [ 1.0, 2.0, 3.0 ];
*
* var out = ns.isAlmostSameValueArray( x, y, 0 );
* // returns true
*
* @example
* var x = [ 1.0, 2.0, 3.0 ];
* var y = [ 1.0, 2.0, 4.0 ];
*
* var out = ns.isAlmostSameValueArray( x, y, 1 );
* // returns false
*/
isAlmostSameValueArray: typeof isAlmostSameValueArray;

/**
* Tests if two arguments are both Complex64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).
*
* ## Notes
*
* - The function differs from the `===` operator in that the function treats `-0` and `+0` as distinct and `NaNs` as the same.
*
* @param v1 - first input value
* @param v2 - second input value
* @param maxULP - maximum allowed ULP difference
* @returns boolean indicating whether two arguments are approximately the same value
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var y = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
*
* var out = ns.isAlmostSameValueComplex64Array( x, y, 0 );
* // returns true
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var y = new Complex64Array( [ 1.0, 2.0, 4.0, 4.0 ] );
*
* var out = ns.isAlmostSameValueComplex64Array( x, y, 1 );
* // returns false
*/
isAlmostSameValueComplex64Array: typeof isAlmostSameValueComplex64Array;

/**
* Tests if two arguments are both Complex128Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).
*
* ## Notes
*
* - The function differs from the `===` operator in that the function treats `-0` and `+0` as distinct and `NaNs` as the same.
*
* @param v1 - first input value
* @param v2 - second input value
* @param maxULP - maximum allowed ULP difference
* @returns boolean indicating whether two arguments are approximately the same value
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var y = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
*
* var out = ns.isAlmostSameValueComplex128Array( x, y, 0 );
* // returns true
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var y = new Complex128Array( [ 1.0, 2.0, 4.0, 4.0 ] );
*
* var out = ns.isAlmostSameValueComplex128Array( x, y, 1 );
* // returns false
*/
isAlmostSameValueComplex128Array: typeof isAlmostSameValueComplex128Array;

/**
* Tests if two arguments are both Float32Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).
*
* ## Notes
*
* - The function differs from the `===` operator in that the function treats `-0` and `+0` as distinct and `NaNs` as the same.
*
* @param v1 - first input value
* @param v2 - second input value
* @param maxULP - maximum allowed ULP difference
* @returns boolean indicating whether two arguments are approximately the same value
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
* var y = new Float32Array( [ 1.0, 2.0, 3.0 ] );
*
* var out = ns.isAlmostSameValueFloat32Array( x, y, 0 );
* // returns true
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
* var y = new Float32Array( [ 1.0, 2.0, 4.0 ] );
*
* var out = ns.isAlmostSameValueFloat32Array( x, y, 1 );
* // returns false
*/
isAlmostSameValueFloat32Array: typeof isAlmostSameValueFloat32Array;

/**
* Tests if two arguments are both Float64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).
*
* ## Notes
*
* - The function differs from the `===` operator in that the function treats `-0` and `+0` as distinct and `NaNs` as the same.
*
* @param v1 - first input value
* @param v2 - second input value
* @param maxULP - maximum allowed ULP difference
* @returns boolean indicating whether two arguments are approximately the same value
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 3.0 ] );
*
* var out = ns.isAlmostSameValueFloat64Array( x, y, 0 );
* // returns true
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 4.0 ] );
*
* var out = ns.isAlmostSameValueFloat64Array( x, y, 1 );
* // returns false
*/
isAlmostSameValueFloat64Array: typeof isAlmostSameValueFloat64Array;

/**
* Tests if a value is an alphagram (i.e., a sequence of characters arranged in alphabetical order).
*
Expand Down
Loading