@stdlib/math-base-special-copysignf NPM

copysignf

$NPM version$ $Build Status$ $Coverage Status$

Return a single-precision floating-point number with the magnitude of x and the sign of y.

Installation

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

Usage

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

copysignf( x, y )

Returns a single-precision floating-point number with the magnitude of x and the sign of y.

var z = copysignf( -3.0, 10.0 );
// returns 3.0

z = copysignf( 3.0, -1.0 );
// returns -3.0

z = copysignf( 1.0, -0.0 );
// returns -1.0

z = copysignf( -3.0, -0.0 );
// returns -3.0

z = copysignf( -0.0, 1.0 );
// returns 0.0

Notes

According to the IEEE754 standard, a NaN has a biased exponent equal to 255, a significand greater than 0, and a sign bit equal to either 1 or 0. In which case, NaN may not correspond to just one but many binary representations. Accordingly, care should be taken to ensure that y is not NaN; otherwise, behavior may be indeterminate.

Examples

var randu = require( '@stdlib/random-base-randu' );
var copysignf = require( '@stdlib/math-base-special-copysignf' );

var x;
var y;
var z;
var i;

// Generate random numbers `x` and `y` and copy the sign of `y` to `x`...
for ( i = 0; i < 100; i++ ) {
    x = (randu()*100.0) - 50.0;
    y = (randu()*10.0) - 5.0;
    z = copysignf( x, y );
    console.log( 'x: %d, y: %d => %d', x, y, z );
}

C APIs

Usage

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

stdlib_base_copysignf( x, y )

Returns a single-precision floating-point number with the magnitude of x and the sign of y.

float v = stdlib_base_copysignf( -3.0f, 10.0f );
// returns 3.0f

float v = stdlib_base_copysignf( 3.0f, -1.0f );
// returns -3.0f

The function accepts the following arguments:

x: [in] float number from which to derive a magnitude.
y: [in] float number from which to derive a sign.

float stdlib_base_copysignf( const float x, const float y );

Examples

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

int main( void ) {
    const float x[] = { 3.0f, -3.0f, 0.0f, 0.0f/0.0f };

    float y;
    int i;
    for ( i = 0; i < 4; i++ ) {
        y = stdlib_base_copysignf( x[ i ], -3.0f );
        printf( "copysignf(%f, %f) = %f\n", x[ i ], -3.0f, y );
    }
}

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.