-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Open
sagar7162
wants to merge
7
commits into
stdlib-js:develop
Choose a base branch
from
sagar7162:grev
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+767
−0
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d8b19d5
feat: add `blas/ext/base/ndarray/grev`
sagar7162 7750a33
fix: apply suggested changes
sagar7162 f7509b0
fix: resolve previous commit issue
sagar7162 9396038
fix: remove unintended change to @stdlib/types
sagar7162 3e6abe9
fix: adjust data types in index.d.ts
sagar7162 0bb4610
Apply suggestions from code review
kgryte 44b7fd2
fix: implemented suggested changes
sagar7162 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
111 changes: 111 additions & 0 deletions
111
lib/node_modules/@stdlib/blas/ext/base/ndarray/grev/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| <!-- | ||
|
|
||
| @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 xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] ); | ||
| var x = new ndarray( 'float64', xbuf, [ 3 ], [ 1 ], 0, 'row-major' ); | ||
|
|
||
| var out = grev( [ x ] ); | ||
| // returns <ndarray>[ 3.0, 2.0, 1.0 ] | ||
|
|
||
| var bool = ( out === x ); | ||
| // returns true | ||
| ``` | ||
|
|
||
| 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 uniform = require( '@stdlib/random/uniform' ); | ||
| var ndarray2array = require( '@stdlib/ndarray/to-array' ); | ||
| var grev = require( '@stdlib/blas/ext/base/ndarray/grev' ); | ||
|
|
||
| var x = uniform( [10], -50, 50 ); | ||
| 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 --> |
103 changes: 103 additions & 0 deletions
103
lib/node_modules/@stdlib/blas/ext/base/ndarray/grev/benchmark/benchmark.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 ) { | ||
| 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(); |
32 changes: 32 additions & 0 deletions
32
lib/node_modules/@stdlib/blas/ext/base/ndarray/grev/docs/repl.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
|
|
||
| {{alias}}( arrays ) | ||
| 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 | ||
| -------- | ||
50 changes: 50 additions & 0 deletions
50
lib/node_modules/@stdlib/blas/ext/base/ndarray/grev/docs/types/index.d.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| * @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 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' ); | ||
| * | ||
| * var out = grev( [ x ] ); | ||
| * // returns <ndarray>[ 4.0, 3.0, 2.0, 1.0 ] | ||
| * | ||
| * var bool = ( out === x ); | ||
| * // returns true | ||
| */ | ||
| declare function grev<T extends ndarray>( arrays: [ T ] ): T; | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| export = grev; |
57 changes: 57 additions & 0 deletions
57
lib/node_modules/@stdlib/blas/ext/base/ndarray/grev/docs/types/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| } |
29 changes: 29 additions & 0 deletions
29
lib/node_modules/@stdlib/blas/ext/base/ndarray/grev/examples/index.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /** | ||
| * @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 uniform = require( '@stdlib/random/uniform' ); | ||
| var ndarray2array = require( '@stdlib/ndarray/to-array' ); | ||
| var grev = require( './../lib' ); | ||
|
|
||
| var x = uniform( [10], -50, 50 ); | ||
| console.log( ndarray2array( x ) ); | ||
|
|
||
| grev( [ x ] ); | ||
| console.log( ndarray2array( x ) ); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.