269 lines
6.3 KiB
Markdown
269 lines
6.3 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2018 The Stdlib Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
-->
|
|
|
|
# Floor
|
|
|
|
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
|
|
|
|
> Round a double-precision floating-point number toward negative infinity.
|
|
|
|
<section class="installation">
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @stdlib/math-base-special-floor
|
|
```
|
|
|
|
</section>
|
|
|
|
<section class="usage">
|
|
|
|
## 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
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```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 ) );
|
|
}
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
<!-- C interface documentation. -->
|
|
|
|
* * *
|
|
|
|
<section class="c">
|
|
|
|
## C APIs
|
|
|
|
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
|
|
|
|
<section class="intro">
|
|
|
|
</section>
|
|
|
|
<!-- /.intro -->
|
|
|
|
<!-- C usage documentation. -->
|
|
|
|
<section class="usage">
|
|
|
|
### 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 );
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="notes">
|
|
|
|
</section>
|
|
|
|
<!-- /.notes -->
|
|
|
|
<!-- C API usage examples. -->
|
|
|
|
<section class="examples">
|
|
|
|
### Examples
|
|
|
|
```c
|
|
#include "stdlib/math/base/special/floor.h"
|
|
#include <stdio.h>
|
|
|
|
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 );
|
|
}
|
|
}
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
</section>
|
|
|
|
<!-- /.c -->
|
|
|
|
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
|
|
|
|
<section class="related">
|
|
|
|
* * *
|
|
|
|
## See Also
|
|
|
|
- <span class="package-name">[`@stdlib/math/base/special/ceil`][@stdlib/math/base/special/ceil]</span><span class="delimiter">: </span><span class="description">round a double-precision floating-point number toward positive infinity.</span>
|
|
- <span class="package-name">[`@stdlib/math/base/special/round`][@stdlib/math/base/special/round]</span><span class="delimiter">: </span><span class="description">round a numeric value to the nearest integer.</span>
|
|
|
|
</section>
|
|
|
|
<!-- /.related -->
|
|
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
|
|
<section class="main-repo" >
|
|
|
|
* * *
|
|
|
|
## 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].
|
|
|
|
</section>
|
|
|
|
<!-- /.stdlib -->
|
|
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="links">
|
|
|
|
[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
|
|
|
|
<!--
|
|
|
|
[dependencies-image]: https://img.shields.io/david/stdlib-js/math-base-special-floor.svg
|
|
[dependencies-url]: https://david-dm.org/stdlib-js/math-base-special-floor/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
|
|
|
|
<!-- <related-links> -->
|
|
|
|
[@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
|
|
|
|
<!-- </related-links> -->
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|