Skip to content

Commit 9a71afc

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 79975bc commit 9a71afc

File tree

9 files changed

+626
-10
lines changed

9 files changed

+626
-10
lines changed

‎README.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1376,6 +1376,77 @@ idx = arr.lastIndexOf( new Complex128( 2.0, -2.0 ), 0 );
13761376
// returns -1
13771377
```
13781378

1379+
<a name="method-map"></a>
1380+
1381+
#### Complex128Array.prototype.map( callbackFn\[, thisArg] )
1382+
1383+
Returns a new array with each element being the result of a provided callback function.
1384+
1385+
```javascript
1386+
var Complex128 = require( '@stdlib/complex-float64' );
1387+
var real = require( '@stdlib/complex-real' );
1388+
var imag = require( '@stdlib/complex-imag' );
1389+
1390+
function scale( v ) {
1391+
return new Complex128( 2.0*real( v ), 2.0*imag( v ) );
1392+
}
1393+
1394+
var arr = new Complex128Array( 3 );
1395+
1396+
// Set the first three elements:
1397+
arr.set( [ 1.0, -1.0 ], 0 );
1398+
arr.set( [ 2.0, -2.0 ], 1 );
1399+
arr.set( [ 3.0, -3.0 ], 2 );
1400+
1401+
var out = arr.map( scale );
1402+
// returns <Complex128Array>
1403+
1404+
var z = out.get( 0 );
1405+
// returns <Complex128>
1406+
1407+
var re = real( z );
1408+
// returns 2.0
1409+
1410+
var im = imag( z );
1411+
// returns -2.0
1412+
```
1413+
1414+
The callback function is provided three arguments:
1415+
1416+
- **value**: current array element.
1417+
- **index**: current array element index.
1418+
- **arr**: the array on which this method was called.
1419+
1420+
To set the function execution context, provide a `thisArg`.
1421+
1422+
```javascript
1423+
var Complex128 = require( '@stdlib/complex-float64' );
1424+
var real = require( '@stdlib/complex-real' );
1425+
var imag = require( '@stdlib/complex-imag' );
1426+
1427+
function scale( v ) {
1428+
this.count += 1;
1429+
return new Complex128( 2.0*real( v ), 2.0*imag( v ) );
1430+
}
1431+
1432+
var arr = new Complex128Array( 3 );
1433+
1434+
var context = {
1435+
'count': 0
1436+
};
1437+
1438+
// Set the first three elements:
1439+
arr.set( [ 1.0, 1.0 ], 0 );
1440+
arr.set( [ 2.0, 2.0 ], 1 );
1441+
arr.set( [ 3.0, 3.0 ], 2 );
1442+
1443+
var out = arr.map( scale, context );
1444+
// returns <Complex128Array>
1445+
1446+
var count = context.count;
1447+
// returns 3
1448+
```
1449+
13791450
<a name="method-set"></a>
13801451

13811452
#### Complex128Array.prototype.set( z\[, i] )

‎benchmark/benchmark.map.js‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench-harness' );
24+
var isComplex128Array = require( '@stdlib/assert-is-complex128array' );
25+
var realf = require( '@stdlib/complex-realf' );
26+
var imagf = require( '@stdlib/complex-imagf' );
27+
var Complex128 = require('@stdlib/complex-float64');
28+
var pkg = require( './../package.json' ).name;
29+
var Complex128Array = require( './../lib' );
30+
31+
32+
// MAIN //
33+
34+
bench( pkg+':map', function benchmark( b ) {
35+
var out;
36+
var arr;
37+
var i;
38+
39+
arr = new Complex128Array( [ 1, 2, 3, 4, 5, 6 ] );
40+
41+
b.tic();
42+
for ( i = 0; i < b.iterations; i++ ) {
43+
out = arr.map( scale );
44+
if ( typeof out !== 'object' ) {
45+
b.fail( 'should return an object' );
46+
}
47+
}
48+
b.toc();
49+
if ( !isComplex128Array( out ) ) {
50+
b.fail( 'should return a Complex128Array' );
51+
}
52+
b.pass( 'benchmark finished' );
53+
b.end();
54+
55+
function scale( v ) {
56+
return new Complex128( realf(v)*2.0, imagf(v)*2.0 );
57+
}
58+
});

‎benchmark/benchmark.map.length.js‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench-harness' );
24+
var isComplex128Array = require( '@stdlib/assert-is-complex128array' );
25+
var pow = require( '@stdlib/math-base-special-pow' );
26+
var identity = require( '@stdlib/utils-identity-function' );
27+
var Complex128 = require( '@stdlib/complex-float64' );
28+
var pkg = require( './../package.json' ).name;
29+
var Complex128Array = require( './../lib' );
30+
31+
32+
// FUNCTIONS //
33+
34+
/**
35+
* Creates a benchmark function.
36+
*
37+
* @private
38+
* @param {PositiveInteger} len - array length
39+
* @returns {Function} benchmark function
40+
*/
41+
function createBenchmark( len ) {
42+
var arr;
43+
var i;
44+
45+
arr = [];
46+
for ( i = 0; i < len; i++ ) {
47+
arr.push( new Complex128( i, i ) );
48+
}
49+
arr = new Complex128Array( arr );
50+
51+
return benchmark;
52+
53+
/**
54+
* Benchmark function.
55+
*
56+
* @private
57+
* @param {Benchmark} b - benchmark instance
58+
*/
59+
function benchmark( b ) {
60+
var out;
61+
var i;
62+
63+
b.tic();
64+
for ( i = 0; i < b.iterations; i++ ) {
65+
out = arr.map( identity );
66+
if ( typeof out !== 'object' ) {
67+
b.fail( 'should return an object' );
68+
}
69+
}
70+
b.toc();
71+
if ( !isComplex128Array( out ) ) {
72+
b.fail( 'should return a Complex128Array' );
73+
}
74+
b.pass( 'benchmark finished' );
75+
b.end();
76+
}
77+
}
78+
79+
80+
// MAIN //
81+
82+
/**
83+
* Main execution sequence.
84+
*
85+
* @private
86+
*/
87+
function main() {
88+
var len;
89+
var min;
90+
var max;
91+
var f;
92+
var i;
93+
94+
min = 1; // 10^min
95+
max = 6; // 10^max
96+
97+
for ( i = min; i <= max; i++ ) {
98+
len = pow( 10, i );
99+
f = createBenchmark( len );
100+
bench( pkg+':map:len='+len, f );
101+
}
102+
}
103+
104+
main();

‎dist/index.js‎

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/index.js.map‎

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/types/index.d.ts‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/* eslint-disable max-lines */
2+
13
/*
24
* @license Apache-2.0
35
*
@@ -105,6 +107,50 @@ type TernaryPredicate<U> = ( this: U, value: Complex128, index: number, arr: Com
105107
*/
106108
type Predicate<U> = NullaryPredicate<U> | UnaryPredicate<U> | BinaryPredicate<U> | TernaryPredicate<U>;
107109

110+
/**
111+
* Callback invoked for each element in an array.
112+
*
113+
* @returns transformed value
114+
*/
115+
type NullaryMapFcn<U> = ( this: U ) => ComplexLike | ArrayLike<number>;
116+
117+
/**
118+
* Callback invoked for each element in an array.
119+
*
120+
* @param value - current array element
121+
* @returns transformed value
122+
*/
123+
type UnaryMapFcn<U> = ( this: U, value: Complex128 ) => ComplexLike | ArrayLike<number>;
124+
125+
/**
126+
* Callback invoked for each element in an array.
127+
*
128+
* @param value - current array element
129+
* @param index - current array element index
130+
* @returns transformed value
131+
*/
132+
type BinaryMapFcn<U> = ( this: U, value: Complex128, index: number ) => ComplexLike | ArrayLike<number>;
133+
134+
/**
135+
* Callback invoked for each element in an array.
136+
*
137+
* @param value - current array element
138+
* @param index - current array element index
139+
* @param arr - array on which the method was called
140+
* @returns transformed value
141+
*/
142+
type TernaryMapFcn<U> = ( this: U, value: Complex128, index: number, arr: Complex128Array ) => ComplexLike | ArrayLike<number>;
143+
144+
/**
145+
* Callback invoked for each element in an array.
146+
*
147+
* @param value - current array element
148+
* @param index - current array element index
149+
* @param arr - array on which the method was called
150+
* @returns transformed value
151+
*/
152+
type MapFcn<U> = NullaryMapFcn<U> | UnaryMapFcn<U> | BinaryMapFcn<U> | TernaryMapFcn<U>;
153+
108154
/**
109155
* Class for creating a 128-bit complex number array.
110156
*/
@@ -602,6 +648,42 @@ declare class Complex128Array implements Complex128ArrayInterface {
602648
*/
603649
lastIndexOf( searchElement: ComplexLike, fromIndex?: number ): number;
604650

651+
/**
652+
* Returns a new array with each element being the result of a provided callback function.
653+
*
654+
* @param fcn - callback function
655+
* @param thisArg - execution context
656+
* @returns new array containing transformed elements
657+
*
658+
* @example
659+
* var Complex128 = require( '@stdlib/complex-float64' );
660+
* var real = require( '@stdlib/complex-real' );
661+
* var imag = require( '@stdlib/complex-imag' );
662+
*
663+
* function scale( v, i ) {
664+
* return new Complex128( 2.0*real( v ), 2.0*imag( v ) );
665+
* }
666+
*
667+
* var arr = new Complex128Array( 3 );
668+
*
669+
* arr.set( [ 1.0, -1.0 ], 0 );
670+
* arr.set( [ 2.0, -2.0 ], 1 );
671+
* arr.set( [ 3.0, -3.0 ], 2 );
672+
*
673+
* var out = arr.map( scale );
674+
* // returns <Complex128Array>
675+
*
676+
* var z = out.get( 0 );
677+
* // returns <Complex128>
678+
*
679+
* var re = real( z );
680+
* // returns 2.0
681+
*
682+
* var im = imag( z );
683+
* // returns -2.0
684+
*/
685+
map<U = unknown>( fcn: MapFcn<U>, thisArg?: ThisParameterType<MapFcn<U>> ): Complex128Array;
686+
605687
/**
606688
* Sets an array element.
607689
*

0 commit comments

Comments
 (0)