cround

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

Installation

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

Usage

var cround = require( '@stdlib/math-base-special-cround' );

cround( z )

Rounds each component of a double-precision complex floating-point number to the nearest integer.

var Complex128 = require( '@stdlib/complex-float64-ctor' );
var real = require( '@stdlib/complex-float64-real' );
var imag = require( '@stdlib/complex-float64-imag' );

var v = cround( new Complex128( -4.2, 5.5 ) );
// returns <Complex128>

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

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

v = cround( new Complex128( 9.99999, 0.1 ) );
// returns <Complex128>

re = real( v );
// returns 10.0

im = imag( v );
// returns 0.0

v = cround( new Complex128( 0.0, 0.0 ) );
// returns <Complex128>

re = real( v );
// returns 0.0

im = imag( v );
// returns 0.0

v = cround( new Complex128( NaN, NaN ) );
// returns <Complex128>

re = real( v );
// returns NaN

im = imag( v );
// returns NaN

Examples

var uniform = require( '@stdlib/random-base-uniform' ).factory;
var Complex128 = require( '@stdlib/complex-float64-ctor' );
var cround = require( '@stdlib/math-base-special-cround' );

var rand = uniform( -50.0, 50.0 );

var z;
var i;
for ( i = 0; i < 100; i++ ) {
    z = new Complex128( rand(), rand() );
    console.log( 'cround(%s) = %s', z, cround( z ) );
}

C APIs

Usage

#include "stdlib/math/base/special/cround.h"

stdlib_base_cround( z )

Rounds each component of a double-precision complex floating-point number to the nearest integer.

#include "stdlib/complex/float64/ctor.h"
#include "stdlib/complex/float64/real.h"
#include "stdlib/complex/float64/imag.h"

stdlib_complex128_t z = stdlib_complex128( -4.2, 5.5 );

stdlib_complex128_t out = stdlib_base_cround( z );

double re = stdlib_complex128_real( out );
// returns -4.0

double im = stdlib_complex128_imag( out );
// returns 6.0

The function accepts the following arguments:

• z: [in] stdlib_complex128_t input value.

stdlib_complex128_t stdlib_base_cround( const stdlib_complex128_t z );

Examples

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

int main( void ) {
    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_cround( v );
        stdlib_complex128_reim( v, &re1, &im1 );
        stdlib_complex128_reim( y, &re2, &im2 );
        printf( "cround(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 );
    }
}

See Also

• @stdlib/math-base/special/cceil: round a double-precision complex floating-point number toward positive infinity.
• @stdlib/math-base/special/cfloor: round a double-precision complex floating-point number toward negative infinity.
• @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, 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-2024. The Stdlib Authors.