Skip to content

Commit a44f4d3

Browse files
headlessNodekgryte
headlessNode
and
kgryte
authored
feat: add ndarray/rotr90
PR-URL: #11631 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Closes: stdlib-js/metr-issue-tracker#300
1 parent abd06b9 commit a44f4d3

10 files changed

Lines changed: 1228 additions & 0 deletions

File tree

‎lib/node_modules/@stdlib/ndarray/rotr90/README.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2026 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+
# rotr90
22+
23+
> Return a **read-only** view of a matrix (or a stack of matrices) rotated `90` degrees clockwise.
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 rotr90 = require( '@stdlib/ndarray/rotr90' );
41+
```
42+
43+
#### rotr90( x, k )
44+
45+
Returns a read-only view of a matrix (or a stack of matrices) rotated `90` degrees clockwise.
46+
47+
```javascript
48+
var array = require( '@stdlib/ndarray/array' );
49+
50+
var x = array( [ [ 1.0, 2.0, 3.0 ], [ 4.0, 5.0, 6.0 ] ] );
51+
// returns <ndarray>[ [ 1.0, 2.0, 3.0 ], [ 4.0, 5.0, 6.0 ] ]
52+
53+
var y = rotr90( x, 1 );
54+
// returns <ndarray>[ [ 4.0, 1.0 ], [ 5.0, 2.0 ], [ 6.0, 3.0 ] ]
55+
```
56+
57+
The function accepts the following arguments:
58+
59+
- **x**: input [`ndarray`][@stdlib/ndarray/ctor].
60+
- **k**: number of times to rotate by `90` degrees. Positive values rotate clockwise. Negative values rotate counterclockwise.
61+
62+
</section>
63+
64+
<!-- /.usage -->
65+
66+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
67+
68+
<section class="notes">
69+
70+
## Notes
71+
72+
- If `k > 0`, the function rotates the matrix clockwise.
73+
- If `k < 0`, the function rotates the matrix counterclockwise.
74+
- If provided an [`ndarray`][@stdlib/ndarray/ctor] with fewer than two dimensions, the function does not perform rotation and simply returns a new view of the input [`ndarray`][@stdlib/ndarray/ctor].
75+
76+
</section>
77+
78+
<!-- /.notes -->
79+
80+
<!-- Package usage examples. -->
81+
82+
<section class="examples">
83+
84+
## Examples
85+
86+
<!-- eslint no-undef: "error" -->
87+
88+
```javascript
89+
var uniform = require( '@stdlib/random/uniform' );
90+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
91+
var rotr90 = require( '@stdlib/ndarray/rotr90' );
92+
93+
var x = uniform( [ 3, 3, 3 ], -10.0, 10.0 );
94+
console.log( ndarray2array( x ) );
95+
96+
var y = rotr90( x, 1 );
97+
console.log( ndarray2array( y ) );
98+
```
99+
100+
</section>
101+
102+
<!-- /.examples -->
103+
104+
<!-- 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. -->
105+
106+
<section class="references">
107+
108+
</section>
109+
110+
<!-- /.references -->
111+
112+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
113+
114+
<section class="related">
115+
116+
</section>
117+
118+
<!-- /.related -->
119+
120+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
121+
122+
<section class="links">
123+
124+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
125+
126+
<!-- <related-links> -->
127+
128+
<!-- </related-links> -->
129+
130+
</section>
131+
132+
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/rotr90/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) 2026 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 format = require( '@stdlib/string/format' );
27+
var pkg = require( './../package.json' ).name;
28+
var rotr90 = require( './../lib' );
29+
30+
31+
// MAIN //
32+
33+
bench( format( '%s:ndims=0', pkg ), function benchmark( b ) {
34+
var values;
35+
var v;
36+
var i;
37+
38+
/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
39+
40+
values = [
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 = rotr90( values[ i%values.length ], 1 );
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( format( '%s:ndims=1', pkg ), 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 = rotr90( values[ i%values.length ], 1 );
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( format( '%s:ndims=2', pkg ), 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 = rotr90( values[ i%values.length ], 1 );
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( format( '%s:ndims=3', pkg ), 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 = rotr90( values[ i%values.length ], 1 );
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( format( '%s:ndims=4', pkg ), 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 = rotr90( values[ i%values.length ], 1 );
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( format( '%s:ndims=5', pkg ), 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 = rotr90( values[ i%values.length ], 1 );
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+
});

‎lib/node_modules/@stdlib/ndarray/rotr90/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, k )
3+
Returns a read-only view of a matrix (or a stack of matrices) rotated 90
4+
degrees clockwise.
5+
6+
If `k > 0`, the function rotates the matrix clockwise. If `k < 0`, the
7+
function rotates the matrix counterclockwise.
8+
9+
If provided an ndarray with fewer than two dimensions, the function does not
10+
perform rotation and simply returns a new view of the input ndarray.
11+
12+
Parameters
13+
----------
14+
x: ndarray
15+
Input array.
16+
17+
k: integer
18+
Number of times to rotate by 90 degrees.
19+
20+
Returns
21+
-------
22+
out: ndarray
23+
A read-only view of a matrix (or a stack of matrices) rotated 90 degrees
24+
clockwise.
25+
26+
Examples
27+
--------
28+
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] )
29+
<ndarray>[ [ 1, 2, 3 ], [ 4, 5, 6 ] ]
30+
> var y = {{alias}}( x, 1 )
31+
<ndarray>[ [ 4, 1 ], [ 5, 2 ], [ 6, 3 ] ]
32+
33+
See Also
34+
--------

0 commit comments

Comments
 (0)