Gathering detailed insights and metrics for @stdlib/complex-float64-ctor
Installations
npm install @stdlib/complex-float64-ctorDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Min. Node Version
>=0.10.0
Node Version
16.20.2
NPM Version
8.19.4
Score
99.2
Supply Chain
92
Quality
82.5
Maintenance
100
Vulnerability
88
License
Releases
Unable to fetch releases
Contributors
11
Unable to fetch Contributors
Languages
2
C
JavaScript
C (64.82%)
JavaScript (35.18%)
Developer
Download Statistics
Total Downloads
1,396,701
Last Day
17,604
Last Week
80,190
Last Month
355,421
Last Year
1,396,701
GitHub Statistics
1 Stars
12 Commits
2 Watching
5 Branches
11 Contributors
Bundle Size
9.59 kB
Minified
2.97 kB
Minified + Gzipped
Sponsor this package
Maintainers
4
Package Meta Information
Latest Version
0.0.3
Package Id
@stdlib/complex-float64-ctor@0.0.3
Unpacked Size
61.75 kB
Size
13.13 kB
File Count
16
NPM Version
8.19.4
Node Version
16.20.2
Publised On
27 Jul 2024
Total Downloads
Cumulative downloads
Total Downloads
1,396,701
Last day
32.3%
17,604
Compared to previous day
Last week
-8%
80,190
Compared to previous week
Last month
30.6%
355,421
Compared to previous month
Last year
0%
1,396,701
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Complex128
128-bit complex number.
Installation
1npm install @stdlib/complex-float64-ctor
Usage
1var Complex128 = require( '@stdlib/complex-float64-ctor' );
Complex128( real, imag )
128-bit complex number constructor, where real and imag are the real and imaginary components, respectively.
1var z = new Complex128( 5.0, 3.0 ); 2// returns <Complex128>
Properties
Complex128.BYTES_PER_ELEMENT
Size (in bytes) of each component.
1var nbytes = Complex128.BYTES_PER_ELEMENT; 2// returns 8
Complex128.prototype.BYTES_PER_ELEMENT
Size (in bytes) of each component.
1var z = new Complex128( 5.0, 3.0 ); 2 3var nbytes = z.BYTES_PER_ELEMENT; 4// returns 8
Complex128.prototype.byteLength
Length (in bytes) of a complex number.
1var z = new Complex128( 5.0, 3.0 ); 2 3var nbytes = z.byteLength; 4// returns 16
Instance
A Complex128 instance has the following properties...
re
A read-only property returning the real component.
1var z = new Complex128( 5.0, 3.0 ); 2 3var re = z.re; 4// returns 5.0
im
A read-only property returning the imaginary component.
1var z = new Complex128( 5.0, -3.0 ); 2 3var im = z.im; 4// 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.
1var z = new Complex128( 5.0, 3.0 ); 2var str = z.toString(); 3// returns '5 + 3i' 4 5z = new Complex128( -5.0, -3.0 ); 6str = z.toString(); 7// returns '-5 - 3i'
Complex128.prototype.toJSON()
Returns a JSON representation of a Complex128 instance. JSON.stringify() implicitly calls this method when stringifying a Complex128 instance.
1var z = new Complex128( 5.0, -3.0 ); 2 3var o = z.toJSON(); 4/* 5 { 6 "type": "Complex128", 7 "re": 5.0, 8 "im": -3.0 9 } 10*/
To revive a Complex128 number from a JSON string, see @stdlib/complex/float64/reviver.
Notes
- Both the real and imaginary components are stored as double-precision floating-point numbers.
Examples
1var Complex128 = require( '@stdlib/complex-float64-ctor' ); 2 3var z = new Complex128( 3.0, -2.0 ); 4 5console.log( 'type: %s', typeof z ); 6// => 'type: object' 7 8console.log( 'str: %s', z ); 9// => 'str: 3 - 2i' 10 11console.log( 'real: %d', z.re ); 12// => 'real: 3' 13 14console.log( 'imaginary: %d', z.im ); 15// => 'imaginary: -2' 16 17console.log( 'JSON: %s', JSON.stringify( z ) ); 18// => 'JSON: {"type":"Complex128","re":3,"im":-2}'
C APIs
Usage
1#include "stdlib/complex/float64/ctor.h"
stdlib_complex128_t
An opaque type definition for a double-precision complex floating-point number.
1stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 );
stdlib_complex128_parts_t
An opaque type definition for a union for accessing the real and imaginary parts of a double-precision complex floating-point number.
1double real( const stdlib_complex128_t z ) { 2 stdlib_complex128_parts_t v; 3 4 // Assign a double-precision complex floating-point number: 5 v.value = z; 6 7 // Extract the real component: 8 double re = v.parts[ 0 ]; 9 10 return re; 11} 12 13// ... 14 15// Create a complex number: 16stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 ); 17 18// ... 19 20// Access the real component: 21double re = real( z ); 22// returns 5.0
The union has the following members:
-
value:
stdlib_complex128_tdouble-precision complex floating-point number. -
parts:
double[]array having the following elements:- 0:
doublereal component. - 1:
doubleimaginary component.
- 0:
stdlib_complex128( real, imag )
Returns a double-precision complex floating-point number.
1stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 );
The function accepts the following arguments:
- real:
[in] doublereal component. - imag:
[in] doubleimaginary component.
1stdlib_complex128_t stdlib_complex128( const double real, const double imag );
stdlib_complex128_from_float32( real )
Converts a single-precision floating-point number to a double-precision complex floating-point number.
1stdlib_complex128_t z = stdlib_complex128_from_float32( 5.0f );
The function accepts the following arguments:
- real:
[in] floatreal component.
1stdlib_complex128_t stdlib_complex128_from_float32( const float real );
stdlib_complex128_from_float64( real )
Converts a double-precision floating-point number to a double-precision complex floating-point number.
1stdlib_complex128_t z = stdlib_complex128_from_float64( 5.0 );
The function accepts the following arguments:
- real:
[in] doublereal component.
1stdlib_complex128_t stdlib_complex128_from_float64( const double real );
stdlib_complex128_from_complex64( z )
Converts a single-precision complex floating-point number to a double-precision complex floating-point number.
1#include "stdlib/complex/float32/ctor.h" 2 3stdlib_complex64_t z1 = stdlib_complex64( 5.0f, 3.0f ); 4stdlib_complex128_t z2 = stdlib_complex128_from_complex64( z1 );
The function accepts the following arguments:
- z:
[in] stdlib_complex64_tsingle-precision complex floating-point number.
1stdlib_complex128_t stdlib_complex128_from_complex64( const stdlib_complex64_t z );
stdlib_complex128_from_complex128( z )
Converts (copies) a double-precision complex floating-point number to a double-precision complex floating-point number.
1stdlib_complex128_t z1 = stdlib_complex128( 5.0, 3.0 ); 2stdlib_complex128_t z2 = stdlib_complex128_from_complex128( z1 );
The function accepts the following arguments:
- z:
[in] stdlib_complex128_tdouble-precision complex floating-point number.
1stdlib_complex128_t stdlib_complex128_from_complex128( const stdlib_complex128_t z );
stdlib_complex128_from_int8( real )
Converts a signed 8-bit integer to a double-precision complex floating-point number.
1stdlib_complex128_t z = stdlib_complex128_from_int8( 5 );
The function accepts the following arguments:
- real:
[in] int8_treal component.
1stdlib_complex128_t stdlib_complex128_from_int8( const int8_t real );
stdlib_complex128_from_uint8( real )
Converts an unsigned 8-bit integer to a double-precision complex floating-point number.
1stdlib_complex128_t z = stdlib_complex128_from_uint8( 5 );
The function accepts the following arguments:
- real:
[in] uint8_treal component.
1stdlib_complex128_t stdlib_complex128_from_uint8( const uint8_t real );
stdlib_complex128_from_int16( real )
Converts a signed 16-bit integer to a double-precision complex floating-point number.
1stdlib_complex128_t z = stdlib_complex128_from_int16( 5 );
The function accepts the following arguments:
- real:
[in] int16_treal component.
1stdlib_complex128_t stdlib_complex128_from_int16( const int16_t real );
stdlib_complex128_from_uint16( real )
Converts an unsigned 16-bit integer to a double-precision complex floating-point number.
1stdlib_complex128_t z = stdlib_complex128_from_uint16( 5 );
The function accepts the following arguments:
- real:
[in] uint16_treal component.
1stdlib_complex128_t stdlib_complex128_from_uint16( const uint16_t real );
stdlib_complex128_from_int32( real )
Converts a signed 32-bit integer to a double-precision complex floating-point number.
1stdlib_complex128_t z = stdlib_complex128_from_int32( 5 );
The function accepts the following arguments:
- real:
[in] int32_treal component.
1stdlib_complex128_t stdlib_complex128_from_int32( const int32_t real );
stdlib_complex128_from_uint32( real )
Converts an unsigned 32-bit integer to a double-precision complex floating-point number.
1stdlib_complex128_t z = stdlib_complex128_from_uint32( 5 );
The function accepts the following arguments:
- real:
[in] uint32_treal component.
1stdlib_complex128_t stdlib_complex128_from_uint32( const uint32_t real );
stdlib_complex128_to_complex64( z )
Converts a double-precision complex floating-point number to a single-precision complex floating-point number.
1#include "stdlib/complex/float32/ctor.h" 2 3stdlib_complex128_t z1 = stdlib_complex128( 5.0, 3.0 ); 4stdlib_complex64_t z2 = stdlib_complex128_to_complex64( z1 );
The function accepts the following arguments:
- z:
[in] stdlib_complex64_tdouble-precision complex floating-point number.
1stdlib_complex64_t stdlib_complex128_to_complex64( const stdlib_complex128_t z );
Examples
1#include "stdlib/complex/float64/ctor.h" 2#include <stdint.h> 3#include <stdio.h> 4 5/** 6* Return the real component of a double-precision complex floating-point number. 7* 8* @param z complex number 9* @return real component 10*/ 11static double real( const stdlib_complex128_t z ) { 12 stdlib_complex128_parts_t v; 13 14 // Assign a double-precision complex floating-point number: 15 v.value = z; 16 17 // Extract the real component: 18 double re = v.parts[ 0 ]; 19 20 return re; 21} 22 23/** 24* Return the imaginary component of a double-precision complex floating-point number. 25* 26* @param z complex number 27* @return imaginary component 28*/ 29static double imag( const stdlib_complex128_t z ) { 30 stdlib_complex128_parts_t v; 31 32 // Assign a double-precision complex floating-point number: 33 v.value = z; 34 35 // Extract the imaginary component: 36 double im = v.parts[ 1 ]; 37 38 return im; 39} 40 41int main( void ) { 42 const stdlib_complex128_t x[] = { 43 stdlib_complex128( 5.0, 2.0 ), 44 stdlib_complex128( -2.0, 1.0 ), 45 stdlib_complex128( 0.0, -0.0 ), 46 stdlib_complex128( 0.0/0.0, 0.0/0.0 ) 47 }; 48 49 stdlib_complex128_t v; 50 int i; 51 for ( i = 0; i < 4; i++ ) { 52 v = x[ i ]; 53 printf( "%lf + %lfi\n", real( v ), imag( v ) ); 54 } 55}
See Also
@stdlib/complex-cmplx: create a complex number.@stdlib/complex-float32/ctor: 64-bit complex number.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.
No vulnerabilities found.
No security vulnerabilities found.