@stdlib/array-base-reverse v0.2.2

reverse

Reverse an array in-place.

Installation

npm install @stdlib/array-base-reverse

Usage

var reverse = require( '@stdlib/array-base-reverse' );

reverse( x )

Reverses an array in-place.

var x = [ 1, 2, 3, 4, 5, 6 ];

var out = reverse( x );
// returns [ 6, 5, 4, 3, 2, 1 ]

var bool = ( out === x );
// returns true

Notes

• If provided an array-like object having a reverse method, the function defers execution to that method and assumes that the method API has the following signature:

  x.reverse()

• If provided an array-like object without a reverse method, the function manually reverses elements and mutates the input array.

Examples

var Float64Array = require( '@stdlib/array-float64' );
var zeroTo = require( '@stdlib/array-base-zero-to' );
var reverse = require( '@stdlib/array-base-reverse' );

var x = new Float64Array( zeroTo( 6 ) );
// returns <Float64Array>[ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]

var y = reverse( x );
// returns <Float64Array>[ 5.0, 4.0, 3.0, 2.0, 1.0, 0.0 ]

var z = reverse( y );
// returns <Float64Array>[ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.