Skip to content

Commit 4bfbed8

Browse files
Jaysukh-409Jaysukh-409
authored
feat: add slice method to array/complex128
PR-URL: #1355 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 57a1c66 commit 4bfbed8

File tree

6 files changed

+719
-0
lines changed

6 files changed

+719
-0
lines changed

‎lib/node_modules/@stdlib/array/complex128/README.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1799,6 +1799,100 @@ A few notes:
17991799
- If a target array cannot accommodate all values (i.e., the length of source array plus `i` exceeds the target array length), the method throws an error.
18001800
- If provided a [typed array][@stdlib/array/typed] which shares an [`ArrayBuffer`][@stdlib/array/buffer] with the target array, the method will intelligently copy the source range to the destination range.
18011801

1802+
<a name="method-slice"></a>
1803+
1804+
#### Complex128Array.prototype.slice( \[start\[, end]] )
1805+
1806+
Copies a portion of a typed array to a new typed array.
1807+
1808+
```javascript
1809+
var real = require( '@stdlib/complex/real' );
1810+
var imag = require( '@stdlib/complex/imag' );
1811+
1812+
var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
1813+
1814+
var out = arr.slice();
1815+
// returns <Complex128Array>
1816+
1817+
var len = out.length;
1818+
// returns 4
1819+
1820+
var z = out.get( 0 );
1821+
// returns <Complex128>
1822+
1823+
var re = real( z );
1824+
// returns 1.0
1825+
1826+
var im = imag( z );
1827+
// returns 2.0
1828+
1829+
z = out.get( len-1 );
1830+
// returns <Complex128>
1831+
1832+
re = real( z );
1833+
// returns 7.0
1834+
1835+
im = imag( z );
1836+
// returns 8.0
1837+
```
1838+
1839+
By default, the method returns a typed array beginning with the first array element. To specify an alternative array index at which to begin, provide a `start` index (inclusive).
1840+
1841+
```javascript
1842+
var imag = require( '@stdlib/complex/imag' );
1843+
var real = require( '@stdlib/complex/real' );
1844+
1845+
var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
1846+
1847+
var out = arr.slice( 1 );
1848+
// returns <Complex128Array>
1849+
1850+
var len = out.length;
1851+
// returns 3
1852+
1853+
var z = out.get( 0 );
1854+
// returns <Complex128>
1855+
1856+
var re = real( z );
1857+
// returns 3.0
1858+
1859+
var im = imag( z );
1860+
// returns 4.0
1861+
```
1862+
1863+
By default, the method returns a typed array which includes all array elements after `start`. To limit the number of array elements after `start`, provide an `end` index (exclusive).
1864+
1865+
```javascript
1866+
var real = require( '@stdlib/complex/real' );
1867+
var imag = require( '@stdlib/complex/imag' );
1868+
1869+
var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
1870+
1871+
var out = arr.slice( 1, -1 );
1872+
// returns <Complex128Array>
1873+
1874+
var len = out.length;
1875+
// returns 2
1876+
1877+
var z = out.get( 0 );
1878+
// returns <Complex128>
1879+
1880+
var re = real( z );
1881+
// returns 3.0
1882+
1883+
var im = imag( z );
1884+
// returns 4.0
1885+
1886+
z = out.get( len-1 );
1887+
// returns <Complex128>
1888+
1889+
re = real( z );
1890+
// returns 5.0
1891+
1892+
im = imag( z );
1893+
// returns 6.0
1894+
```
1895+
18021896
<a name="method-some"></a>
18031897

18041898
#### Complex128Array.prototype.some( predicate\[, thisArg] )

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

‎lib/node_modules/@stdlib/array/complex128/benchmark/benchmark.slice.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 isComplex128Array = require( '@stdlib/assert/is-complex128array' );
25+
var pow = require( '@stdlib/math/base/special/pow' );
26+
var Complex128 = require( '@stdlib/complex/float64' );
27+
var pkg = require( './../package.json' ).name;
28+
var Complex128Array = 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 Complex128( i, i ) );
47+
}
48+
arr = new Complex128Array( 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.slice();
65+
if ( typeof out !== 'object' ) {
66+
b.fail( 'should return an object' );
67+
}
68+
}
69+
b.toc();
70+
if ( !isComplex128Array( out ) ) {
71+
b.fail( 'should return a Complex128Array' );
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+':slice:len='+len, f );
100+
}
101+
}
102+
103+
main();

‎lib/node_modules/@stdlib/array/complex128/docs/types/index.d.ts

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -917,6 +917,76 @@ declare class Complex128Array implements Complex128ArrayInterface {
917917
*/
918918
set( value: ArrayLike<number | ComplexLike> | RealOrComplexTypedArray | ComplexLike, i?: number ): void;
919919

920+
/**
921+
* Copies a portion of a typed array to a new typed array.
922+
*
923+
* @param start - starting index (inclusive)
924+
* @param end - ending index (exclusive)
925+
* @throws indices must be integers
926+
* @returns output array
927+
*
928+
* @example
929+
* var real = require( '@stdlib/complex/real' );
930+
* var imag = require( '@stdlib/complex/imag' );
931+
*
932+
* var arr = new Complex128Array( 5 );
933+
*
934+
* arr.set( [ 1.0, -1.0 ], 0 );
935+
* arr.set( [ 2.0, -2.0 ], 1 );
936+
* arr.set( [ 3.0, -3.0 ], 2 );
937+
* arr.set( [ 4.0, -4.0 ], 3 );
938+
* arr.set( [ 5.0, -5.0 ], 4 );
939+
*
940+
* var out = arr.slice();
941+
* // returns <Complex128Array>
942+
*
943+
* var len = out.length;
944+
* // returns 5
945+
*
946+
* var z = out.get( 0 );
947+
* // returns <Complex128>
948+
*
949+
* var re = real( z );
950+
* // returns 1.0
951+
*
952+
* var im = imag( z );
953+
* // returns -1.0
954+
*
955+
* z = out.get( len-1 );
956+
* // returns <Complex128>
957+
*
958+
* re = real( z );
959+
* // returns 5.0
960+
*
961+
* im = imag( z );
962+
* // returns -5.0
963+
*
964+
* out = arr.slice( 1, -2 );
965+
* // returns <Complex128Array>
966+
*
967+
* len = out.length;
968+
* // returns 2
969+
*
970+
* z = out.get( 0 );
971+
* // returns <Complex128>
972+
*
973+
* re = real( z );
974+
* // returns 2.0
975+
*
976+
* im = imag( z );
977+
* // returns -2.0
978+
*
979+
* z = out.get( len-1 );
980+
* // returns <Complex128>
981+
*
982+
* re = real( z );
983+
* // returns 3.0
984+
*
985+
* im = imag( z );
986+
* // returns -3.0
987+
*/
988+
slice( start?: number, end?: number ): Complex128Array;
989+
920990
/**
921991
* Tests whether at least one element in an array passes a test implemented by a predicate function.
922992
*

0 commit comments

Comments
 (0)