Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Nov 20, 2024
1 parent c2f7fb5 commit 9682b81
Show file tree
Hide file tree
Showing 5 changed files with 311 additions and 6 deletions.
118 changes: 117 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,108 @@

### Packages

<section class="package" id="array-unreleased">

#### [@stdlib/array](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array)

<details>

<section class="features">

##### Features

- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190)

</section>

<!-- /.features -->

<section class="breaking-changes">

##### BREAKING CHANGES

- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations

- To migrate, users should consult the corresponding packages containing the respective implementations to determine what is breaking. The primary breakages come from the `blas/*` namespace, where we recently refactored how top-level BLAS APIs operate on input arguments.

</section>

<!-- /.breaking-changes -->

</details>

</section>

<!-- /.package -->

<section class="package" id="array-base-unreleased">

#### [@stdlib/array/base](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base)

<details>

<section class="features">

##### Features

- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190)

</section>

<!-- /.features -->

<section class="breaking-changes">

##### BREAKING CHANGES

- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations

- To migrate, users should consult the corresponding packages containing the respective implementations to determine what is breaking. The primary breakages come from the `blas/*` namespace, where we recently refactored how top-level BLAS APIs operate on input arguments.

</section>

<!-- /.breaking-changes -->

</details>

</section>

<!-- /.package -->

<section class="package" id="array-base-assert-unreleased">

#### [@stdlib/array/base/assert](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert)

<details>

<section class="features">

##### Features

- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190)

</section>

<!-- /.features -->

<section class="breaking-changes">

##### BREAKING CHANGES

- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations

- To migrate, users should consult the corresponding packages containing the respective implementations to determine what is breaking. The primary breakages come from the `blas/*` namespace, where we recently refactored how top-level BLAS APIs operate on input arguments.

</section>

<!-- /.breaking-changes -->

</details>

</section>

<!-- /.package -->

<section class="package" id="array-fixed-endian-factory-unreleased">

#### [@stdlib/array/fixed-endian-factory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/fixed-endian-factory)
Expand Down Expand Up @@ -49,6 +151,18 @@ This release closes the following issue:

<!-- /.packages -->

<section class="breaking-changes">

### BREAKING CHANGES

- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations

- To migrate, users should consult the corresponding packages containing the respective implementations to determine what is breaking. The primary breakages come from the `blas/*` namespace, where we recently refactored how top-level BLAS APIs operate on input arguments.

</section>

<!-- /.breaking-changes -->

<section class="issues">

### Closed Issues
Expand All @@ -65,10 +179,11 @@ This release closes the following issue:

### Contributors

A total of 2 people contributed to this release. Thank you to the following contributors:
A total of 3 people contributed to this release. Thank you to the following contributors:

- Aayush Khanna
- Athan Reines
- Philipp Burckhardt

</section>

Expand All @@ -80,6 +195,7 @@ A total of 2 people contributed to this release. Thank you to the following cont

<details>

- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - **feat:** update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190) _(by stdlib-bot, Philipp Burckhardt)_
- [`b34732c`](https://github.com/stdlib-js/stdlib/commit/b34732cf655db60fbc798e12952f88c3edb07eaf) - **feat:** add `at` method to `array/fixed-endian-factory` [(#3184)](https://github.com/stdlib-js/stdlib/pull/3184) _(by Aayush Khanna, Athan Reines)_
- [`956a462`](https://github.com/stdlib-js/stdlib/commit/956a4624c788689b1bca285856b987ea3aa32eb6) - **feat:** add `forEach` method _(by Athan Reines)_
- [`de1ef8b`](https://github.com/stdlib-js/stdlib/commit/de1ef8ba5e2d7dd1363bdf826572456f49b7895c) - **docs:** fix example _(by Athan Reines)_
Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ Ruthwik Chikoti <[email protected]>
Ryan Seal <[email protected]>
Sai Srikar Dumpeti <[email protected]>
SarthakPaandey <[email protected]>
Saurabh Singh <[email protected]>
Seyyed Parsa Neshaei <[email protected]>
Shashank Shekhar Singh <[email protected]>
Shivam <[email protected]>
Expand Down
61 changes: 61 additions & 0 deletions base/assert/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@
/* eslint-disable max-lines */

import contains = require( './../../../../base/assert/contains' );
import hasEqualValues = require( './../../../../base/assert/has-equal-values' );
import hasEqualValuesIndexed = require( './../../../../base/assert/has-equal-values-indexed' );
import hasSameValues = require( './../../../../base/assert/has-same-values' );
import isAccessorArray = require( './../../../../base/assert/is-accessor-array' );
import isBooleanDataType = require( './../../../../base/assert/is-boolean-data-type' );
import isBooleanArray = require( './../../../../base/assert/is-booleanarray' );
import isByteOrder = require( './../../../../base/assert/is-byte-order' );
import isComplexFloatingPointDataType = require( './../../../../base/assert/is-complex-floating-point-data-type' );
import isComplexTypedArray = require( './../../../../base/assert/is-complex-typed-array' );
import isComplex64Array = require( './../../../../base/assert/is-complex64array' );
Expand Down Expand Up @@ -69,6 +72,46 @@ interface Namespace {
*/
contains: typeof contains;

/**
* Tests if two arrays have equal values.
*
* ## Notes
*
* - If provided arrays of unequal length, the function returns `false`.
*
* @param x - first input array
* @param y - second input array
* @returns boolean indicating whether both arrays have equal values
*
* @example
* var x = [ 0, 0, 1, 0 ];
* var y = [ 0, 0, 1, 0 ];
*
* var out = ns.hasEqualValues( x, y );
* // returns true
*/
hasEqualValues: typeof hasEqualValues;

/**
* Tests if two indexed arrays have equal values.
*
* ## Notes
*
* - If provided arrays of unequal length, the function returns `false`.
*
* @param x - first input array
* @param y - second input array
* @returns boolean indicating whether both arrays have equal values
*
* @example
* var x = [ 0, 0, 1, 0 ];
* var y = [ 0, 0, 1, 0 ];
*
* var out = ns.hasEqualValuesIndexed( x, y );
* // returns true
*/
hasEqualValuesIndexed: typeof hasEqualValuesIndexed;

/**
* Tests if two arrays have the same values.
*
Expand Down Expand Up @@ -178,6 +221,24 @@ interface Namespace {
*/
isBooleanArray: typeof isBooleanArray;

/**
* Tests whether an input value is a supported array byte order.
*
* @param v - value to test
* @returns boolean indicating whether an input value is a supported array byte order
*
* @example
* var bool = ns.isByteOrder( 'little-endian' );
* // returns true
*
* bool = ns.isByteOrder( 'big-endian' );
* // returns true
*
* bool = ns.isByteOrder( 'foo' );
* // returns false
*/
isByteOrder: typeof isByteOrder;

/**
* Tests whether an input value is a supported array complex-valued floating-point data type.
*
Expand Down
Loading

0 comments on commit 9682b81

Please sign in to comment.