Skip to content

Latest commit

 

History

History
271 lines (169 loc) · 9.07 KB

README.md

File metadata and controls

271 lines (169 loc) · 9.07 KB
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!

croundn

NPM version Build Status Coverage Status

Round each component of a double-precision complex floating-point number to the nearest multiple of 10^n.

Usage

import croundn from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-croundn@esm/index.mjs';

croundn( z, n )

Rounds each component of a double-precision complex floating-point number to the nearest multiple of 10^n.

import Complex128 from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-ctor@esm/index.mjs';
import real from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-real@esm/index.mjs';
import imag from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-imag@esm/index.mjs';

var v = croundn( new Complex128( -3.141592653589793, 3.141592653589793 ), -2 );
// returns <Complex128>

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

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

v = croundn( new Complex128( -3.141592653589793, 3.141592653589793 ), 0 );
// returns <Complex128>

re = real( v );
// returns -3.0

im = imag( v );
// returns 3.0

v = croundn( new Complex128( -12368.0, 12368.0 ), 3 );
// returns <Complex128>

re = real( v );
// returns -12000.0

im = imag( v );
// returns 12000.0

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

re = real( v );
// returns NaN

im = imag( v );
// returns NaN

Notes

  • When operating on floating-point numbers in bases other than 2, rounding to specified digits can be inexact. For example,

    import Complex128 from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-ctor@esm/index.mjs';
    import real from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-real@esm/index.mjs';
    import imag from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-imag@esm/index.mjs';
    
    var x = 0.2 + 0.1;
    // returns 0.30000000000000004
    
    // Should round components to 0.3:
    var v = croundn( new Complex128( x, x ), -16 );
    // returns <Complex128>
    
    var re = real( v );
    // returns 0.3000000000000001
    
    var im = imag( v );
    // returns 0.3000000000000001

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="module">

var uniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform' ).factory;
import Complex128 from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-ctor@esm/index.mjs';
import floor from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-floor@esm/index.mjs';
import croundn from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-croundn@esm/index.mjs';

var rand1 = uniform( -5.0, 0.0 );
var rand2 = uniform( -50.0, 50.0 );

var z;
var i;
var n;
for ( i = 0; i < 100; i++ ) {
    z = new Complex128( rand2(), rand2() );
    n = floor( rand1() );
    console.log( 'croundn(%s, %s) = %s', z, n, croundn( z, n ) );
}

</script>
</body>
</html>

See Also


Notice

This package is part of stdlib, a standard library 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-2024. The Stdlib Authors.