Skip to content

Commit cb7cf8c

Browse files
headlessNodekgryte
headlessNode
and
kgryte
authored
feat: add ndarray/reverse-dimension
PR-URL: #8186 Closes: stdlib-js/metr-issue-tracker#99 Ref: #2656 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent bc45275 commit cb7cf8c

File tree

10 files changed

+1120
-0
lines changed

10 files changed

+1120
-0
lines changed

‎lib/node_modules/@stdlib/ndarray/reverse-dimension/README.md‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
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+
# reverseDimension
22+
23+
> Return a **read-only** view of an input [`ndarray`][@stdlib/ndarray/ctor] in which the order of elements along a specified 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 reverseDimension = require( '@stdlib/ndarray/reverse-dimension' );
41+
```
42+
43+
#### reverseDimension( x, dim )
44+
45+
Returns a read-only view of an input [`ndarray`][@stdlib/ndarray/ctor] in which the order of elements along a specified 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 = reverseDimension( x, 0 );
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+
The function accepts the following arguments:
67+
68+
- **x**: input ndarray.
69+
- **dim**: index of dimension along which to reverse elements. If provided an integer less than zero, the dimension index is resolved relative to the last dimension, with the last dimension corresponding to the value `-1`.
70+
71+
</section>
72+
73+
<!-- /.usage -->
74+
75+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
76+
77+
<section class="notes">
78+
79+
</section>
80+
81+
<!-- /.notes -->
82+
83+
<!-- Package usage examples. -->
84+
85+
<section class="examples">
86+
87+
## Examples
88+
89+
<!-- eslint no-undef: "error" -->
90+
91+
```javascript
92+
var uniform = require( '@stdlib/random/uniform' );
93+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
94+
var reverseDimension = require( '@stdlib/ndarray/reverse-dimension' );
95+
96+
var x = uniform( [ 3, 3, 3 ], -10.0, 10.0 );
97+
console.log( ndarray2array( x ) );
98+
99+
var y = reverseDimension( x, 0 );
100+
console.log( ndarray2array( y ) );
101+
```
102+
103+
</section>
104+
105+
<!-- /.examples -->
106+
107+
<!-- 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. -->
108+
109+
<section class="references">
110+
111+
</section>
112+
113+
<!-- /.references -->
114+
115+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
116+
117+
<section class="related">
118+
119+
</section>
120+
121+
<!-- /.related -->
122+
123+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
124+
125+
<section class="links">
126+
127+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
128+
129+
<!-- <related-links> -->
130+
131+
<!-- </related-links> -->
132+
133+
</section>
134+
135+
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/reverse-dimension/benchmark/benchmark.js‎

Lines changed: 222 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
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( '@stdlib/ndarray/empty' );
26+
var pkg = require( './../package.json' ).name;
27+
var reverseDimension = require( './../lib' );
28+
29+
30+
// MAIN //
31+
32+
bench( pkg+'::1d', 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+
empty( [ 2 ], { 'dtype': 'float64' } ),
41+
empty( [ 2 ], { 'dtype': 'float32' } ),
42+
empty( [ 2 ], { 'dtype': 'int32' } ),
43+
empty( [ 2 ], { 'dtype': 'complex128' } ),
44+
empty( [ 2 ], { 'dtype': 'generic' } )
45+
];
46+
47+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
48+
49+
b.tic();
50+
for ( i = 0; i < b.iterations; i++ ) {
51+
v = reverseDimension( values[ i%values.length ], 0 );
52+
if ( typeof v !== 'object' ) {
53+
b.fail( 'should return an ndarray' );
54+
}
55+
}
56+
b.toc();
57+
if ( !isndarrayLike( v ) ) {
58+
b.fail( 'should return an ndarray' );
59+
}
60+
b.pass( 'benchmark finished' );
61+
b.end();
62+
});
63+
64+
bench( pkg+'::2d,dim=0', function benchmark( b ) {
65+
var values;
66+
var v;
67+
var i;
68+
69+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
70+
71+
values = [
72+
empty( [ 2, 2 ], { 'dtype': 'float64' } ),
73+
empty( [ 2, 2 ], { 'dtype': 'float32' } ),
74+
empty( [ 2, 2 ], { 'dtype': 'int32' } ),
75+
empty( [ 2, 2 ], { 'dtype': 'complex128' } ),
76+
empty( [ 2, 2 ], { 'dtype': 'generic' } )
77+
];
78+
79+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
80+
81+
b.tic();
82+
for ( i = 0; i < b.iterations; i++ ) {
83+
v = reverseDimension( values[ i%values.length ], 0 );
84+
if ( typeof v !== 'object' ) {
85+
b.fail( 'should return an ndarray' );
86+
}
87+
}
88+
b.toc();
89+
if ( !isndarrayLike( v ) ) {
90+
b.fail( 'should return an ndarray' );
91+
}
92+
b.pass( 'benchmark finished' );
93+
b.end();
94+
});
95+
96+
bench( pkg+'::2d,dim=1', function benchmark( b ) {
97+
var values;
98+
var v;
99+
var i;
100+
101+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
102+
103+
values = [
104+
empty( [ 2, 2 ], { 'dtype': 'float64' } ),
105+
empty( [ 2, 2 ], { 'dtype': 'float32' } ),
106+
empty( [ 2, 2 ], { 'dtype': 'int32' } ),
107+
empty( [ 2, 2 ], { 'dtype': 'complex128' } ),
108+
empty( [ 2, 2 ], { 'dtype': 'generic' } )
109+
];
110+
111+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
112+
113+
b.tic();
114+
for ( i = 0; i < b.iterations; i++ ) {
115+
v = reverseDimension( values[ i%values.length ], 1 );
116+
if ( typeof v !== 'object' ) {
117+
b.fail( 'should return an ndarray' );
118+
}
119+
}
120+
b.toc();
121+
if ( !isndarrayLike( v ) ) {
122+
b.fail( 'should return an ndarray' );
123+
}
124+
b.pass( 'benchmark finished' );
125+
b.end();
126+
});
127+
128+
bench( pkg+'::3d,dim=0', function benchmark( b ) {
129+
var values;
130+
var v;
131+
var i;
132+
133+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
134+
135+
values = [
136+
empty( [ 2, 2, 2 ], { 'dtype': 'float64' } ),
137+
empty( [ 2, 2, 2 ], { 'dtype': 'float32' } ),
138+
empty( [ 2, 2, 2 ], { 'dtype': 'int32' } ),
139+
empty( [ 2, 2, 2 ], { 'dtype': 'complex128' } ),
140+
empty( [ 2, 2, 2 ], { 'dtype': 'generic' } )
141+
];
142+
143+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
144+
145+
b.tic();
146+
for ( i = 0; i < b.iterations; i++ ) {
147+
v = reverseDimension( values[ i%values.length ], 0 );
148+
if ( typeof v !== 'object' ) {
149+
b.fail( 'should return an ndarray' );
150+
}
151+
}
152+
b.toc();
153+
if ( !isndarrayLike( v ) ) {
154+
b.fail( 'should return an ndarray' );
155+
}
156+
b.pass( 'benchmark finished' );
157+
b.end();
158+
});
159+
160+
bench( pkg+'::3d,dim=1', function benchmark( b ) {
161+
var values;
162+
var v;
163+
var i;
164+
165+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
166+
167+
values = [
168+
empty( [ 2, 2, 2 ], { 'dtype': 'float64' } ),
169+
empty( [ 2, 2, 2 ], { 'dtype': 'float32' } ),
170+
empty( [ 2, 2, 2 ], { 'dtype': 'int32' } ),
171+
empty( [ 2, 2, 2 ], { 'dtype': 'complex128' } ),
172+
empty( [ 2, 2, 2 ], { 'dtype': 'generic' } )
173+
];
174+
175+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
176+
177+
b.tic();
178+
for ( i = 0; i < b.iterations; i++ ) {
179+
v = reverseDimension( values[ i%values.length ], 1 );
180+
if ( typeof v !== 'object' ) {
181+
b.fail( 'should return an ndarray' );
182+
}
183+
}
184+
b.toc();
185+
if ( !isndarrayLike( v ) ) {
186+
b.fail( 'should return an ndarray' );
187+
}
188+
b.pass( 'benchmark finished' );
189+
b.end();
190+
});
191+
192+
bench( pkg+'::3d,dim=2', function benchmark( b ) {
193+
var values;
194+
var v;
195+
var i;
196+
197+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
198+
199+
values = [
200+
empty( [ 2, 2, 2 ], { 'dtype': 'float64' } ),
201+
empty( [ 2, 2, 2 ], { 'dtype': 'float32' } ),
202+
empty( [ 2, 2, 2 ], { 'dtype': 'int32' } ),
203+
empty( [ 2, 2, 2 ], { 'dtype': 'complex128' } ),
204+
empty( [ 2, 2, 2 ], { 'dtype': 'generic' } )
205+
];
206+
207+
/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
208+
209+
b.tic();
210+
for ( i = 0; i < b.iterations; i++ ) {
211+
v = reverseDimension( values[ i%values.length ], 2 );
212+
if ( typeof v !== 'object' ) {
213+
b.fail( 'should return an ndarray' );
214+
}
215+
}
216+
b.toc();
217+
if ( !isndarrayLike( v ) ) {
218+
b.fail( 'should return an ndarray' );
219+
}
220+
b.pass( 'benchmark finished' );
221+
b.end();
222+
});

‎lib/node_modules/@stdlib/ndarray/reverse-dimension/docs/repl.txt‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
{{alias}}( x, dim )
3+
Returns a read-only view of an input ndarray in which the order of elements
4+
along a specified dimension is reversed.
5+
6+
Parameters
7+
----------
8+
x: ndarray
9+
Input array.
10+
11+
dim: integer
12+
Index of dimension to reverse. If provided an integer less than zero,
13+
the dimension index is resolved relative to the last dimension, with the
14+
last dimension corresponding to the value `-1`.
15+
16+
Returns
17+
-------
18+
out: ndarray
19+
A read-only view of an input ndarray in which the order of elements
20+
along a specified dimension is reversed.
21+
22+
Examples
23+
--------
24+
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
25+
<ndarray>
26+
> {{alias:@stdlib/ndarray/to-array}}( x )
27+
[ [ 1, 2 ], [ 3, 4 ] ]
28+
> var y = {{alias}}( x, 0 )
29+
<ndarray>
30+
> {{alias:@stdlib/ndarray/to-array}}( y )
31+
[ [ 3, 4 ], [ 1, 2 ] ]
32+
33+
See Also
34+
--------

0 commit comments

Comments
 (0)