Skip to content
Open
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
108 changes: 108 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/srev/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
<!--

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

-->

# srev

> Reverse the elements of a one-dimensional single-precision floating-point ndarray.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var srev = require( '@stdlib/blas/ext/base/ndarray/srev' );
```

#### srev( arrays )

Reverses the elements of a one-dimensional single-precision floating-point ndarray in-place.

```javascript
var Float32Array = require( '@stdlib/array/float32' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );

var xbuf = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var x = new ndarray( 'float32', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );

srev( [ x ] );
// x => <ndarray>[ 3.0, 2.0, 1.0 ]

var arr = ndarray2array( x );
// returns [ 3.0, 2.0, 1.0 ]
```

The function has the following parameters:

- **arrays**: array-like object containing a single one-dimensional input ndarray.

</section>

<!-- /.usage -->

<section class="examples">

## Examples

```javascript
var Float32Array = require( '@stdlib/array/float32' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var srev = require( '@stdlib/blas/ext/base/ndarray/srev' );

var xbuf;
var x;
var i;

xbuf = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
x = new ndarray( 'float32', xbuf, [ 6 ], [ -1 ], 5, 'row-major' );

srev( [ x ] );

console.log( 'x:' );
for ( i = 0; i < 6; i++ ) {
console.log( x.get( i ) );
}
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep this section sorted. -->

<section class="links">

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
/**
* @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 uniform = require( '@stdlib/random/array/uniform' );
var pow = require( '@stdlib/math/base/special/pow' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var srev = require( './../lib' );


// VARIABLES //

var options = {
'dtype': 'float32'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var xbuf;
var x;

xbuf = uniform( len, -10.0, 10.0, options );
x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );

return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
srev( [ x ] );
if ( xbuf[ 0 ] !== xbuf[ 0 ] ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( xbuf[ 0 ] !== xbuf[ 0 ] ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var len;
var min;
var max;
var f;
var i;

min = 1; // 10^min
max = 6; // 10^max

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s:len=%d', pkg, len ), f );
}
}

main();
35 changes: 35 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/srev/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

{{alias}}( arrays )
Reverses the elements of a one-dimensional single-precision floating-point
ndarray.


Parameters
----------
arrays: ArrayLikeObject<ndarray>
Array-like object containing a one-dimensional input ndarray.


Returns
-------
out: void
The input ndarray is modified in-place.


Examples
--------
> var xbuf = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0 ] );
> var dt = 'float32';
> var sh = [ xbuf.length ];
> var sx = [ 1 ];
> var ox = 0;
> var ord = 'row-major';
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
> {{alias}}( [ x ] );
> var data = x.data
<Float32Array>[ 3.0, 2.0, 1.0 ]


See Also
--------

Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/*
* @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.
*/

// TypeScript Version: 4.1

/// <reference types="@stdlib/types"/>

import { ndarray } from '@stdlib/types/ndarray';

/**
* Reverses the elements of a one-dimensional single-precision floating-point ndarray.
*
* @param arrays - array-like object containing a single one-dimensional input ndarray
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = new Float32Array( [ 1.0, 2.0, 3.0 ] );
* var x = new ndarray( 'float32', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
*
* srev( [ x ] );
*
* var arr = ndarray2array( x );
* // returns [ 3.0, 2.0, 1.0 ]
*/
declare function srev( arrays: ArrayLike<ndarray> ): void;


// EXPORTS //

export = srev;
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/*
* @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.
*/

import zeros = require( '@stdlib/ndarray/base/zeros' );
import srev = require( './index' );


// TESTS //

// The function returns void...
{
const x = zeros( 'float32', [ 10 ], 'row-major' );
srev( [ x ] ); // $ExpectType void
}

// The compiler throws an error if the function is provided a first argument which is not an array-like object containing ndarrays...
{
srev( 'abc' ); // $ExpectError
srev( 3.14 ); // $ExpectError
srev( true ); // $ExpectError
srev( false ); // $ExpectError
srev( null ); // $ExpectError
srev( undefined ); // $ExpectError
srev( [ '1' ] ); // $ExpectError
srev( {} ); // $ExpectError
}

// The compiler throws an error if the function is provided an insufficient number of arguments...
{
srev(); // $ExpectError
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/**
* @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';

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var srev = require( './../lib' );

var xbuf = discreteUniform( 10, -50, 50, {
'dtype': 'float32'
});
var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );

srev( [ x ] );
console.log( ndarray2array( x ) );
Loading