@stdlib/math-base-special-ceiln NPM

ceiln

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

Round a numeric value to the nearest multiple of 10^n toward positive infinity.

Installation

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

Usage

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

ceiln( x, n )

Rounds a numeric value to the nearest multiple of 10^n toward positive infinity.

// Round a value to 2 decimal places:
var v = ceiln( 3.141592653589793, -2 );
// returns 3.15

// If n = 0, `ceiln` behaves like `ceil`:
v = ceiln( 3.141592653589793, 0 );
// returns 4.0

// Round a value to the nearest thousand:
v = ceiln( 12368.0, 3 );
// returns 13000.0

Notes

When operating on floating-point numbers in bases other than 2, rounding to specified digits can be inexact. For example,

var x = 0.2 + 0.1;
// returns 0.30000000000000004

// Should round to 0.3:
var v = ceiln( x, -16 );
// returns 0.3000000000000001

Examples

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

var x;
var n;
var v;
var i;

for ( i = 0; i < 100; i++ ) {
    x = (randu()*100.0) - 50.0;
    n = ceiln( randu()*5.0, 0 );
    v = ceiln( x, -n );
    console.log( 'x: %d. Number of decimals: %d. Rounded: %d.', x, n, v );
}

C APIs

Usage

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

stdlib_base_ceiln( x, n )

Rounds a double-precision floating-point number to the nearest multiple of 10^n toward positive infinity.

// Round a value to 2 decimal places:
double y = stdlib_base_ceiln( 3.141592653589793, -2 );
// returns 3.15

// If n = 0, `ceiln` behaves like `ceil`:
double y = stdlib_base_ceiln( 3.141592653589793, 0 );
// returns 4.0

// Round a value to the nearest thousand:
double y = stdlib_base_ceiln( 12368.0, 3 );
// returns 13000.0

The function accepts the following arguments:

x: [in] double input value.
n: [in] int32_t integer power of 10.

double stdlib_base_ceiln( const double x, const int32_t n );

Examples

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

int main() {
    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_ceiln( x[ i ], -2 );
        printf( "ceiln(%lf, -2) = %lf\n", x[ i ], 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.