Round each component of a single-precision complex floating-point number to the nearest integer.
npm install @stdlib/math-base-special-croundfWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Round each component of a single-precision complex floating-point number to the nearest integer.
``bash`
npm install @stdlib/math-base-special-croundf
`javascript`
var croundf = require( '@stdlib/math-base-special-croundf' );
#### croundf( z )
Rounds each component of a single-precision complex floating-point number to the nearest integer.
`javascript
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var real = require( '@stdlib/complex-float32-real' );
var imag = require( '@stdlib/complex-float32-imag' );
var v = croundf( new Complex64( -4.2, 5.5 ) );
// returns
var re = real( v );
// returns -4.0
var im = imag( v );
// returns 6.0
v = croundf( new Complex64( 9.99999, 0.1 ) );
// returns
re = real( v );
// returns 10.0
im = imag( v );
// returns 0.0
v = croundf( new Complex64( 0.0, 0.0 ) );
// returns
re = real( v );
// returns 0.0
im = imag( v );
// returns 0.0
v = croundf( new Complex64( NaN, NaN ) );
// returns
re = real( v );
// returns NaN
im = imag( v );
// returns NaN
`
`javascript
var uniform = require( '@stdlib/random-base-uniform' ).factory;
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var croundf = require( '@stdlib/math-base-special-croundf' );
var rand = uniform( -50.0, 50.0 );
var z;
var i;
for ( i = 0; i < 100; i++ ) {
z = new Complex64( rand(), rand() );
console.log( 'croundf(%s) = %s', z, croundf( z ) );
}
`
*
`c`
#include "stdlib/math/base/special/croundf.h"
#### stdlib_base_croundf( z )
Rounds each component of a single-precision complex floating-point number to the nearest integer.
`c
#include "stdlib/complex/float32/ctor.h"
#include "stdlib/complex/float32/real.h"
#include "stdlib/complex/float32/imag.h"
stdlib_complex64_t z = stdlib_complex64( -4.2f, 5.5f );
stdlib_complex64_t out = stdlib_base_croundf( z );
float re = stdlib_complex64_real( out );
// returns -4.0f
float im = stdlib_complex64_imag( out );
// returns 6.0f
`
The function accepts the following arguments:
- z: [in] stdlib_complex64_t input value.
`c`
stdlib_complex64_t stdlib_base_croundf( const stdlib_complex64_t z );
`c
#include "stdlib/math/base/special/croundf.h"
#include "stdlib/complex/float32/ctor.h"
#include "stdlib/complex/float32/reim.h"
#include
int main( void ) {
const stdlib_complex64_t x[] = {
stdlib_complex64( 3.14f, 1.5f ),
stdlib_complex64( -3.14f, -1.5f ),
stdlib_complex64( 0.0f, 0.0f ),
stdlib_complex64( 0.0f / 0.0f, 0.0f / 0.0f )
};
stdlib_complex64_t v;
stdlib_complex64_t y;
float re1;
float im1;
float re2;
float im2;
int i;
for ( i = 0; i < 4; i++ ) {
v = x[ i ];
y = stdlib_base_croundf( v );
stdlib_complex64_reim( v, &re1, &im1 );
stdlib_complex64_reim( y, &re2, &im2 );
printf( "croundf(%f + %fi) = %f + %fi\n", re1, im1, re2, im2 );
}
}
`
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-croundf.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-croundf
[test-image]: https://github.com/stdlib-js/math-base-special-croundf/actions/workflows/test.yml/badge.svg?branch=v0.1.1
[test-url]: https://github.com/stdlib-js/math-base-special-croundf/actions/workflows/test.yml?query=branch:v0.1.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-croundf/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-croundf?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[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-croundf/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-croundf/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-croundf/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-croundf/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-croundf/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-croundf/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-croundf/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-croundf/main/LICENSE