Skip to content
Merged
Changes from all commits
Commits
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
22 changes: 22 additions & 0 deletions lib/node_modules/@stdlib/array/base/assert/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

import contains = require( '@stdlib/array/base/assert/contains' );
import hasAlmostEqualValues = require( '@stdlib/array/base/assert/has-almost-equal-values' );
import hasAlmostSameValues = require( '@stdlib/array/base/assert/has-almost-same-values' );
import hasEqualValues = require( '@stdlib/array/base/assert/has-equal-values' );
import hasEqualValuesIndexed = require( '@stdlib/array/base/assert/has-equal-values-indexed' );
import hasSameValues = require( '@stdlib/array/base/assert/has-same-values' );
Expand Down Expand Up @@ -95,6 +96,27 @@ interface Namespace {
*/
hasAlmostEqualValues: typeof hasAlmostEqualValues;

/**
* Tests if two arrays have respective elements which are approximately the same value within a specified number of ULPs (units in the last place).
*
* ## Notes
*
* - If provided arrays of unequal length, the function returns `false`.
*
* @param x - first input array
* @param y - second input array
* @param maxULP - maximum allowed ULP difference
* @returns boolean indicating whether both arrays are approximately the same value
*
* @example
* var x = [ 0, 0, 1, 0 ];
* var y = [ 0, 0, 1, 0 ];
*
* var out = ns.hasAlmostSameValues( x, y, 0 );
* // returns true
*/
hasAlmostSameValues: typeof hasAlmostSameValues;

/**
* Tests if two arrays have equal values.
*
Expand Down