Skip to content

Latest commit

 

History

History
303 lines (193 loc) · 9.98 KB

README.md

File metadata and controls

303 lines (193 loc) · 9.98 KB
Raw
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!

cfloorn

NPM version Build Status Coverage Status

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

Usage

To use in Observable,

cfloorn = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-cfloorn@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var cfloorn = require( 'path/to/vendor/umd/math-base-special-cfloorn/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-cfloorn@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.cfloorn;
})();
</script>

cfloorn( z, n )

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

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

// Round components to 2 decimal places:
var v = cfloorn( new Complex128( -3.141592653589793, 3.141592653589793 ), -2 );
// returns <Complex128>

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

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

// If n = 0, `cfloorn` behaves like `cfloor`:
v = cfloorn( new Complex128( -3.141592653589793, 3.141592653589793 ), 0 );
// returns <Complex128>

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

im = imag( v );
// returns 3.0

// Round components to the nearest thousand:
v = cfloorn( new Complex128( -12368.0, 12368.0 ), 3 );
// returns <Complex128>

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

im = imag( v );
// returns 12000.0

v = cfloorn( new Complex128( NaN, NaN ), 0 );
// 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,

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

var x = -0.2 - 0.1;
// returns -0.30000000000000004

// Should round components to 0.3:
var v = cfloorn( 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="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-ctor@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-base-randu@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-floor@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-cfloorn@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@umd/browser.js"></script>
<script type="text/javascript">
(function () {

var z;
var w;
var n;
var i;

for ( i = 0; i < 100; i++ ) {
    z = new Complex128( uniform( -50.0, 50.0 ), uniform( -50.0, 50.0 ) );

    n = randint( -5.0, 0.0 );
    w = cfloorn( z, n );

    console.log( 'floorn(%s,%s) = %s', z.toString(), n.toString(), w.toString() );
}

})();
</script>
</body>
</html>

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-2024. The Stdlib Authors.