https://github.com/stdlib-js/math-base-special-cceiln
Round a complex number to the nearest multiple of 10^n toward positive infinity.
https://github.com/stdlib-js/math-base-special-cceiln
cceil ceil cmplx complex fix integer javascript math mathematics nearest node node-js nodejs number round stdlib tofixed value
Last synced: 9 months ago
JSON representation
Round a complex number to the nearest multiple of 10^n toward positive infinity.
- Host: GitHub
- URL: https://github.com/stdlib-js/math-base-special-cceiln
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T17:19:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T06:17:55.000Z (9 months ago)
- Last Synced: 2025-04-13T17:17:38.156Z (9 months ago)
- Topics: cceil, ceil, cmplx, complex, fix, integer, javascript, math, mathematics, nearest, node, node-js, nodejs, number, round, stdlib, tofixed, value
- Language: Python
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.31 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# cceiln
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Round each component of a double-precision complex floating-point number to the nearest multiple of `10^n` toward positive infinity.
## Installation
```bash
npm install @stdlib/math-base-special-cceiln
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var cceiln = require( '@stdlib/math-base-special-cceiln' );
```
#### cceiln( z, n )
Rounds each component of a double-precision complex floating-point number to the nearest multiple of `10^n` toward positive infinity.
```javascript
var Complex128 = require( '@stdlib/complex-float64-ctor' );
var real = require( '@stdlib/complex-float64-real' );
var imag = require( '@stdlib/complex-float64-imag' );
// Round components to 2 decimal places:
var z = new Complex128( -3.141592653589793, 3.141592653589793 );
var v = cceiln( z, -2 );
// returns
var re = real( v );
// returns -3.14
var im = imag( v );
// returns 3.15
// If n = 0, `cceiln` behaves like `cceil`:
z = new Complex128( 9.99999, 0.1 );
v = cceiln( z, 0 );
// returns
re = real( v );
// returns 10.0
im = imag( v );
// returns 1.0
// Round components to the nearest thousand:
z = new Complex128( 12368.0, -12368.0 );
v = cceiln( z, 3 );
// returns
re = real( v );
// returns 13000.0
im = imag( v );
// returns -12000.0
v = cceiln( new Complex128( NaN, NaN ), 2 );
// returns
re = real( v );
// returns NaN
im = imag( v );
// returns NaN
```
## Notes
- When operating on [floating-point numbers][ieee754] in bases other than `2`, rounding to specified digits can be **inexact**. For example,
```javascript
var Complex128 = require( '@stdlib/complex-float64-ctor' );
var real = require( '@stdlib/complex-float64-real' );
var imag = require( '@stdlib/complex-float64-imag' );
var x = 0.2 + 0.1;
// returns 0.30000000000000004
// Should round components to 0.3:
var v = cceiln( new Complex128( x, x ), -16 );
// returns
var re = real( v );
// returns 0.3000000000000001
var im = imag( v );
// returns 0.3000000000000001
```
## Examples
```javascript
var uniform = require( '@stdlib/random-base-uniform' ).factory;
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var Complex128 = require( '@stdlib/complex-float64-ctor' );
var ceil = require( '@stdlib/math-base-special-ceil' );
var cceiln = require( '@stdlib/math-base-special-cceiln' );
var rand1 = uniform( -50.0, 50.0 );
var rand2 = discreteUniform( -5.0, 0.0 );
var z;
var i;
var n;
for ( i = 0; i < 100; i++ ) {
n = rand2();
z = new Complex128( rand1(), rand1() );
console.log( 'cceiln(%s, %s) = %s', z, n, cceiln( z, n ) );
}
```
* * *
## C APIs
### Usage
```c
#include "stdlib/math/base/special/cceiln.h"
```
#### stdlib_base_cceiln( z, n )
Rounds each component of a double-precision complex floating-point number to the nearest multiple of `10^n` toward positive infinity.
```c
#include "stdlib/complex/float64/ctor.h"
#include "stdlib/complex/float64/real.h"
#include "stdlib/complex/float64/imag.h"
stdlib_complex128_t z = stdlib_complex128( -3.141592653589793, 3.141592653589793 );
stdlib_complex128_t out = stdlib_base_cceiln( z, -2 );
double re = stdlib_complex128_real( out );
// returns -3.14
double im = stdlib_complex128_imag( out );
// returns 3.15
```
The function accepts the following arguments:
- **z**: `[in] stdlib_complex128_t` input value.
- **n**: `[in] int32_t` integer power of 10.
```c
stdlib_complex128_t stdlib_base_cceiln( const stdlib_complex128_t z, int32_t n );
```
### Examples
```c
#include "stdlib/math/base/special/cceiln.h"
#include "stdlib/complex/float64/ctor.h"
#include "stdlib/complex/float64/reim.h"
#include
int main() {
const stdlib_complex128_t x[] = {
stdlib_complex128( 3.14, 1.5 ),
stdlib_complex128( -3.14, -1.5 ),
stdlib_complex128( 0.0, 0.0 ),
stdlib_complex128( 0.0/0.0, 0.0/0.0 )
};
stdlib_complex128_t v;
stdlib_complex128_t y;
double re1;
double im1;
double re2;
double im2;
int i;
for ( i = 0; i < 4; i++ ) {
v = x[ i ];
y = stdlib_base_cceiln( v, -2 );
stdlib_complex128_reim( v, &re1, &im1 );
stdlib_complex128_reim( y, &re2, &im2 );
printf( "cceiln(%lf + %lfi, -2) = %lf + %lfi\n", re1, im1, re2, im2 );
}
}
```
* * *
## See Also
- [`@stdlib/math-base/special/cceil`][@stdlib/math/base/special/cceil]: round each component of a double-precision complex floating-point number toward positive infinity.
- [`@stdlib/math-base/special/cfloorn`][@stdlib/math/base/special/cfloorn]: round each component of a double-precision complex floating-point number to the nearest multiple of 10^n toward negative infinity.
- [`@stdlib/math-base/special/croundn`][@stdlib/math/base/special/croundn]: round each component of a double-precision complex floating-point number to the nearest multiple of 10^n.
* * *
## 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-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-cceiln.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-cceiln
[test-image]: https://github.com/stdlib-js/math-base-special-cceiln/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/math-base-special-cceiln/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-cceiln/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-cceiln?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[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-cceiln/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-cceiln/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-cceiln/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-cceiln/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-cceiln/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-cceiln/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-cceiln/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-cceiln/main/LICENSE
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
[@stdlib/math/base/special/cceil]: https://github.com/stdlib-js/math-base-special-cceil
[@stdlib/math/base/special/cfloorn]: https://github.com/stdlib-js/math-base-special-cfloorn
[@stdlib/math/base/special/croundn]: https://github.com/stdlib-js/math-base-special-croundn