diff --git a/CHANGELOG.md b/CHANGELOG.md
index 248eed5c..530f337c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,7 +4,7 @@
-## Unreleased (2024-12-01)
+## Unreleased (2024-12-02)
@@ -481,6 +481,7 @@ This release closes the following issue:
##### Features
+- [`a0ba090`](https://github.com/stdlib-js/stdlib/commit/a0ba090515dfdfe617e1179ddb7581db24fec44b) - add `with` method to `array/fixed-endian-factory` [(#3291)](https://github.com/stdlib-js/stdlib/pull/3291)
- [`1242bbf`](https://github.com/stdlib-js/stdlib/commit/1242bbf3e43a142f8d0bd4a66aece5baa33c03fe) - add `filter` method to `array/fixed-endian-factory` [(#3278)](https://github.com/stdlib-js/stdlib/pull/3278)
- [`41af546`](https://github.com/stdlib-js/stdlib/commit/41af5467a9067f22ec8facdb535389bac10093bd) - add `reduceRight` method to `array/fixed-endian-factory` [(#3300)](https://github.com/stdlib-js/stdlib/pull/3300)
- [`b679536`](https://github.com/stdlib-js/stdlib/commit/b679536e73bb91b1f9194bb6897232a3aa5cf2f2) - add `reduce` method to `array/fixed-endian-factory` [(#3296)](https://github.com/stdlib-js/stdlib/pull/3296)
@@ -501,9 +502,9 @@ This release closes the following issue:
##### Closed Issues
-A total of 10 issues were closed in this release:
+A total of 11 issues were closed in this release:
-[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3140](https://github.com/stdlib-js/stdlib/issues/3140), [#3146](https://github.com/stdlib-js/stdlib/issues/3146), [#3147](https://github.com/stdlib-js/stdlib/issues/3147), [#3149](https://github.com/stdlib-js/stdlib/issues/3149), [#3150](https://github.com/stdlib-js/stdlib/issues/3150), [#3151](https://github.com/stdlib-js/stdlib/issues/3151), [#3152](https://github.com/stdlib-js/stdlib/issues/3152), [#3155](https://github.com/stdlib-js/stdlib/issues/3155)
+[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3140](https://github.com/stdlib-js/stdlib/issues/3140), [#3146](https://github.com/stdlib-js/stdlib/issues/3146), [#3147](https://github.com/stdlib-js/stdlib/issues/3147), [#3149](https://github.com/stdlib-js/stdlib/issues/3149), [#3150](https://github.com/stdlib-js/stdlib/issues/3150), [#3151](https://github.com/stdlib-js/stdlib/issues/3151), [#3152](https://github.com/stdlib-js/stdlib/issues/3152), [#3155](https://github.com/stdlib-js/stdlib/issues/3155), [#3162](https://github.com/stdlib-js/stdlib/issues/3162)
@@ -557,9 +558,9 @@ A total of 10 issues were closed in this release:
### Closed Issues
-A total of 17 issues were closed in this release:
+A total of 18 issues were closed in this release:
-[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3140](https://github.com/stdlib-js/stdlib/issues/3140), [#3146](https://github.com/stdlib-js/stdlib/issues/3146), [#3147](https://github.com/stdlib-js/stdlib/issues/3147), [#3149](https://github.com/stdlib-js/stdlib/issues/3149), [#3150](https://github.com/stdlib-js/stdlib/issues/3150), [#3151](https://github.com/stdlib-js/stdlib/issues/3151), [#3152](https://github.com/stdlib-js/stdlib/issues/3152), [#3155](https://github.com/stdlib-js/stdlib/issues/3155), [#3164](https://github.com/stdlib-js/stdlib/issues/3164), [#3165](https://github.com/stdlib-js/stdlib/issues/3165), [#3176](https://github.com/stdlib-js/stdlib/issues/3176), [#3177](https://github.com/stdlib-js/stdlib/issues/3177), [#3178](https://github.com/stdlib-js/stdlib/issues/3178), [#3179](https://github.com/stdlib-js/stdlib/issues/3179), [#3180](https://github.com/stdlib-js/stdlib/issues/3180)
+[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3140](https://github.com/stdlib-js/stdlib/issues/3140), [#3146](https://github.com/stdlib-js/stdlib/issues/3146), [#3147](https://github.com/stdlib-js/stdlib/issues/3147), [#3149](https://github.com/stdlib-js/stdlib/issues/3149), [#3150](https://github.com/stdlib-js/stdlib/issues/3150), [#3151](https://github.com/stdlib-js/stdlib/issues/3151), [#3152](https://github.com/stdlib-js/stdlib/issues/3152), [#3155](https://github.com/stdlib-js/stdlib/issues/3155), [#3162](https://github.com/stdlib-js/stdlib/issues/3162), [#3164](https://github.com/stdlib-js/stdlib/issues/3164), [#3165](https://github.com/stdlib-js/stdlib/issues/3165), [#3176](https://github.com/stdlib-js/stdlib/issues/3176), [#3177](https://github.com/stdlib-js/stdlib/issues/3177), [#3178](https://github.com/stdlib-js/stdlib/issues/3178), [#3179](https://github.com/stdlib-js/stdlib/issues/3179), [#3180](https://github.com/stdlib-js/stdlib/issues/3180)
@@ -590,6 +591,7 @@ A total of 8 people contributed to this release. Thank you to the following cont
+- [`a0ba090`](https://github.com/stdlib-js/stdlib/commit/a0ba090515dfdfe617e1179ddb7581db24fec44b) - **feat:** add `with` method to `array/fixed-endian-factory` [(#3291)](https://github.com/stdlib-js/stdlib/pull/3291) _(by Aayush Khanna, Philipp Burckhardt)_
- [`d24969e`](https://github.com/stdlib-js/stdlib/commit/d24969e35be1cfbff2e0d62d740c451e476ee444) - **chore:** update package meta data [(#3303)](https://github.com/stdlib-js/stdlib/pull/3303) _(by stdlib-bot, Athan Reines)_
- [`1242bbf`](https://github.com/stdlib-js/stdlib/commit/1242bbf3e43a142f8d0bd4a66aece5baa33c03fe) - **feat:** add `filter` method to `array/fixed-endian-factory` [(#3278)](https://github.com/stdlib-js/stdlib/pull/3278) _(by Aayush Khanna, Philipp Burckhardt)_
- [`41af546`](https://github.com/stdlib-js/stdlib/commit/41af5467a9067f22ec8facdb535389bac10093bd) - **feat:** add `reduceRight` method to `array/fixed-endian-factory` [(#3300)](https://github.com/stdlib-js/stdlib/pull/3300) _(by Aayush Khanna, Philipp Burckhardt)_
diff --git a/fixed-endian-factory/README.md b/fixed-endian-factory/README.md
index 3c17b521..8d3a1892 100644
--- a/fixed-endian-factory/README.md
+++ b/fixed-endian-factory/README.md
@@ -908,6 +908,25 @@ var str = arr.join( 0 );
// returns '10203'
```
+
+
+#### TypedArrayFE.prototype.with( index, value )
+
+Returns a new typed array with the element at a provided index replaced with a provided value.
+
+```javascript
+var Float64ArrayFE = fixedEndianFactory( 'float64' );
+
+var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0 ] );
+// returns
+
+var out = arr.with( 0, 0.0 );
+// returns
+
+var v = out.get( 0 );
+// returns 0.0
+```
+
diff --git a/fixed-endian-factory/benchmark/benchmark.with.js b/fixed-endian-factory/benchmark/benchmark.with.js
new file mode 100644
index 00000000..cc7eb40d
--- /dev/null
+++ b/fixed-endian-factory/benchmark/benchmark.with.js
@@ -0,0 +1,61 @@
+/**
+* @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 pkg = require( './../package.json' ).name;
+var factory = require( './../lib' );
+
+
+// VARIABLES //
+
+var Float64ArrayFE = factory( 'float64' );
+
+
+// MAIN //
+
+bench( pkg+':with', function benchmark( b ) {
+ var values;
+ var out;
+ var arr;
+ var i;
+
+ values = [
+ 1.0,
+ 2.0,
+ 3.0
+ ];
+ arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 2.0, 1.0 ] );
+
+ b.tic();
+ for ( i = 0; i < b.iterations; i++ ) {
+ out = arr.with( i % arr.length, values[ i % values.length ] );
+ if ( typeof out !== 'object' ) {
+ b.fail( 'should return an object' );
+ }
+ }
+ b.toc();
+ if ( !( out instanceof Float64ArrayFE ) ) {
+ b.fail( 'should return a typed array' );
+ }
+ b.pass( 'benchmark finished' );
+ b.end();
+});
diff --git a/fixed-endian-factory/benchmark/benchmark.with.length.js b/fixed-endian-factory/benchmark/benchmark.with.length.js
new file mode 100644
index 00000000..e20c85cd
--- /dev/null
+++ b/fixed-endian-factory/benchmark/benchmark.with.length.js
@@ -0,0 +1,106 @@
+/**
+* @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 pow = require( '@stdlib/math/base/special/pow' );
+var zeroTo = require( './../../zero-to' );
+var pkg = require( './../package.json' ).name;
+var factory = require( './../lib' );
+
+
+// VARIABLES //
+
+var Float64ArrayFE = factory( 'float64' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+ var arr = new Float64ArrayFE( 'little-endian', zeroTo( len ) );
+ return benchmark;
+
+ /**
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark( b ) {
+ var values;
+ var out;
+ var i;
+
+ values = [
+ 1.0,
+ 2.0,
+ 3.0
+ ];
+
+ b.tic();
+ for ( i = 0; i < b.iterations; i++ ) {
+ out = arr.with( i % arr.length, values[ i % values.length ] );
+ if ( typeof out !== 'object' ) {
+ b.fail( 'should return an object' );
+ }
+ }
+ b.toc();
+ if ( !( out instanceof Float64ArrayFE ) ) {
+ b.fail( 'should return a typed array' );
+ }
+ 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( pkg+':with:len='+len, f );
+ }
+}
+
+main();
diff --git a/fixed-endian-factory/lib/main.js b/fixed-endian-factory/lib/main.js
index 3e394713..f8183e4d 100644
--- a/fixed-endian-factory/lib/main.js
+++ b/fixed-endian-factory/lib/main.js
@@ -24,6 +24,7 @@
var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
+var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
var isCollection = require( '@stdlib/assert/is-collection' );
var isArrayBuffer = require( '@stdlib/assert/is-arraybuffer' );
var isObject = require( '@stdlib/assert/is-object' );
@@ -1059,22 +1060,62 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
if ( !isTypedArray( this ) ) {
throw new TypeError( format( 'invalid invocation. `this` is not %s %s.', CHAR2ARTICLE[ dtype[0] ], CTOR_NAME ) );
}
-
if ( arguments.length > 0 ) {
sep = String( separator );
} else {
sep = ',';
}
-
out = [];
buf = this._buffer;
for ( i = 0; i < this._length; i++ ) {
out.push( buf[ GETTER ]( i * BYTES_PER_ELEMENT, this._isLE ) );
}
-
return out.join( sep );
});
+ /**
+ * Returns a new typed array with the element at a provided index replaced with a provided value.
+ *
+ * @name with
+ * @memberof TypedArray.prototype
+ * @type {Function}
+ * @param {integer} index - element index
+ * @param {number} value - new value
+ * @throws {TypeError} `this` must be a typed array instance
+ * @throws {TypeError} first argument must be an integer
+ * @throws {RangeError} index argument is out-of-bounds
+ * @throws {TypeError} second argument must be a number
+ * @returns {TypedArray} new typed array
+ */
+ setReadOnly( TypedArray.prototype, 'with', function copyWith( index, value ) {
+ var outbuf;
+ var buf;
+ var out;
+ var len;
+
+ if ( !isTypedArray( this ) ) {
+ throw new TypeError( format( 'invalid invocation. `this` is not %s %s.', CHAR2ARTICLE[ dtype[0] ], CTOR_NAME ) );
+ }
+ if ( !isInteger( index ) ) {
+ throw new TypeError( format( 'invalid argument. First argument must be an integer. Value: `%s`.', index ) );
+ }
+ len = this._length;
+ buf = this._buffer;
+ if ( index < 0 ) {
+ index += len;
+ }
+ if ( index < 0 || index >= len ) {
+ throw new RangeError( format( 'invalid argument. Index argument is out-of-bounds. Value: `%s`.', index ) );
+ }
+ if ( !isNumber( value ) ) {
+ throw new TypeError( format( 'invalid argument. Second argument must be a number. Value: `%s`.', value ) );
+ }
+ out = new this.constructor( flag2byteOrder( this._isLE ), buf.buffer );
+ outbuf = out._buffer; // eslint-disable-line no-underscore-dangle
+ outbuf[ SETTER ]( index * BYTES_PER_ELEMENT, value, this._isLE );
+ return out;
+ });
+
return TypedArray;
/**
diff --git a/fixed-endian-factory/test/test.with.js b/fixed-endian-factory/test/test.with.js
new file mode 100644
index 00000000..93a36b03
--- /dev/null
+++ b/fixed-endian-factory/test/test.with.js
@@ -0,0 +1,220 @@
+/**
+* @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 tape = require( 'tape' );
+var hasOwnProp = require( '@stdlib/assert/has-own-property' );
+var isFunction = require( '@stdlib/assert/is-function' );
+var factory = require( './../lib' );
+
+
+// TESTS //
+
+tape( 'main export is a function', function test( t ) {
+ t.ok( true, __filename );
+ t.strictEqual( typeof factory, 'function', 'main export is a function' );
+ t.end();
+});
+
+tape( 'the function returns a function', function test( t ) {
+ var ctor = factory( 'float64' );
+ t.strictEqual( isFunction( ctor ), true, 'returns expected value' );
+ t.end();
+});
+
+tape( 'attached to the prototype of the returned function is a `with` method', function test( t ) {
+ var ctor = factory( 'float64' );
+ t.strictEqual( hasOwnProp( ctor.prototype, 'with' ), true, 'returns expected value' );
+ t.strictEqual( isFunction( ctor.prototype.with ), true, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the method throws an error if invoked with a `this` context which is not a typed array instance', function test( t ) {
+ var values;
+ var ctor;
+ var arr;
+ var i;
+
+ ctor = factory( 'float64' );
+ arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+
+ values = [
+ '5',
+ 5,
+ NaN,
+ true,
+ false,
+ null,
+ void 0,
+ {},
+ [],
+ function noop() {}
+ ];
+ for ( i = 0; i < values.length; i++ ) {
+ t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] );
+ }
+ t.end();
+
+ function badValue( value ) {
+ return function badValue() {
+ return arr.with.call( value, 0, 0.0 );
+ };
+ }
+});
+
+tape( 'the method throws an error if provided a first argument which is not an integer', function test( t ) {
+ var values;
+ var ctor;
+ var arr;
+ var i;
+
+ ctor = factory( 'float64' );
+ arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+
+ values = [
+ '5',
+ 3.14,
+ NaN,
+ true,
+ false,
+ null,
+ void 0,
+ {},
+ [],
+ function noop() {}
+ ];
+
+ for ( i = 0; i < values.length; i++ ) {
+ t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] );
+ }
+ t.end();
+
+ function badValue( value ) {
+ return function badValue() {
+ return arr.with( value, 0.0 );
+ };
+ }
+});
+
+tape( 'the method throws an error if provided a first argument which is not in bounds', function test( t ) {
+ var values;
+ var ctor;
+ var arr;
+ var i;
+
+ ctor = factory( 'float64' );
+ arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+
+ values = [
+ -6,
+ -9,
+ 10,
+ 20
+ ];
+
+ for ( i = 0; i < values.length; i++ ) {
+ t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] );
+ }
+ t.end();
+
+ function badValue( value ) {
+ return function badValue() {
+ return arr.with( value, 0.0 );
+ };
+ }
+});
+
+tape( 'the method throws an error if provided a second argument which is not a number', function test( t ) {
+ var values;
+ var ctor;
+ var arr;
+ var i;
+
+ ctor = factory( 'float64' );
+ arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+
+ values = [
+ '5',
+ true,
+ false,
+ null,
+ void 0,
+ {},
+ [],
+ function noop() {}
+ ];
+
+ for ( i = 0; i < values.length; i++ ) {
+ t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] );
+ }
+ t.end();
+
+ function badValue( value ) {
+ return function badValue() {
+ return arr.with( 0, value );
+ };
+ }
+});
+
+tape( 'the method does not change the array length', function test( t ) {
+ var ctor;
+ var arr;
+ var out;
+
+ ctor = factory( 'float64' );
+ arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+ out = arr.with( 0, 4.0 );
+
+ t.strictEqual( out.length, 5, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the method returns a new boolean array with the element at a provided index replaced with a provided value', function test( t ) {
+ var expected;
+ var actual;
+ var ctor;
+ var arr;
+
+ ctor = factory( 'float64' );
+ arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+ expected = new ctor( 'little-endian', [ 0.0, 2.0, 3.0, 4.0, 5.0 ] );
+ actual = arr.with( 0, 0.0 );
+ t.strictEqual( actual instanceof ctor, true, 'returns expected value' );
+ t.deepEqual( actual, expected, 'returns expected value' );
+ t.notEqual( actual, arr, 'returns new instance' );
+ t.end();
+});
+
+tape( 'the method supports negative indices', function test( t ) {
+ var expected;
+ var actual;
+ var ctor;
+ var arr;
+
+ ctor = factory( 'float64' );
+ arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+ expected = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 0.0 ] );
+ actual = arr.with( -5, 0.0 );
+ t.strictEqual( actual instanceof ctor, true, 'returns expected value' );
+ t.deepEqual( actual, expected, 'returns expected value' );
+ t.notEqual( actual, arr, 'returns new instance' );
+ t.end();
+});