Skip to content

Commit 9e19fca

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 80afb78 commit 9e19fca

File tree

8 files changed

+718
-4
lines changed

8 files changed

+718
-4
lines changed

‎complex64/README.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1607,6 +1607,100 @@ var count = context.count;
16071607
// returns 2
16081608
```
16091609

1610+
<a name="method-subarray"></a>
1611+
1612+
#### Complex64Array.prototype.subarray( \[begin\[, end]] )
1613+
1614+
Creates a new typed array view over the same underlying [`ArrayBuffer`][@stdlib/array/buffer] and with the same underlying data type as the host array.
1615+
1616+
```javascript
1617+
var realf = require( '@stdlib/complex/realf' );
1618+
var imagf = require( '@stdlib/complex/imagf' );
1619+
1620+
var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
1621+
1622+
var subarr = arr.subarray();
1623+
// returns <Complex64Array>
1624+
1625+
var len = subarr.length;
1626+
// returns 4
1627+
1628+
var z = subarr.get( 0 );
1629+
// returns <Complex64>
1630+
1631+
var re = realf( z );
1632+
// returns 1.0
1633+
1634+
var im = imagf( z );
1635+
// returns 2.0
1636+
1637+
z = subarr.get( len-1 );
1638+
// returns <Complex64>
1639+
1640+
re = realf( z );
1641+
// returns 7.0
1642+
1643+
im = imagf( z );
1644+
// returns 8.0
1645+
```
1646+
1647+
By default, the method creates a typed array view beginning with the first array element. To specify an alternative array index at which to begin, provide a `begin` index (inclusive).
1648+
1649+
```javascript
1650+
var imagf = require( '@stdlib/complex/imagf' );
1651+
var realf = require( '@stdlib/complex/realf' );
1652+
1653+
var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
1654+
1655+
var subarr = arr.subarray( 1 );
1656+
// returns <Complex64Array>
1657+
1658+
var len = subarr.length;
1659+
// returns 3
1660+
1661+
var z = subarr.get( 0 );
1662+
// returns <Complex64>
1663+
1664+
var re = realf( z );
1665+
// returns 3.0
1666+
1667+
var im = imagf( z );
1668+
// returns 4.0
1669+
```
1670+
1671+
By default, the method creates a typed array view which includes all array elements after `begin`. To limit the number of array elements after `begin`, provide an `end` index (exclusive).
1672+
1673+
```javascript
1674+
var realf = require( '@stdlib/complex/realf' );
1675+
var imagf = require( '@stdlib/complex/imagf' );
1676+
1677+
var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
1678+
1679+
var subarr = arr.subarray( 1, -1 );
1680+
// returns <Complex64Array>
1681+
1682+
var len = subarr.length;
1683+
// returns 2
1684+
1685+
var z = subarr.get( 0 );
1686+
// returns <Complex64>
1687+
1688+
var re = realf( z );
1689+
// returns 3.0
1690+
1691+
var im = imagf( z );
1692+
// returns 4.0
1693+
1694+
z = subarr.get( len-1 );
1695+
// returns <Complex64>
1696+
1697+
re = realf( z );
1698+
// returns 5.0
1699+
1700+
im = imagf( z );
1701+
// returns 6.0
1702+
```
1703+
16101704
</section>
16111705

16121706
<!-- /.usage -->

‎complex64/benchmark/benchmark.subarray.js‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
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' );
24+
var isComplex64Array = require( '@stdlib/assert/is-complex64array' );
25+
var pkg = require( './../package.json' ).name;
26+
var Complex64Array = require( './../lib' );
27+
28+
29+
// MAIN //
30+
31+
bench( pkg+':subarray', function benchmark( b ) {
32+
var out;
33+
var arr;
34+
var i;
35+
36+
arr = new Complex64Array( [ 1, 2, 3, 4, 5, 6 ] );
37+
38+
b.tic();
39+
for ( i = 0; i < b.iterations; i++ ) {
40+
out = arr.subarray();
41+
if ( typeof out !== 'object' ) {
42+
b.fail( 'should return an object' );
43+
}
44+
}
45+
b.toc();
46+
if ( !isComplex64Array( out ) ) {
47+
b.fail( 'should return a Complex64Array' );
48+
}
49+
b.pass( 'benchmark finished' );
50+
b.end();
51+
});

‎complex64/benchmark/benchmark.subarray.length.js‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
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' );
24+
var isComplex64Array = require( '@stdlib/assert/is-complex64array' );
25+
var pow = require( '@stdlib/math/base/special/pow' );
26+
var Complex64 = require( '@stdlib/complex/float32' );
27+
var pkg = require( './../package.json' ).name;
28+
var Complex64Array = require( './../lib' );
29+
30+
31+
// FUNCTIONS //
32+
33+
/**
34+
* Creates a benchmark function.
35+
*
36+
* @private
37+
* @param {PositiveInteger} len - array length
38+
* @returns {Function} benchmark function
39+
*/
40+
function createBenchmark( len ) {
41+
var arr;
42+
var i;
43+
44+
arr = [];
45+
for ( i = 0; i < len; i++ ) {
46+
arr.push( new Complex64( i, i ) );
47+
}
48+
arr = new Complex64Array( arr );
49+
50+
return benchmark;
51+
52+
/**
53+
* Benchmark function.
54+
*
55+
* @private
56+
* @param {Benchmark} b - benchmark instance
57+
*/
58+
function benchmark( b ) {
59+
var out;
60+
var i;
61+
62+
b.tic();
63+
for ( i = 0; i < b.iterations; i++ ) {
64+
out = arr.subarray();
65+
if ( typeof out !== 'object' ) {
66+
b.fail( 'should return an object' );
67+
}
68+
}
69+
b.toc();
70+
if ( !isComplex64Array( out ) ) {
71+
b.fail( 'should return a Complex64Array' );
72+
}
73+
b.pass( 'benchmark finished' );
74+
b.end();
75+
}
76+
}
77+
78+
79+
// MAIN //
80+
81+
/**
82+
* Main execution sequence.
83+
*
84+
* @private
85+
*/
86+
function main() {
87+
var len;
88+
var min;
89+
var max;
90+
var f;
91+
var i;
92+
93+
min = 1; // 10^min
94+
max = 6; // 10^max
95+
96+
for ( i = min; i <= max; i++ ) {
97+
len = pow( 10, i );
98+
f = createBenchmark( len );
99+
bench( pkg+':subarray:len='+len, f );
100+
}
101+
}
102+
103+
main();

‎complex64/docs/types/index.d.ts‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -761,6 +761,76 @@ declare class Complex64Array implements Complex64ArrayInterface {
761761
* // returns true
762762
*/
763763
some<U = unknown>( predicate: Predicate, thisArg?: ThisParameterType<Predicate<U>> ): boolean;
764+
765+
/**
766+
* Creates a new typed array view over the same underlying `ArrayBuffer` and with the same underlying data type as the host array.
767+
*
768+
* @param begin - starting index (inclusive)
769+
* @param end - ending index (exclusive)
770+
* @throws indices must be integers
771+
* @returns subarray
772+
*
773+
* @example
774+
* var realf = require( '@stdlib/complex/realf' );
775+
* var imagf = require( '@stdlib/complex/imagf' );
776+
*
777+
* var arr = new Complex64Array( 5 );
778+
*
779+
* arr.set( [ 1.0, -1.0 ], 0 );
780+
* arr.set( [ 2.0, -2.0 ], 1 );
781+
* arr.set( [ 3.0, -3.0 ], 2 );
782+
* arr.set( [ 4.0, -4.0 ], 3 );
783+
* arr.set( [ 5.0, -5.0 ], 4 );
784+
*
785+
* var subarr = arr.subarray();
786+
* // returns <Complex64Array>
787+
*
788+
* var len = subarr.length;
789+
* // returns 5
790+
*
791+
* var z = subarr.get( 0 );
792+
* // returns <Complex64>
793+
*
794+
* var re = realf( z );
795+
* // returns 1.0
796+
*
797+
* var im = imagf( z );
798+
* // returns -1.0
799+
*
800+
* z = subarr.get( len-1 );
801+
* // returns <Complex64>
802+
*
803+
* re = realf( z );
804+
* // returns 5.0
805+
*
806+
* im = imagf( z );
807+
* // returns -5.0
808+
*
809+
* subarr = arr.subarray( 1, -2 );
810+
* // returns <Complex64Array>
811+
*
812+
* len = subarr.length;
813+
* // returns 2
814+
*
815+
* z = subarr.get( 0 );
816+
* // returns <Complex64>
817+
*
818+
* re = realf( z );
819+
* // returns 2.0
820+
*
821+
* im = imagf( z );
822+
* // returns -2.0
823+
*
824+
* z = subarr.get( len-1 );
825+
* // returns <Complex64>
826+
*
827+
* re = realf( z );
828+
* // returns 3.0
829+
*
830+
* im = imagf( z );
831+
* // returns -3.0
832+
*/
833+
subarray( begin?: number, end?: number ): Complex64Array;
764834
}
765835

766836
/**

0 commit comments

Comments
 (0)