Skip to content

Commit 9c98ebb

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 96c246f commit 9c98ebb

File tree

11 files changed

+920
-0
lines changed

11 files changed

+920
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
### Features
1212

13+
- [`b1b2f82`](https://github.com/stdlib-js/stdlib/commit/b1b2f828fa547d05f7659b9bcb076aa0e32e28e5) - add `ndarray/flipud` [(#8588)](https://github.com/stdlib-js/stdlib/pull/8588)
1314
- [`f1fbeb4`](https://github.com/stdlib-js/stdlib/commit/f1fbeb47d9a2a6672bc9690b0b006534168e904a) - add `ndarray/fliplr` [(#8589)](https://github.com/stdlib-js/stdlib/pull/8589)
1415
- [`a2fd4d6`](https://github.com/stdlib-js/stdlib/commit/a2fd4d6929c7af4f33ebe97d53fec4b7a9bcbf33) - add `ndarray/some` [(#8514)](https://github.com/stdlib-js/stdlib/pull/8514)
1516
- [`4b6f051`](https://github.com/stdlib-js/stdlib/commit/4b6f0510d4773574101122924f20cb4d987c2b38) - add `complementShape` to namespace
@@ -642,6 +643,7 @@ A total of 34 issues were closed in this release:
642643

643644
<details>
644645

646+
- [`b1b2f82`](https://github.com/stdlib-js/stdlib/commit/b1b2f828fa547d05f7659b9bcb076aa0e32e28e5) - **feat:** add `ndarray/flipud` [(#8588)](https://github.com/stdlib-js/stdlib/pull/8588) _(by Muhammad Haris, Athan Reines)_
645647
- [`f1fbeb4`](https://github.com/stdlib-js/stdlib/commit/f1fbeb47d9a2a6672bc9690b0b006534168e904a) - **feat:** add `ndarray/fliplr` [(#8589)](https://github.com/stdlib-js/stdlib/pull/8589) _(by Muhammad Haris)_
646648
- [`c520b5a`](https://github.com/stdlib-js/stdlib/commit/c520b5a0cae0c85e946f8a646e7cc8c01b3b5673) - **docs:** address TSDoc lint errors and add doctest aliases _(by Philipp Burckhardt)_
647649
- [`3f7b1ed`](https://github.com/stdlib-js/stdlib/commit/3f7b1ed405cdb77a3357d424f462e8d3b2276df5) - **docs:** fix code in TSDoc examples _(by Philipp Burckhardt)_

‎flipud/README.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# flipud
22+
23+
> Return a **read-only** view of an input [`ndarray`][@stdlib/ndarray/ctor] in which the order of elements along the second-to-last dimension is reversed.
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro section element. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var flipud = require( '@stdlib/ndarray/flipud' );
41+
```
42+
43+
#### flipud( x )
44+
45+
Returns a read-only view of an input [`ndarray`][@stdlib/ndarray/ctor] in which the order of elements along the second-to-last dimension is reversed.
46+
47+
```javascript
48+
var array = require( '@stdlib/ndarray/array' );
49+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
50+
51+
var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], {
52+
'shape': [ 3, 2 ]
53+
});
54+
// returns <ndarray>
55+
56+
var arr = ndarray2array( x );
57+
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
58+
59+
var y = flipud( x );
60+
// returns <ndarray>
61+
62+
arr = ndarray2array( y );
63+
// returns [ [ 5.0, 6.0 ], [ 3.0, 4.0 ], [ 1.0, 2.0 ] ]
64+
```
65+
66+
</section>
67+
68+
<!-- /.usage -->
69+
70+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
71+
72+
<section class="notes">
73+
74+
</section>
75+
76+
<!-- /.notes -->
77+
78+
<!-- Package usage examples. -->
79+
80+
<section class="examples">
81+
82+
## Examples
83+
84+
<!-- eslint no-undef: "error" -->
85+
86+
```javascript
87+
var uniform = require( '@stdlib/random/uniform' );
88+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
89+
var flipud = require( '@stdlib/ndarray/flipud' );
90+
91+
var x = uniform( [ 3, 3, 3 ], -10.0, 10.0 );
92+
console.log( ndarray2array( x ) );
93+
94+
var y = flipud( x );
95+
console.log( ndarray2array( y ) );
96+
```
97+
98+
</section>
99+
100+
<!-- /.examples -->
101+
102+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
103+
104+
<section class="references">
105+
106+
</section>
107+
108+
<!-- /.references -->
109+
110+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
111+
112+
<section class="related">
113+
114+
</section>
115+
116+
<!-- /.related -->
117+
118+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
119+
120+
<section class="links">
121+
122+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
123+
124+
<!-- <related-links> -->
125+
126+
<!-- </related-links> -->
127+
128+
</section>
129+
130+
<!-- /.links -->

‎flipud/benchmark/benchmark.js‎

Lines changed: 223 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
25+
var empty = require( './../../empty' );
26+
var pkg = require( './../package.json' ).name;
27+
var flipud = require( './../lib' );
28+
29+
30+
// MAIN //
31+
32+
bench( pkg+'::0d', function benchmark( b ) {
33+
var values;
34+
var v;
35+
var i;
36+
37+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
38+
39+
values = [
40+
41+
empty( [], { 'dtype': 'float64' } ),
42+
empty( [], { 'dtype': 'float32' } ),
43+
empty( [], { 'dtype': 'int32' } ),
44+
empty( [], { 'dtype': 'complex128' } ),
45+
empty( [], { 'dtype': 'generic' } )
46+
];
47+
48+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
49+
50+
b.tic();
51+
for ( i = 0; i < b.iterations; i++ ) {
52+
v = flipud( values[ i%values.length ] );
53+
if ( typeof v !== 'object' ) {
54+
b.fail( 'should return an ndarray' );
55+
}
56+
}
57+
b.toc();
58+
if ( !isndarrayLike( v ) ) {
59+
b.fail( 'should return an ndarray' );
60+
}
61+
b.pass( 'benchmark finished' );
62+
b.end();
63+
});
64+
65+
bench( pkg+'::1d', function benchmark( b ) {
66+
var values;
67+
var v;
68+
var i;
69+
70+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
71+
72+
values = [
73+
empty( [ 2 ], { 'dtype': 'float64' } ),
74+
empty( [ 2 ], { 'dtype': 'float32' } ),
75+
empty( [ 2 ], { 'dtype': 'int32' } ),
76+
empty( [ 2 ], { 'dtype': 'complex128' } ),
77+
empty( [ 2 ], { 'dtype': 'generic' } )
78+
];
79+
80+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
81+
82+
b.tic();
83+
for ( i = 0; i < b.iterations; i++ ) {
84+
v = flipud( values[ i%values.length ] );
85+
if ( typeof v !== 'object' ) {
86+
b.fail( 'should return an ndarray' );
87+
}
88+
}
89+
b.toc();
90+
if ( !isndarrayLike( v ) ) {
91+
b.fail( 'should return an ndarray' );
92+
}
93+
b.pass( 'benchmark finished' );
94+
b.end();
95+
});
96+
97+
bench( pkg+'::2d', function benchmark( b ) {
98+
var values;
99+
var v;
100+
var i;
101+
102+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
103+
104+
values = [
105+
empty( [ 2, 2 ], { 'dtype': 'float64' } ),
106+
empty( [ 2, 2 ], { 'dtype': 'float32' } ),
107+
empty( [ 2, 2 ], { 'dtype': 'int32' } ),
108+
empty( [ 2, 2 ], { 'dtype': 'complex128' } ),
109+
empty( [ 2, 2 ], { 'dtype': 'generic' } )
110+
];
111+
112+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
113+
114+
b.tic();
115+
for ( i = 0; i < b.iterations; i++ ) {
116+
v = flipud( values[ i%values.length ] );
117+
if ( typeof v !== 'object' ) {
118+
b.fail( 'should return an ndarray' );
119+
}
120+
}
121+
b.toc();
122+
if ( !isndarrayLike( v ) ) {
123+
b.fail( 'should return an ndarray' );
124+
}
125+
b.pass( 'benchmark finished' );
126+
b.end();
127+
});
128+
129+
bench( pkg+'::3d', function benchmark( b ) {
130+
var values;
131+
var v;
132+
var i;
133+
134+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
135+
136+
values = [
137+
empty( [ 2, 2, 2 ], { 'dtype': 'float64' } ),
138+
empty( [ 2, 2, 2 ], { 'dtype': 'float32' } ),
139+
empty( [ 2, 2, 2 ], { 'dtype': 'int32' } ),
140+
empty( [ 2, 2, 2 ], { 'dtype': 'complex128' } ),
141+
empty( [ 2, 2, 2 ], { 'dtype': 'generic' } )
142+
];
143+
144+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
145+
146+
b.tic();
147+
for ( i = 0; i < b.iterations; i++ ) {
148+
v = flipud( values[ i%values.length ] );
149+
if ( typeof v !== 'object' ) {
150+
b.fail( 'should return an ndarray' );
151+
}
152+
}
153+
b.toc();
154+
if ( !isndarrayLike( v ) ) {
155+
b.fail( 'should return an ndarray' );
156+
}
157+
b.pass( 'benchmark finished' );
158+
b.end();
159+
});
160+
161+
bench( pkg+'::4d', function benchmark( b ) {
162+
var values;
163+
var v;
164+
var i;
165+
166+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
167+
168+
values = [
169+
empty( [ 2, 2, 2, 2 ], { 'dtype': 'float64' } ),
170+
empty( [ 2, 2, 2, 2 ], { 'dtype': 'float32' } ),
171+
empty( [ 2, 2, 2, 2 ], { 'dtype': 'int32' } ),
172+
empty( [ 2, 2, 2, 2 ], { 'dtype': 'complex128' } ),
173+
empty( [ 2, 2, 2, 2 ], { 'dtype': 'generic' } )
174+
];
175+
176+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
177+
178+
b.tic();
179+
for ( i = 0; i < b.iterations; i++ ) {
180+
v = flipud( values[ i%values.length ] );
181+
if ( typeof v !== 'object' ) {
182+
b.fail( 'should return an ndarray' );
183+
}
184+
}
185+
b.toc();
186+
if ( !isndarrayLike( v ) ) {
187+
b.fail( 'should return an ndarray' );
188+
}
189+
b.pass( 'benchmark finished' );
190+
b.end();
191+
});
192+
193+
bench( pkg+'::5d', function benchmark( b ) {
194+
var values;
195+
var v;
196+
var i;
197+
198+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
199+
200+
values = [
201+
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'float64' } ),
202+
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'float32' } ),
203+
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'int32' } ),
204+
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'complex128' } ),
205+
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'generic' } )
206+
];
207+
208+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
209+
210+
b.tic();
211+
for ( i = 0; i < b.iterations; i++ ) {
212+
v = flipud( values[ i%values.length ] );
213+
if ( typeof v !== 'object' ) {
214+
b.fail( 'should return an ndarray' );
215+
}
216+
}
217+
b.toc();
218+
if ( !isndarrayLike( v ) ) {
219+
b.fail( 'should return an ndarray' );
220+
}
221+
b.pass( 'benchmark finished' );
222+
b.end();
223+
});

0 commit comments

Comments
 (0)