@stdlib/math-base-special-trunc

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!

Truncate

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

Installation

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

Usage

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

trunc( x )

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

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

v = trunc( 9.99999 );
// returns 9.0

v = trunc( 0.0 );
// returns 0.0

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

v = trunc( NaN );
// returns NaN

v = trunc( Infinity );
// returns Infinity

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

Examples

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

var x;
var i;

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

---

C APIs

Usage

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

stdlib_base_trunc( x )

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

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

The function accepts the following arguments:

• x: [in] double input value.

double stdlib_base_trunc( const double x );

Examples

#include "stdlib/math/base/special/trunc.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_trunc( x[ i ] );
        printf( "trunc(%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/floor: round a double-precision floating-point number toward negative 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-2023. The Stdlib Authors.

Changelog

0.1.0 (2023-09-23)

<section class="features">

Features

• 58832ee - update minimum TypeScript version

</section> <!-- /.features --> <section class="breaking-changes">

BREAKING CHANGES

• 58832ee: update minimum TypeScript version to 4.1

  • To migrate, users should upgrade their TypeScript version to at least version 4.1.

</section> <!-- /.breaking-changes --> <section class="commits">

Commits

<details>

• 58832ee - feat: update minimum TypeScript version (by Philipp Burckhardt)
• 5363054 - docs: resolve C lint errors (by Athan Reines)
• b9e414a - docs: resolve C lint errors (by Athan Reines)
• 28e1c84 - docs: resolve C lint errors (by Athan Reines)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 2 people contributed to this release. Thank you to the following contributors:

• Athan Reines
• Philipp Burckhardt

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.0.8">