Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions lib/node_modules/@stdlib/ndarray/to-flippedud/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
<!--

@license Apache-2.0

Copyright (c) 2026 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# toFlippedud

> Return a new [`ndarray`][@stdlib/ndarray/ctor] where the order of elements along the second-to-last dimension of an input [`ndarray`][@stdlib/ndarray/ctor] is reversed.

<!-- Section to include introductory text. Make sure to keep an empty line after the intro section element. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage

```javascript
var toFlippedud = require( '@stdlib/ndarray/to-flippedud' );
```

#### toFlippedud( x )

Returns a new [`ndarray`][@stdlib/ndarray/ctor] where the order of elements along the second-to-last dimension of an input [`ndarray`][@stdlib/ndarray/ctor] is reversed.

```javascript
var array = require( '@stdlib/ndarray/array' );

var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], {
'shape': [ 3, 2 ]
});
// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]

var y = toFlippedud( x );
// returns <ndarray>[ [ 5.0, 6.0 ], [ 3.0, 4.0 ], [ 1.0, 2.0 ] ]
```

</section>

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var uniform = require( '@stdlib/random/uniform' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var toFlippedud = require( '@stdlib/ndarray/to-flippedud' );

var x = uniform( [ 3, 3, 3 ], -10.0, 10.0 );
console.log( ndarray2array( x ) );

var y = toFlippedud( x );
console.log( ndarray2array( y ) );
```

</section>

<!-- /.examples -->

<!-- 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. -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->
223 changes: 223 additions & 0 deletions lib/node_modules/@stdlib/ndarray/to-flippedud/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var empty = require( '@stdlib/ndarray/empty' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var toFlippedud = require( './../lib' );


// MAIN //

bench( format( '%s::0d', pkg ), function benchmark( b ) {
var values;
var v;
var i;

/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */

values = [
empty( [], { 'dtype': 'float64' } ),
empty( [], { 'dtype': 'float32' } ),
empty( [], { 'dtype': 'int32' } ),
empty( [], { 'dtype': 'complex128' } ),
empty( [], { 'dtype': 'generic' } )
];

/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = toFlippedud( values[ i%values.length ] );
if ( typeof v !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( !isndarrayLike( v ) ) {
b.fail( 'should return an ndarray' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( format( '%s::1d', pkg ), function benchmark( b ) {
var values;
var v;
var i;

/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */

values = [
empty( [ 2 ], { 'dtype': 'float64' } ),
empty( [ 2 ], { 'dtype': 'float32' } ),
empty( [ 2 ], { 'dtype': 'int32' } ),
empty( [ 2 ], { 'dtype': 'complex128' } ),
empty( [ 2 ], { 'dtype': 'generic' } )
];

/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = toFlippedud( values[ i%values.length ] );
if ( typeof v !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( !isndarrayLike( v ) ) {
b.fail( 'should return an ndarray' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( format( '%s::2d', pkg ), function benchmark( b ) {
var values;
var v;
var i;

/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */

values = [
empty( [ 2, 2 ], { 'dtype': 'float64' } ),
empty( [ 2, 2 ], { 'dtype': 'float32' } ),
empty( [ 2, 2 ], { 'dtype': 'int32' } ),
empty( [ 2, 2 ], { 'dtype': 'complex128' } ),
empty( [ 2, 2 ], { 'dtype': 'generic' } )
];

/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = toFlippedud( values[ i%values.length ] );
if ( typeof v !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( !isndarrayLike( v ) ) {
b.fail( 'should return an ndarray' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( format( '%s::3d', pkg ), function benchmark( b ) {
var values;
var v;
var i;

/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */

values = [
empty( [ 2, 2, 2 ], { 'dtype': 'float64' } ),
empty( [ 2, 2, 2 ], { 'dtype': 'float32' } ),
empty( [ 2, 2, 2 ], { 'dtype': 'int32' } ),
empty( [ 2, 2, 2 ], { 'dtype': 'complex128' } ),
empty( [ 2, 2, 2 ], { 'dtype': 'generic' } )
];

/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = toFlippedud( values[ i%values.length ] );
if ( typeof v !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( !isndarrayLike( v ) ) {
b.fail( 'should return an ndarray' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( format( '%s::4d', pkg ), function benchmark( b ) {
var values;
var v;
var i;

/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */

values = [
empty( [ 2, 2, 2, 2 ], { 'dtype': 'float64' } ),
empty( [ 2, 2, 2, 2 ], { 'dtype': 'float32' } ),
empty( [ 2, 2, 2, 2 ], { 'dtype': 'int32' } ),
empty( [ 2, 2, 2, 2 ], { 'dtype': 'complex128' } ),
empty( [ 2, 2, 2, 2 ], { 'dtype': 'generic' } )
];

/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = toFlippedud( values[ i%values.length ] );
if ( typeof v !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( !isndarrayLike( v ) ) {
b.fail( 'should return an ndarray' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( format( '%s::5d', pkg ), function benchmark( b ) {
var values;
var v;
var i;

/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */

values = [
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'float64' } ),
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'float32' } ),
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'int32' } ),
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'complex128' } ),
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'generic' } )
];

/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = toFlippedud( values[ i%values.length ] );
if ( typeof v !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( !isndarrayLike( v ) ) {
b.fail( 'should return an ndarray' );
}
b.pass( 'benchmark finished' );
b.end();
});
25 changes: 25 additions & 0 deletions lib/node_modules/@stdlib/ndarray/to-flippedud/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

{{alias}}( x )
Returns a new ndarray where the order of elements along the second-to-last
dimension of an input ndarray is reversed.

Parameters
----------
x: ndarray
Input array.

Returns
-------
out: ndarray
A new ndarray where the order of elements along the second-to-last
dimension is reversed.

Examples
--------
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
<ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
> var y = {{alias}}( x )
<ndarray>[ [ 3, 4 ], [ 1, 2 ] ]

See Also
--------
Loading