Skip to content

Commit 192c5ef

Browse files
committed
Auto-generated commit
1 parent 72de97e commit 192c5ef

8 files changed

Lines changed: 21 additions & 67 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,3 +202,4 @@ jsconfig.json
202202
####################
203203
CLAUDE.md
204204
GEMINI.md
205+
.claude/

‎CHANGELOG.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<section class="release" id="unreleased">
66

7-
## Unreleased (2026-08-08)
7+
## Unreleased (2026-08-12)
88

99
<section class="features">
1010

@@ -76,6 +76,7 @@ A total of 2 issues were closed in this release:
7676

7777
<details>
7878

79+
- [`29ec5d9`](https://github.com/stdlib-js/stdlib/commit/29ec5d9165c51810c9184116873893c8356cedfe) - **docs:** improve doctests for ndarray instances in `ndarray/every` [(#14179)](https://github.com/stdlib-js/stdlib/pull/14179) _(by Aryan Sharma)_
7980
- [`40156b8`](https://github.com/stdlib-js/stdlib/commit/40156b8c1f21cea5031108711ab00dfcaee4508c) - **docs:** update related packages sections [(#14038)](https://github.com/stdlib-js/stdlib/pull/14038) _(by stdlib-bot)_
8081
- [`f19d370`](https://github.com/stdlib-js/stdlib/commit/f19d370e0a194ac8ffed4916f8b8b51ecfe5896f) - **chore:** clean-up [(#14016)](https://github.com/stdlib-js/stdlib/pull/14016) _(by Philipp Burckhardt)_
8182
- [`58556f4`](https://github.com/stdlib-js/stdlib/commit/58556f408eedf1737bc4795fb2734ef4dd2a6b32) - **chore:** clean-up [(#13978)](https://github.com/stdlib-js/stdlib/pull/13978) _(by Philipp Burckhardt)_
@@ -184,8 +185,9 @@ A total of 2 issues were closed in this release:
184185

185186
### Contributors
186187

187-
A total of 6 people contributed to this release. Thank you to the following contributors:
188+
A total of 7 people contributed to this release. Thank you to the following contributors:
188189

190+
- Aryan Sharma
189191
- Ashutosh Choubey
190192
- Athan Reines
191193
- Muhammad Haris

‎every/README.md‎

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,7 @@ var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
4949

5050
// Perform reduction:
5151
var out = every( x );
52-
// returns <ndarray>
53-
54-
var v = out.get();
55-
// returns true
52+
// returns <ndarray>[ true ]
5653
```
5754

5855
The function accepts the following arguments:
@@ -69,7 +66,6 @@ By default, the function performs a reduction over all elements in a provided [`
6966

7067
```javascript
7168
var array = require( '@stdlib/ndarray/array' );
72-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
7369

7470
// Create an input ndarray:
7571
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
@@ -79,17 +75,13 @@ var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
7975
var out = every( x, {
8076
'dims': [ 1, 2 ]
8177
});
82-
// returns <ndarray>
83-
84-
var v = ndarray2array( out );
85-
// returns [ true, true, true ]
78+
// returns <ndarray>[ true, true, true ]
8679
```
8780

8881
By default, the function returns an [`ndarray`][@stdlib/ndarray/ctor] having a shape matching only the non-reduced dimensions of the input [`ndarray`][@stdlib/ndarray/ctor] (i.e., the reduced dimensions are dropped). To include the reduced dimensions as singleton dimensions in the output [`ndarray`][@stdlib/ndarray/ctor], set the `keepdims` option to `true`.
8982

9083
```javascript
9184
var array = require( '@stdlib/ndarray/array' );
92-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
9385

9486
// Create an input ndarray:
9587
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
@@ -100,10 +92,7 @@ var out = every( x, {
10092
'dims': [ 1, 2 ],
10193
'keepdims': true
10294
});
103-
// returns <ndarray>
104-
105-
var v = ndarray2array( out );
106-
// returns [ [ [ true ] ], [ [ true ] ], [ [ true ] ] ]
95+
// returns <ndarray>[ [ [ true ] ], [ [ true ] ], [ [ true ] ] ]
10796
```
10897

10998
#### every.assign( x, out\[, options] )
@@ -125,13 +114,10 @@ var y = empty( [], {
125114

126115
// Perform reduction:
127116
var out = every.assign( x, y );
128-
// returns <ndarray>
117+
// returns <ndarray>[ true ]
129118

130119
var bool = ( out === y );
131120
// returns true
132-
133-
var v = y.get();
134-
// returns true
135121
```
136122

137123
The function accepts the following arguments:
@@ -149,7 +135,6 @@ By default, the function performs a reduction over all elements in a provided [`
149135
```javascript
150136
var array = require( '@stdlib/ndarray/array' );
151137
var empty = require( '@stdlib/ndarray/empty' );
152-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
153138

154139
// Create an input ndarray:
155140
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
@@ -164,12 +149,10 @@ var y = empty( [ 3 ], {
164149
var out = every.assign( x, y, {
165150
'dims': [ 1, 2 ]
166151
});
152+
// returns <ndarray>[ true, true, true ]
167153

168154
var bool = ( out === y );
169155
// returns true
170-
171-
var v = ndarray2array( y );
172-
// returns [ true, true, true ]
173156
```
174157

175158
</section>

‎every/docs/repl.txt‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,9 @@
2929
--------
3030
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 1.0 ], [ 1.0, 1.0 ] ] );
3131
> var y = {{alias}}( x )
32-
<ndarray>
33-
> y.get()
34-
true
32+
<ndarray>[ true ]
3533
> y = {{alias}}( x, { 'keepdims': true } )
36-
<ndarray>
37-
> {{alias:@stdlib/ndarray/to-array}}( y )
38-
[ [ true ] ]
39-
> y.get( 0, 0 )
40-
true
34+
<ndarray>[ [ true ] ]
4135

4236

4337
{{alias}}.assign( x, y[, options] )
@@ -71,11 +65,9 @@
7165
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 1.0 ], [ 1.0, 1.0 ] ] );
7266
> var y = {{alias:@stdlib/ndarray/from-scalar}}( false );
7367
> var out = {{alias}}.assign( x, y )
74-
<ndarray>
68+
<ndarray>[ true ]
7569
> var bool = ( out === y )
7670
true
77-
> y.get()
78-
true
7971

8072
See Also
8173
--------

‎every/docs/types/index.d.ts‎

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,7 @@ interface Every {
7777
*
7878
* // Perform reduction:
7979
* var out = every( x );
80-
* // returns <ndarray>
81-
*
82-
* var v = out.get();
83-
* // returns true
80+
* // returns <ndarray>[ true ]
8481
*/
8582
( x: ndarray, options?: Options ): boolndarray;
8683

@@ -120,10 +117,7 @@ interface Every {
120117
*
121118
* // Perform reduction:
122119
* var out = every.assign( x, y );
123-
* // returns <ndarray>
124-
*
125-
* var v = out.get();
126-
* // returns true
120+
* // returns <ndarray>[ true ]
127121
*/
128122
assign<T extends ndarray = ndarray>( x: ndarray, y: T, options?: BaseOptions ): T;
129123
}
@@ -158,10 +152,7 @@ interface Every {
158152
*
159153
* // Perform reduction:
160154
* var out = every( x );
161-
* // returns <ndarray>
162-
*
163-
* var v = out.get();
164-
* // returns true
155+
* // returns <ndarray>[ true ]
165156
*
166157
* @example
167158
* var Float64Array = require( '@stdlib/array/float64' );
@@ -190,10 +181,7 @@ interface Every {
190181
*
191182
* // Perform reduction:
192183
* var out = every.assign( x, y );
193-
* // returns <ndarray>
194-
*
195-
* var v = out.get();
196-
* // returns true
184+
* // returns <ndarray>[ true ]
197185
*/
198186
declare var every: Every;
199187

‎every/lib/assign.js‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,7 @@ var validate = require( './validate.js' );
7373
*
7474
* // Perform reduction:
7575
* var out = assign( x, y );
76-
* // returns <ndarray>
77-
*
78-
* var v = out.get();
79-
* // returns true
76+
* // returns <ndarray>[ true ]
8077
*/
8178
function assign( x, y, options ) {
8279
var opts;

‎every/lib/index.js‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,7 @@
4545
*
4646
* // Perform reduction:
4747
* var out = every( x );
48-
* // returns <ndarray>
49-
*
50-
* var v = out.get();
51-
* // returns true
48+
* // returns <ndarray>[ true ]
5249
*
5350
* @example
5451
* var Float64Array = require( '@stdlib/array/float64' );
@@ -78,10 +75,7 @@
7875
*
7976
* // Perform reduction:
8077
* var out = every.assign( x, y );
81-
* // returns <ndarray>
82-
*
83-
* var v = out.get();
84-
* // returns true
78+
* // returns <ndarray>[ true ]
8579
*/
8680

8781
// MODULES //

‎every/lib/main.js‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,7 @@ var validate = require( './validate.js' );
7878
*
7979
* // Perform reduction:
8080
* var out = every( x );
81-
* // returns <ndarray>
82-
*
83-
* var v = out.get();
84-
* // returns true
81+
* // returns <ndarray>[ true ]
8582
*/
8683
function every( x, options ) {
8784
var opts;

0 commit comments

Comments
 (0)