168 lines
2.8 KiB
Markdown
168 lines
2.8 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.
|
||
|
|
||
|
-->
|
||
|
|
||
|
# Ceil
|
||
|
|
||
|
> Round a double-precision floating-point number toward positive infinity.
|
||
|
|
||
|
<section class="usage">
|
||
|
|
||
|
## Usage
|
||
|
|
||
|
```javascript
|
||
|
var ceil = require( '@stdlib/math/base/special/ceil' );
|
||
|
```
|
||
|
|
||
|
#### ceil( x )
|
||
|
|
||
|
Rounds a double-precision floating-point number toward positive infinity.
|
||
|
|
||
|
```javascript
|
||
|
var v = ceil( -4.2 );
|
||
|
// returns -4.0
|
||
|
|
||
|
v = ceil( 9.99999 );
|
||
|
// returns 10.0
|
||
|
|
||
|
v = ceil( 0.0 );
|
||
|
// returns 0.0
|
||
|
|
||
|
v = ceil( NaN );
|
||
|
// returns NaN
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.usage -->
|
||
|
|
||
|
<section class="examples">
|
||
|
|
||
|
## Examples
|
||
|
|
||
|
<!-- eslint no-undef: "error" -->
|
||
|
|
||
|
```javascript
|
||
|
var randu = require( '@stdlib/random/base/randu' );
|
||
|
var ceil = require( '@stdlib/math/base/special/ceil' );
|
||
|
|
||
|
var x;
|
||
|
var i;
|
||
|
|
||
|
for ( i = 0; i < 100; i++ ) {
|
||
|
x = (randu()*100.0) - 50.0;
|
||
|
console.log( 'ceil(%d) = %d', x, ceil( 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/ceil.h"
|
||
|
```
|
||
|
|
||
|
#### stdlib_base_ceil( x )
|
||
|
|
||
|
Rounds a double-precision floating-point number toward positive infinity.
|
||
|
|
||
|
```c
|
||
|
double y = stdlib_base_ceil( 3.14 );
|
||
|
// returns 4.0
|
||
|
```
|
||
|
|
||
|
The function accepts the following arguments:
|
||
|
|
||
|
- **x**: `[in] double` input value.
|
||
|
|
||
|
```c
|
||
|
double stdlib_base_ceil( 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/ceil.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_ceil( x[ i ] );
|
||
|
printf( "ceil(%lf) = %lf\n", x[ i ], y );
|
||
|
}
|
||
|
}
|
||
|
```
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.examples -->
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.c -->
|
||
|
|
||
|
<section class="links">
|
||
|
|
||
|
</section>
|
||
|
|
||
|
<!-- /.links -->
|