-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
47ad0eb
commit 118a2c5
Showing
13 changed files
with
1,433 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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,141 @@ | ||
| <!-- | ||
| @license Apache-2.0 | ||
| Copyright (c) 2024 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. | ||
| --> | ||
|
|
||
| # put | ||
|
|
||
| > Replace specified elements of an array with provided values. | ||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var put = require( '@stdlib/array/base/put' ); | ||
| ``` | ||
|
|
||
| #### put( x, indices, values, mode ) | ||
|
|
||
| Replaces specified elements of an array with provided values. | ||
|
|
||
| ```javascript | ||
| var x = [ 1, 2, 3, 4 ]; | ||
|
|
||
| var out = put( x, [ 1, 3 ], [ 20, 40 ], 'throw' ); | ||
| // returns [ 1, 20, 3, 40 ] | ||
|
|
||
| var bool = ( out === x ); | ||
| // returns true | ||
| ``` | ||
|
|
||
| The function supports the following parameters: | ||
|
|
||
| - **x**: input array. | ||
| - **indices**: list of indices. | ||
| - **values**: values to set. When `indices` contains one or more elements, `values` must be broadcast [compatible][@stdlib/ndarray/base/broadcast-shapes] with `indices` (i.e., must have either one element or the same number of elements as `indices`). | ||
| - **mode**: index [mode][@stdlib/ndarray/base/ind]. | ||
|
|
||
| If `indices` is an empty array, the function returns the input array unchanged. | ||
|
|
||
| ```javascript | ||
| var x = [ 1, 2, 3, 4 ]; | ||
|
|
||
| var out = put( x, [], [ 20, 40 ], 'throw' ); | ||
| // returns [ 1, 2, 3, 4 ] | ||
| ``` | ||
|
|
||
| The function supports broadcasting a `values` array containing a single element against an `indices` array containing one or more elements. | ||
|
|
||
| ```javascript | ||
| var x = [ 1, 2, 3, 4 ]; | ||
|
|
||
| var out = put( x, [ 1, 3 ], [ 20 ], 'throw' ); | ||
| // returns [ 1, 20, 3, 20 ] | ||
|
|
||
| var bool = ( out === x ); | ||
| // returns true | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - The function mutates the input array `x`. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var filledBy = require( '@stdlib/array/base/filled-by' ); | ||
| var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); | ||
| var linspace = require( '@stdlib/array/base/linspace' ); | ||
| var put = require( '@stdlib/array/base/put' ); | ||
|
|
||
| // Generate a linearly spaced array: | ||
| var x = linspace( 0, 100, 11 ); | ||
| console.log( x ); | ||
|
|
||
| // Generate an array of random indices: | ||
| var N = discreteUniform( 5, 15 ); | ||
| var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); | ||
| console.log( indices ); | ||
|
|
||
| // Generate an array of random values: | ||
| var values = filledBy( N, discreteUniform.factory( 1000, 2000 ) ); | ||
| console.log( values ); | ||
|
|
||
| // Update a random sample of elements in `x`: | ||
| var out = put( x, indices, values, 'throw' ); | ||
| console.log( out ); | ||
| ``` | ||
|
|
||
| </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"> | ||
|
|
||
| [@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind | ||
|
|
||
| [@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> |
This file contains 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,78 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2024 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 isArray = require( '@stdlib/assert/is-array' ); | ||
| var zeroTo = require( './../../../base/zero-to' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var put = require( './../lib' ); | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( pkg+'::no_broadcasting:len=100', function benchmark( b ) { | ||
| var idx; | ||
| var x; | ||
| var i; | ||
| var v; | ||
|
|
||
| x = zeroTo( 100 ); | ||
| idx = zeroTo( 100 ); | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| v = put( x, idx, x, 'throw' ); | ||
| if ( typeof v !== 'object' ) { | ||
| b.fail( 'should return an array' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( !isArray( v ) ) { | ||
| b.fail( 'should return an array' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| }); | ||
|
|
||
| bench( pkg+'::broadcasting:len=100', function benchmark( b ) { | ||
| var idx; | ||
| var x; | ||
| var i; | ||
| var v; | ||
|
|
||
| x = zeroTo( 100 ); | ||
| idx = zeroTo( 100 ); | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| v = put( x, idx, [ i ], 'throw' ); | ||
| if ( typeof v !== 'object' ) { | ||
| b.fail( 'should return an array' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( !isArray( v ) ) { | ||
| b.fail( 'should return an array' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| }); |
Oops, something went wrong.