@stdlib/math-base-special-signumf
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
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!

Signum

NPM version Build Status Coverage Status

Signum function.

The signum function is defined as

Signum function

for any real number x.

Installation

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

Usage

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

signumf( x )

Evaluates the signum function for a single-precision floating-point number.

var sign = signumf( -5.0 );
// returns -1

sign = signumf( 5.0 );
// returns 1

sign = signumf( -0.0 );
// returns -0

sign = signumf( 0.0 );
// returns 0

sign = signumf( NaN );
// returns NaN

Notes

Table of results:

Value Sign
x > 0 +1
x < 0 -1
0 0
-0 -0
NaN NaN

Examples

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

var sign;
var x;
var i;

for ( i = 0; i < 100; i++ ) {
    x = round( randu()*100.0 ) - 50.0;
    sign = signumf( x );
    console.log( 'signum(%d) = %d', x, sign );
}

C APIs

Usage

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

stdlib_base_signumf( x )

Evaluates the signum function for a single-precision floating-point number.

float y = stdlib_base_signumf( -9.0f );
// returns -1.0f

The function accepts the following arguments:

  • x: [in] float input value.
float stdlib_base_signumf( const float x );

Examples

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

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

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

See Also


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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/math-base-special-signumf

Homepage

stdlib.io

Weekly Downloads

25

Version

0.2.1

License

Apache-2.0

Unpacked Size

46.7 kB

Total Files

18

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser