128 lines
3.0 KiB
Markdown
128 lines
3.0 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2021 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.
|
|
|
|
-->
|
|
|
|
# Complex128Array
|
|
|
|
> 128-bit complex number array.
|
|
|
|
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
|
|
|
|
<section class="intro">
|
|
|
|
</section>
|
|
|
|
<!-- /.intro -->
|
|
|
|
<!-- Package usage documentation. -->
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var Complex128Array = require( '@stdlib/array/complex128' );
|
|
```
|
|
|
|
<a name="constructor"></a>
|
|
|
|
#### Complex128Array()
|
|
|
|
Creates a 128-bit complex number array.
|
|
|
|
```javascript
|
|
var arr = new Complex128Array();
|
|
// returns <Complex128Array>
|
|
```
|
|
|
|
<!-- /.usage -->
|
|
|
|
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="notes">
|
|
|
|
<!-- /.notes -->
|
|
|
|
<!-- Package usage examples. -->
|
|
|
|
<section class="examples">
|
|
|
|
* * *
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var Complex128 = require( '@stdlib/complex/float64' );
|
|
var Float64Array = require( '@stdlib/array/float64' );
|
|
var Complex128Array = require( '@stdlib/array/complex128' );
|
|
|
|
var arr;
|
|
var out;
|
|
|
|
// Create a complex array by specifying a length:
|
|
out = new Complex128Array( 3 );
|
|
console.log( out );
|
|
|
|
// Create a complex array from an array of complex numbers:
|
|
arr = [
|
|
new Complex128( 1.0, -1.0 ),
|
|
new Complex128( -3.14, 3.14 ),
|
|
new Complex128( 0.5, 0.5 )
|
|
];
|
|
out = new Complex128Array( arr );
|
|
console.log( out );
|
|
|
|
// Create a complex array from an interleaved typed array:
|
|
arr = new Float64Array( [ 1.0, -1.0, -3.14, 3.14, 0.5, 0.5 ] );
|
|
out = new Complex128Array( arr );
|
|
console.log( out );
|
|
|
|
// Create a complex array from an array buffer:
|
|
arr = new Float64Array( [ 1.0, -1.0, -3.14, 3.14, 0.5, 0.5 ] );
|
|
out = new Complex128Array( arr.buffer );
|
|
console.log( out );
|
|
|
|
// Create a complex array from an array buffer view:
|
|
arr = new Float64Array( [ 1.0, -1.0, -3.14, 3.14, 0.5, 0.5 ] );
|
|
out = new Complex128Array( arr.buffer, 16, 2 );
|
|
console.log( out );
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="references">
|
|
|
|
</section>
|
|
|
|
<!-- /.references -->
|
|
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="links">
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|