-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add blas/ext/base/ndarray/grev
#9069
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Changes from 5 commits
d8b19d5
7750a33
f7509b0
9396038
3e6abe9
0bb4610
44b7fd2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # grev | ||
|
|
||
| > Reverse a one-dimensional ndarray in-place. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var grev = require( '@stdlib/blas/ext/base/ndarray/grev' ); | ||
| ``` | ||
|
|
||
| #### grev( arrays ) | ||
|
|
||
| Reverses a one-dimensional ndarray in-place. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
| var ndarray = require( '@stdlib/ndarray/base/ctor' ); | ||
| var ndarray2array = require( '@stdlib/ndarray/to-array' ); | ||
|
|
||
| var xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] ); | ||
| var x = new ndarray( 'float64', xbuf, [ 3 ], [ 1 ], 0, 'row-major' ); | ||
|
|
||
| grev( [ x ] ); | ||
|
|
||
| console.log( ndarray2array( x ) ); | ||
| // => [ 3.0, 2.0, 1.0 ] | ||
| ``` | ||
|
|
||
| The function has the following parameters: | ||
|
|
||
| - **arrays**: array-like object containing a one-dimensional input ndarray. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - If provided an empty one-dimensional input ndarray, the function returns the output ndarray unchanged. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); | ||
| var ndarray = require( '@stdlib/ndarray/base/ctor' ); | ||
| var ndarray2array = require( '@stdlib/ndarray/to-array' ); | ||
| var grev = require( '@stdlib/blas/ext/base/ndarray/grev' ); | ||
|
|
||
| var xbuf = discreteUniform( 10, -50, 50, { | ||
| 'dtype': 'float64' | ||
| }); | ||
| var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); | ||
| console.log( ndarray2array( x ) ); | ||
|
|
||
| grev( [ x ] ); | ||
| console.log( ndarray2array( x ) ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| <!-- 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"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /** | ||
| * @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); | ||
| 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 grev = require( './../lib' ); | ||
|
|
||
|
|
||
| // VARIABLES // | ||
|
|
||
| var options = { | ||
| 'dtype': 'float64' | ||
| }; | ||
|
|
||
|
|
||
| // 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; | ||
|
|
||
| function benchmark( b ) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Missing JSDoc comment. See other packages.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @kgryte |
||
| var v; | ||
| var i; | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| v = grev( [ x ] ); | ||
| if ( typeof v !== 'object' ) { | ||
| b.fail( 'should return an ndarray' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( isnan( v.get( i % len ) ) ) { | ||
| 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(); | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
|
|
||
| {{alias}}( arrays ) | ||
|
sagar7162 marked this conversation as resolved.
|
||
| Reverses a one-dimensional ndarray in-place. | ||
|
|
||
| If provided an empty ndarray, the function returns the input ndarray | ||
| unchanged. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| arrays: ArrayLikeObject<ndarray> | ||
| Array-like object containing a one-dimensional input ndarray. | ||
|
|
||
| Returns | ||
| ------- | ||
| out: ndarray | ||
| Input ndarray. | ||
|
|
||
| Examples | ||
| -------- | ||
| > var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0 ] ); | ||
| > var dt = 'float64'; | ||
| > 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 ] ); | ||
| > {{alias:@stdlib/ndarray/to-array}}( x ) | ||
| [ 3.0, 2.0, 1.0 ] | ||
|
|
||
| See Also | ||
| -------- | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /* | ||
| * @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 { typedndarray } from '@stdlib/types/ndarray'; | ||
|
kgryte marked this conversation as resolved.
Outdated
|
||
|
|
||
| /** | ||
| * Reverses a one-dimensional ndarray in-place. | ||
| * | ||
| * @param arrays - array-like object containing a one-dimensional input ndarray | ||
| * @returns input ndarray | ||
| * | ||
| * @example | ||
| * var Float64Array = require( '@stdlib/array/float64' ); | ||
| * var ndarray = require( '@stdlib/ndarray/base/ctor' ); | ||
| * var ndarray2array = require( '@stdlib/ndarray/to-array' ); | ||
| * | ||
| * var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); | ||
| * var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); | ||
| * | ||
| * grev( [ x ] ); | ||
| * | ||
| * var arr = ndarray2array( x ); | ||
| * // returns [ 4.0, 3.0, 2.0, 1.0 ] | ||
| */ | ||
|
sagar7162 marked this conversation as resolved.
|
||
| declare function grev<T extends typedndarray<any> = typedndarray<any>>( arrays: [ T ] ): T; | ||
|
Check warning on line 44 in lib/node_modules/@stdlib/blas/ext/base/ndarray/grev/docs/types/index.d.ts
|
||
|
kgryte marked this conversation as resolved.
Outdated
|
||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| export = grev; | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * @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. | ||
| */ | ||
|
|
||
| /* eslint-disable space-in-parens */ | ||
|
|
||
| import zeros = require( '@stdlib/ndarray/zeros' ); | ||
| import grev = require( './index' ); | ||
|
|
||
|
|
||
| // TESTS // | ||
|
|
||
| // The function returns an ndarray... | ||
| { | ||
| const x = zeros( [ 10 ], { | ||
| 'dtype': 'float64' | ||
| }); | ||
|
|
||
| grev( [ x ] ); // $ExpectType float64ndarray | ||
| } | ||
|
|
||
| // The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... | ||
| { | ||
| grev( '10' ); // $ExpectError | ||
| grev( 10 ); // $ExpectError | ||
| grev( true ); // $ExpectError | ||
| grev( false ); // $ExpectError | ||
| grev( null ); // $ExpectError | ||
| grev( undefined ); // $ExpectError | ||
| grev( [] ); // $ExpectError | ||
| grev( {} ); // $ExpectError | ||
| grev( ( x: number ): number => x ); // $ExpectError | ||
| } | ||
|
|
||
| // The compiler throws an error if the function is provided an unsupported number of arguments... | ||
| { | ||
| const x = zeros( [ 10 ], { | ||
| 'dtype': 'float64' | ||
| }); | ||
|
|
||
| grev(); // $ExpectError | ||
| grev( [ x ], {} ); // $ExpectError | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /** | ||
| * @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 grev = require( './../lib' ); | ||
|
|
||
| var xbuf = discreteUniform( 10, -50, 50, { | ||
| 'dtype': 'float64' | ||
| }); | ||
|
|
||
| var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); | ||
| console.log( ndarray2array( x ) ); | ||
|
|
||
| grev( [ x ] ); | ||
| console.log( ndarray2array( x ) ); |
Uh oh!
There was an error while loading. Please reload this page.