croundf

Round each component of a single-precision complex floating-point number to the nearest integer.

Installation

npm install @stdlib/math-base-special-croundf

Usage

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.

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 <Complex64>

var re = real( v );
// returns -4.0

var im = imag( v );
// returns 6.0

v = croundf( new Complex64( 9.99999, 0.1 ) );
// returns <Complex64>

re = real( v );
// returns 10.0

im = imag( v );
// returns 0.0

v = croundf( new Complex64( 0.0, 0.0 ) );
// returns <Complex64>

re = real( v );
// returns 0.0

im = imag( v );
// returns 0.0

v = croundf( new Complex64( NaN, NaN ) );
// returns <Complex64>

re = real( v );
// returns NaN

im = imag( v );
// returns NaN

Examples

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 APIs

Usage

#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.

#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.

stdlib_complex64_t stdlib_base_croundf( const stdlib_complex64_t z );

Examples

#include "stdlib/math/base/special/croundf.h"
#include "stdlib/complex/float32/ctor.h"
#include "stdlib/complex/float32/reim.h"
#include <stdio.h>

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 );
    }
}

Notice

This package is part of 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, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.