Package Exports
- @stdlib/math-base-special-flipsign
- @stdlib/math-base-special-flipsign/dist
- @stdlib/math-base-special-flipsign/dist/index.js
- @stdlib/math-base-special-flipsign/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/math-base-special-flipsign) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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!
flipsign
Return a double-precision floating-point number with the magnitude of
xand the sign ofx*y.
Installation
npm install @stdlib/math-base-special-flipsignUsage
var flipsign = require( '@stdlib/math-base-special-flipsign' );flipsign( x, y )
Returns a double-precision floating-point number with the magnitude of x and the sign of x*y (i.e., only return -x when y is a negative number).
var z = flipsign( -3.0, 10.0 );
// returns -3.0
z = flipsign( -3.0, -1.0 );
// returns 3.0
z = flipsign( 1.0, -0.0 );
// returns -1.0
z = flipsign( -3.0, -0.0 );
// returns 3.0
z = flipsign( -0.0, 1.0 );
// returns -0.0
z = flipsign( 0.0, -1.0 );
// returns -0.0Notes
- According to the IEEE 754 standard, a
NaNhas a biased exponent equal to2047, a significand greater than0, and a sign bit equal to either1or0. In which case,NaNmay not correspond to just one but many binary representations. Accordingly, care should be taken to ensure thatyis notNaN; otherwise, behavior may be indeterminate.
Examples
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var flipsign = require( '@stdlib/math-base-special-flipsign' );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -50.0, 50.0, opts );
var y = uniform( 100, -5.0, 5.0, opts );
// Generate random numbers `x` and `y` and flip the sign of `x` only if `y` is negative...
logEachMap( 'x: %0.4f, y: %0.4f => %0.4f', x, y, flipsign );C APIs
Usage
#include "stdlib/math/base/special/flipsign.h"stdlib_base_flipsign( x, y )
Returns a double-precision floating-point number with the magnitude of x and the sign of x*y.
double v = stdlib_base_flipsign( -3.0, 10.0 );
// returns -3.0
v = stdlib_base_flipsign( -3.0, -1.0 );
// returns 3.0The function accepts the following arguments:
- x:
[in] doublenumber from which to derive a magnitude. - y:
[in] doublenumber from which to derive a sign.
double stdlib_base_flipsign( const double x, const double y );Examples
#include "stdlib/math/base/special/flipsign.h"
#include <stdio.h>
int main( void ) {
const double x[] = { 3.0, -3.0, 0.0, 0.0/0.0 };
double y;
int i;
for ( i = 0; i < 4; i++ ) {
y = stdlib_base_flipsign( x[ i ], -3.0 );
printf( "flipsign(%lf, %lf) = %lf\n", x[ i ], -3.0, 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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2026. The Stdlib Authors.