# Floor
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Round a double-precision floating-point number toward negative infinity.
## Installation
```bash
npm install @stdlib/math-base-special-floor
```
## Usage
```javascript
var floor = require( '@stdlib/math-base-special-floor' );
```
#### floor( x )
Rounds a double-precision floating-point number toward negative infinity.
```javascript
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
```javascript
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
```c
#include "stdlib/math/base/special/floor.h"
```
#### stdlib_base_floor( x )
Rounds a double-precision floating-point number toward negative infinity.
```c
double y = stdlib_base_floor( 3.14 );
// returns 3.0
```
The function accepts the following arguments:
- **x**: `[in] double` input value.
```c
double stdlib_base_floor( const double x );
```
### Examples
```c
#include "stdlib/math/base/special/floor.h"
#include
int main() {
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 );
}
}
```
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-floor.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-floor
[test-image]: https://github.com/stdlib-js/math-base-special-floor/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/math-base-special-floor/actions/workflows/test.yml
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-floor/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-floor?branch=main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/math-base-special-floor/tree/deno
[umd-url]: https://github.com/stdlib-js/math-base-special-floor/tree/umd
[esm-url]: https://github.com/stdlib-js/math-base-special-floor/tree/esm
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-floor/main/LICENSE
[@stdlib/math/base/special/ceil]: https://www.npmjs.com/package/@stdlib/math-base-special-ceil
[@stdlib/math/base/special/round]: https://www.npmjs.com/package/@stdlib/math-base-special-round