@stdlib/complex-float64-real

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!

real

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

Installation

npm install @stdlib/complex-float64-real

Usage

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

real( z )

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

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

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

Examples

var Complex128 = require( '@stdlib/complex-float64-ctor' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var filledarrayBy = require( '@stdlib/array-filled-by' );
var real = require( '@stdlib/complex-float64-real' );

function random() {
    return new Complex128( discreteUniform( -10, 10 ), discreteUniform( -10, 10 ) ); // eslint-disable-line max-len
}

// Generate an array of random complex numbers:
var x = filledarrayBy( 100, 'complex128', random );
// returns <Complex128Array>

// Retrieve the real component of each complex number...
var z;
var i;
for ( i = 0; i < x.length; i++ ) {
    z = x.get( i );
    console.log( 'real(%s) = %d', z.toString(), real( z ) );
}

---

C APIs

Usage

#include "stdlib/complex/float64/real.h"

stdlib_complex128_real( z )

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

#include "stdlib/complex/float64/ctor.h"

stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 );

// ...

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

The function accepts the following arguments:

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

double stdlib_complex128_real( const stdlib_complex128_t z );

Examples

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

int main( void ) {
    const 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_complex128_real( x[ i ] ) );
    }
}

---

See Also

• @stdlib/complex-float64/imag: return the imaginary component of a double-precision complex floating-point number.
• @stdlib/complex-float64/reim: return the real and imaginary components of a double-precision complex floating-point 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.