Novelty Promotes Magicians

    @stdlib/math-base-special-cround
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    Round

    NPM version Build Status Coverage Status

    Round a complex number to the nearest integer.

    Installation

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

    Usage

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

    cround( [out,] re, im )

    Rounds a complex number comprised of a real component re and an imaginary component im to the nearest integer.

    var v = cround( -4.2, 5.5 );
    // returns [ -4.0, 6.0 ]
    
    v = cround( 9.99999, 0.1 );
    // returns [ 10.0, 0.0 ]
    
    v = cround( 0.0, 0.0 );
    // returns [ 0.0, 0.0 ]
    
    v = cround( NaN, NaN );
    // returns [ NaN, NaN ]

    By default, the function returns real and imaginary components as a two-element array. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.

    var Float64Array = require( '@stdlib/array-float64' );
    
    var out = new Float64Array( 2 );
    
    var v = cround( out, -4.2, 5.5 );
    // returns <Float64Array>[ -4.0, 6.0 ]
    
    var bool = ( v === out );
    // returns true

    Examples

    var Complex128 = require( '@stdlib/complex-float64' );
    var randu = require( '@stdlib/random-base-randu' );
    var real = require( '@stdlib/complex-real' );
    var imag = require( '@stdlib/complex-imag' );
    var cround = require( '@stdlib/math-base-special-cround' );
    
    var re;
    var im;
    var z;
    var o;
    var w;
    var i;
    
    for ( i = 0; i < 100; i++ ) {
        re = ( randu()*100.0 ) - 50.0;
        im = ( randu()*100.0 ) - 50.0;
        z = new Complex128( re, im );
        o = cround( real(z), imag(z) );
        w = new Complex128( o[ 0 ], o[ 1 ] );
        console.log( 'round(%s) = %s', z.toString(), w.toString() );
    }

    See Also


    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

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

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    49

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    41.6 kB

    Total Files

    10

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser