@stdlib/complex-real

real

Return the real component of a double-precision complex floating-point number.

Installation

npm install @stdlib/complex-real

Usage

var real = require( '@stdlib/complex-real' );

real( z )

Returns the real component of a double-precision complex floating-point number.

var Complex128 = require( '@stdlib/complex-float64' );

var z = new Complex128( 5.0, 3.0 );
var re = real( z );
// returns 5.0

Examples

var Complex128 = require( '@stdlib/complex-float64' );
var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var real = require( '@stdlib/complex-real' );

var re;
var im;
var z;
var i;

for ( i = 0; i < 100; i++ ) {
    re = round( (randu()*100.0) - 50.0 );
    im = round( (randu()*50.0) - 25.0 );
    z = new Complex128( re, im );
    console.log( 'real(%s) = %d', z.toString(), real( z ) );
}

---

C APIs

Usage

#include "stdlib/complex/real.h"

stdlib_real( z )

Returns the real component of a double-precision complex floating-point number.

#include "stdlib/complex/float64.h"

stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 );

// ...

double re = stdlib_real( z );
// returns 5.0

The function accepts the following arguments:

• z: [in] stdlib_complex128_t double-precision complex floating-point number.

double stdlib_real( const stdlib_complex128_t z );

Examples

#include "stdlib/complex/real.h"
#include "stdlib/complex/float64.h"
#include <stdio.h>

int main() {
    stdlib_complex128_t x[] = {
        stdlib_complex128( 5.0, 2.0 ),
        stdlib_complex128( -2.0, 1.0 ),
        stdlib_complex128( 0.0, -0.0 ),
        stdlib_complex128( 0.0/0.0, 0.0/0.0 )
    };

    int i;
    for ( i = 0; i < 4; i++ ) {
        printf( "real(v) = %lf\n", stdlib_real( x[ i ] ) );
    }
}

---

See Also

• @stdlib/complex/imag: return the imaginary component of a complex number.
• @stdlib/complex/reim: return the real and imaginary components of a 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-2022. The Stdlib Authors.