230 lines
4.7 KiB
Markdown
230 lines
4.7 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2018 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.
|
|
|
|
-->
|
|
|
|
# Complex128
|
|
|
|
> 128-bit complex number.
|
|
|
|
<!-- 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 Complex128 = require( '@stdlib/complex/float64' );
|
|
```
|
|
|
|
#### Complex128( real, imag )
|
|
|
|
128-bit complex number constructor, where `real` and `imag` are the **real** and **imaginary** components, respectively.
|
|
|
|
```javascript
|
|
var z = new Complex128( 5.0, 3.0 );
|
|
// returns <Complex128>
|
|
```
|
|
|
|
* * *
|
|
|
|
## Properties
|
|
|
|
#### Complex128.BYTES_PER_ELEMENT
|
|
|
|
Size (in bytes) of each component.
|
|
|
|
```javascript
|
|
var nbytes = Complex128.BYTES_PER_ELEMENT;
|
|
// returns 8
|
|
```
|
|
|
|
#### Complex128.prototype.BYTES_PER_ELEMENT
|
|
|
|
Size (in bytes) of each component.
|
|
|
|
```javascript
|
|
var z = new Complex128( 5.0, 3.0 );
|
|
|
|
var nbytes = z.BYTES_PER_ELEMENT;
|
|
// returns 8
|
|
```
|
|
|
|
#### Complex128.prototype.byteLength
|
|
|
|
Length (in bytes) of a complex number.
|
|
|
|
```javascript
|
|
var z = new Complex128( 5.0, 3.0 );
|
|
|
|
var nbytes = z.byteLength;
|
|
// returns 16
|
|
```
|
|
|
|
### Instance
|
|
|
|
A `Complex128` instance has the following properties...
|
|
|
|
#### re
|
|
|
|
A **read-only** property returning the **real** component.
|
|
|
|
```javascript
|
|
var z = new Complex128( 5.0, 3.0 );
|
|
|
|
var re = z.re;
|
|
// returns 5.0
|
|
```
|
|
|
|
#### im
|
|
|
|
A **read-only** property returning the **imaginary** component.
|
|
|
|
```javascript
|
|
var z = new Complex128( 5.0, -3.0 );
|
|
|
|
var im = z.im;
|
|
// returns -3.0
|
|
```
|
|
|
|
* * *
|
|
|
|
## Methods
|
|
|
|
### Accessor Methods
|
|
|
|
These methods do **not** mutate a `Complex128` instance and, instead, return a complex number representation.
|
|
|
|
#### Complex128.prototype.toString()
|
|
|
|
Returns a `string` representation of a `Complex128` instance.
|
|
|
|
```javascript
|
|
var z = new Complex128( 5.0, 3.0 );
|
|
var str = z.toString();
|
|
// returns '5 + 3i'
|
|
|
|
z = new Complex128( -5.0, -3.0 );
|
|
str = z.toString();
|
|
// returns '-5 - 3i'
|
|
```
|
|
|
|
#### Complex128.prototype.toJSON()
|
|
|
|
Returns a [JSON][json] representation of a `Complex128` instance. [`JSON.stringify()`][mdn-json-stringify] implicitly calls this method when stringifying a `Complex128` instance.
|
|
|
|
```javascript
|
|
var z = new Complex128( 5.0, -3.0 );
|
|
|
|
var o = z.toJSON();
|
|
/*
|
|
{
|
|
"type": "Complex128",
|
|
"re": 5.0,
|
|
"im": -3.0
|
|
}
|
|
*/
|
|
```
|
|
|
|
To [revive][mdn-json-parse] a `Complex128` number from a [JSON][json] `string`, see [@stdlib/complex/reviver-float64][@stdlib/complex/reviver-float64].
|
|
|
|
</section>
|
|
|
|
<!-- /.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
|
|
|
|
- Both the **real** and **imaginary** components are stored as double-precision floating-point numbers.
|
|
|
|
</section>
|
|
|
|
<!-- /.notes -->
|
|
|
|
* * *
|
|
|
|
<!-- Package usage examples. -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var Complex128 = require( '@stdlib/complex/float64' );
|
|
|
|
var z = new Complex128( 3.0, -2.0 );
|
|
|
|
console.log( 'type: %s', typeof z );
|
|
// => type: object
|
|
|
|
console.log( 'str: %s', z );
|
|
// => str: 3 - 2i
|
|
|
|
console.log( 'real: %d', z.re );
|
|
// => real: 3.0
|
|
|
|
console.log( 'imag: %d', z.im );
|
|
// => imag: -2.0
|
|
|
|
console.log( 'JSON: %s', JSON.stringify( z ) );
|
|
// => JSON: {"type":"Complex128","re":3,"im":-2}
|
|
```
|
|
|
|
</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">
|
|
|
|
[json]: http://www.json.org/
|
|
|
|
[mdn-json-stringify]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
|
|
|
|
[mdn-json-parse]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse
|
|
|
|
[@stdlib/complex/reviver-float64]: https://www.npmjs.com/package/@stdlib/complex/tree/main/reviver-float64
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|