@stdlib/math-base-special-floor v0.2.2

Floor

Round a double-precision floating-point number toward negative infinity.

Installation

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

Usage

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

floor( x )

Rounds a double-precision floating-point number toward negative infinity.

var v = floor( -4.2 );
// returns -5.0

v = floor( 9.99999 );
// returns 9.0

v = floor( 0.0 );
// returns 0.0

v = floor( NaN );
// returns NaN

Examples

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

var x;
var i;

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

C APIs

Usage

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

stdlib_base_floor( x )

Rounds a double-precision floating-point number toward negative infinity.

double y = stdlib_base_floor( 3.14 );
// returns 3.0

The function accepts the following arguments:

• x: [in] double input value.

double stdlib_base_floor( const double x );

Examples

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

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

    double y;
    int i;
    for ( i = 0; i < 4; i++ ) {
        y = stdlib_base_floor( x[ i ] );
        printf( "floor(%lf) = %lf\n", x[ i ], y );
    }
}

See Also

• @stdlib/math-base/special/ceil: round a double-precision floating-point number toward positive infinity.
• @stdlib/math-base/special/round: round a numeric value to the nearest integer.

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.