@stdlib/complex-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-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( 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_real( x[ i ] ) );
    }
}

See Also

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

Changelog

0.2.1 (2024-02-22)

<section class="features">

Features

• 9768c66 - update minimum TypeScript version

</section> <!-- /.features --> <section class="bug-fixes">

Bug Fixes

• 32a2827 - update import paths for complex type defs

</section> <!-- /.bug-fixes --> <section class="breaking-changes">

BREAKING CHANGES

• 9768c66: update minimum TypeScript version

• 9768c66: update minimum TypeScript version to 4.1

  • To migrate, users should upgrade their TypeScript version to at least version 4.1.

</section> <!-- /.breaking-changes --> <section class="commits">

Commits

<details>

• dea49e0 - docs: use single quotes in require calls instead of backticks (by Philipp Burckhardt)
• 1275ef7 - docs: update links (by Athan Reines)
• 9768c66 - feat: update minimum TypeScript version (by Philipp Burckhardt)
• 32a2827 - fix: update import paths for complex type defs (by Athan Reines)
• 07cc80b - docs: resolve C lint errors (by Athan Reines)
• 28e1c84 - docs: resolve C lint errors (by Athan Reines)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 2 people contributed to this release. Thank you to the following contributors:

• Athan Reines
• Philipp Burckhardt

</section> <!-- /.contributors --> </section> <!-- /.release -->