@stdlib/math-base-special-cflipsignf

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!

cflipsignf

Return a single-precision complex floating-point number with the same magnitude as z and the sign of y*z.

Installation

npm install @stdlib/math-base-special-cflipsignf

Usage

var cflipsignf = require( '@stdlib/math-base-special-cflipsignf' );

cflipsignf( z, y )

Returns a single-precision complex floating-point number with the same magnitude as z and the sign of y*z.

var Complex64 = require( '@stdlib/complex-float32-ctor' );
var real = require( '@stdlib/complex-float32-real' );
var imag = require( '@stdlib/complex-float32-imag' );

var v = cflipsignf( new Complex64( -4.0, 5.0 ), -1.0 );
// returns <Complex64>

var re = real( v );
// returns 4.0

var im = imag( v );
// returns -5.0

Examples

var uniform = require( '@stdlib/random-base-uniform' ).factory;
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var cflipsignf = require( '@stdlib/math-base-special-cflipsignf' );

var rand = uniform( -50.0, 50.0 );

var z;
var y;
var i;
for ( i = 0; i < 100; i++ ) {
    z = new Complex64( rand(), rand() );
    y = rand();
    console.log( 'cflipsignf(%s, %d) = %s', z, y, cflipsignf( z, y ) );
}

---

C APIs

Usage

#include "stdlib/math/base/special/cflipsignf.h"

stdlib_base_cflipsignf( z, y )

Returns a single-precision complex floating-point number with the same magnitude as z and the sign of y*z.

#include <complex.h>

float complex y = stdlib_base_cflipsignf( 2.0-1.0*I, -1.0 );
// returns -2.0+1.0*I

The function accepts the following arguments:

• z: [in] float complex input value.
• y: [in] float number from which to derive the sign.

float complex stdlib_base_cflipsignf( const float complex z, const float y );

Examples

#include "stdlib/math/base/special/cflipsignf.h"
#include <stdio.h>
#include <complex.h>

int main( void ) {
    const float complex x[] = { 3.14f+1.5f*I, -3.14f-1.5f*I, 0.0f+0.0f*I, 0.0f/0.0f+0.0f/0.0f*I };

    float complex v;
    float complex y;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = x[ i ];
        y = stdlib_base_cflipsignf( v, -1.0f );
        printf( "cflipsignf(%f + %fi, %f) = %f + %fi\n", crealf( v ), cimagf( v ), -1.0f, crealf( y ), cimagf( y ) );
    }
}

---

See Also

• @stdlib/math-base/ops/cnegf: negate a single-precision complex floating-point number.
• @stdlib/math-base/special/cflipsign: return a double-precision complex floating-point number with the same magnitude as z and the sign of y*z.

---

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.2 (2024-07-27)

<section class="commits">

Commits

<details>

• 8d4c46b - refactor: update paths (by Athan Reines)
• ed9c0a5 - refactor: update paths (by Athan Reines)
• 18b3c79 - refactor: update paths (by Athan Reines)
• 038b199 - docs: update paths (by Athan Reines)
• 75d4f83 - refactor: update require and include paths (by Athan Reines)
• 41d41e9 - test: include trailing newlines in Julia-generated JSON fixtures (by Philipp Burckhardt)
• 9ed7d0e - chore: add missing trailing newlines (by Philipp Burckhardt)

</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 --> <section class="release" id="v0.2.1">