Skip to content

Commit 9682b81

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent c2f7fb5 commit 9682b81

File tree

5 files changed

+311
-6
lines changed

5 files changed

+311
-6
lines changed

‎CHANGELOG.md

+117-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,108 @@
1010

1111
### Packages
1212

13+
<section class="package" id="array-unreleased">
14+
15+
#### [@stdlib/array](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array)
16+
17+
<details>
18+
19+
<section class="features">
20+
21+
##### Features
22+
23+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190)
24+
25+
</section>
26+
27+
<!-- /.features -->
28+
29+
<section class="breaking-changes">
30+
31+
##### BREAKING CHANGES
32+
33+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations
34+
35+
- 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.
36+
37+
</section>
38+
39+
<!-- /.breaking-changes -->
40+
41+
</details>
42+
43+
</section>
44+
45+
<!-- /.package -->
46+
47+
<section class="package" id="array-base-unreleased">
48+
49+
#### [@stdlib/array/base](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base)
50+
51+
<details>
52+
53+
<section class="features">
54+
55+
##### Features
56+
57+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190)
58+
59+
</section>
60+
61+
<!-- /.features -->
62+
63+
<section class="breaking-changes">
64+
65+
##### BREAKING CHANGES
66+
67+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations
68+
69+
- 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.
70+
71+
</section>
72+
73+
<!-- /.breaking-changes -->
74+
75+
</details>
76+
77+
</section>
78+
79+
<!-- /.package -->
80+
81+
<section class="package" id="array-base-assert-unreleased">
82+
83+
#### [@stdlib/array/base/assert](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert)
84+
85+
<details>
86+
87+
<section class="features">
88+
89+
##### Features
90+
91+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190)
92+
93+
</section>
94+
95+
<!-- /.features -->
96+
97+
<section class="breaking-changes">
98+
99+
##### BREAKING CHANGES
100+
101+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations
102+
103+
- 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.
104+
105+
</section>
106+
107+
<!-- /.breaking-changes -->
108+
109+
</details>
110+
111+
</section>
112+
113+
<!-- /.package -->
114+
13115
<section class="package" id="array-fixed-endian-factory-unreleased">
14116

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

50152
<!-- /.packages -->
51153

154+
<section class="breaking-changes">
155+
156+
### BREAKING CHANGES
157+
158+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations
159+
160+
- 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.
161+
162+
</section>
163+
164+
<!-- /.breaking-changes -->
165+
52166
<section class="issues">
53167

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

66180
### Contributors
67181

68-
A total of 2 people contributed to this release. Thank you to the following contributors:
182+
A total of 3 people contributed to this release. Thank you to the following contributors:
69183

70184
- Aayush Khanna
71185
- Athan Reines
186+
- Philipp Burckhardt
72187

73188
</section>
74189

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

81196
<details>
82197

198+
- [`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)_
83199
- [`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)_
84200
- [`956a462`](https://github.com/stdlib-js/stdlib/commit/956a4624c788689b1bca285856b987ea3aa32eb6) - **feat:** add `forEach` method _(by Athan Reines)_
85201
- [`de1ef8b`](https://github.com/stdlib-js/stdlib/commit/de1ef8ba5e2d7dd1363bdf826572456f49b7895c) - **docs:** fix example _(by Athan Reines)_

‎CONTRIBUTORS

+1
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ Ruthwik Chikoti <[email protected]>
8585
Ryan Seal <[email protected]>
8686
Sai Srikar Dumpeti <[email protected]>
8787
SarthakPaandey <[email protected]>
88+
Saurabh Singh <[email protected]>
8889
Seyyed Parsa Neshaei <[email protected]>
8990
Shashank Shekhar Singh <[email protected]>
9091
Shivam <[email protected]>

‎base/assert/docs/types/index.d.ts

+61
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,13 @@
2121
/* eslint-disable max-lines */
2222

2323
import contains = require( './../../../../base/assert/contains' );
24+
import hasEqualValues = require( './../../../../base/assert/has-equal-values' );
25+
import hasEqualValuesIndexed = require( './../../../../base/assert/has-equal-values-indexed' );
2426
import hasSameValues = require( './../../../../base/assert/has-same-values' );
2527
import isAccessorArray = require( './../../../../base/assert/is-accessor-array' );
2628
import isBooleanDataType = require( './../../../../base/assert/is-boolean-data-type' );
2729
import isBooleanArray = require( './../../../../base/assert/is-booleanarray' );
30+
import isByteOrder = require( './../../../../base/assert/is-byte-order' );
2831
import isComplexFloatingPointDataType = require( './../../../../base/assert/is-complex-floating-point-data-type' );
2932
import isComplexTypedArray = require( './../../../../base/assert/is-complex-typed-array' );
3033
import isComplex64Array = require( './../../../../base/assert/is-complex64array' );
@@ -69,6 +72,46 @@ interface Namespace {
6972
*/
7073
contains: typeof contains;
7174

75+
/**
76+
* Tests if two arrays have equal values.
77+
*
78+
* ## Notes
79+
*
80+
* - If provided arrays of unequal length, the function returns `false`.
81+
*
82+
* @param x - first input array
83+
* @param y - second input array
84+
* @returns boolean indicating whether both arrays have equal values
85+
*
86+
* @example
87+
* var x = [ 0, 0, 1, 0 ];
88+
* var y = [ 0, 0, 1, 0 ];
89+
*
90+
* var out = ns.hasEqualValues( x, y );
91+
* // returns true
92+
*/
93+
hasEqualValues: typeof hasEqualValues;
94+
95+
/**
96+
* Tests if two indexed arrays have equal values.
97+
*
98+
* ## Notes
99+
*
100+
* - If provided arrays of unequal length, the function returns `false`.
101+
*
102+
* @param x - first input array
103+
* @param y - second input array
104+
* @returns boolean indicating whether both arrays have equal values
105+
*
106+
* @example
107+
* var x = [ 0, 0, 1, 0 ];
108+
* var y = [ 0, 0, 1, 0 ];
109+
*
110+
* var out = ns.hasEqualValuesIndexed( x, y );
111+
* // returns true
112+
*/
113+
hasEqualValuesIndexed: typeof hasEqualValuesIndexed;
114+
72115
/**
73116
* Tests if two arrays have the same values.
74117
*
@@ -178,6 +221,24 @@ interface Namespace {
178221
*/
179222
isBooleanArray: typeof isBooleanArray;
180223

224+
/**
225+
* Tests whether an input value is a supported array byte order.
226+
*
227+
* @param v - value to test
228+
* @returns boolean indicating whether an input value is a supported array byte order
229+
*
230+
* @example
231+
* var bool = ns.isByteOrder( 'little-endian' );
232+
* // returns true
233+
*
234+
* bool = ns.isByteOrder( 'big-endian' );
235+
* // returns true
236+
*
237+
* bool = ns.isByteOrder( 'foo' );
238+
* // returns false
239+
*/
240+
isByteOrder: typeof isByteOrder;
241+
181242
/**
182243
* Tests whether an input value is a supported array complex-valued floating-point data type.
183244
*

0 commit comments

Comments
 (0)