time-to-botec/squiggle/node_modules/@stdlib/math/base/special/truncf/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.9 KiB

Truncate

Round a single-precision floating-point number toward zero.

Usage

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

truncf( x )

Rounds a single-precision floating-point number toward zero.

var v = truncf( -4.2 );
// returns -4.0

v = truncf( 9.99999 );
// returns 9.0

v = truncf( 0.0 );
// returns 0.0

v = truncf( -0.0 );
// returns -0.0

v = truncf( NaN );
// returns NaN

v = truncf( Infinity );
// returns Infinity

v = truncf( -Infinity );
// returns -Infinity

Examples

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

var x;
var i;

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

C APIs

Usage

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

stdlib_base_truncf( x )

Rounds a single-precision floating-point number toward zero.

float y = stdlib_base_truncf( 3.5f );
// returns 3.0f

The function accepts the following arguments:

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

Examples

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

int main() {
    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_truncf( x[ i ] );
        printf( "trunc(%f) = %f\n", x[ i ], y );
    }
}