Package Exports

@stdlib/math-base-special-cfloor

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/math-base-special-cfloor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Floor

$NPM version$ $Build Status$ $Coverage Status$ $dependencies$

Round a complex number toward negative infinity.

Installation

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

Usage

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

cfloor( [out,] re, im )

Rounds a complex number comprised of a real component re and an imaginary component im toward negative infinity.

var v = cfloor( -4.2, 5.5 );
// returns [ -5.0, 5.0 ]

v = cfloor( 9.99999, 0.1 );
// returns [ 9.0, 0.0 ]

v = cfloor( 0.0, 0.0 );
// returns [ 0.0, 0.0 ]

v = cfloor( 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 Float32Array = require( '@stdlib/array-float32' );

var out = new Float32Array( 2 );

var v = cfloor( out, -4.2, 5.5 );
// returns <Float32Array>[ -5.0, 5.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 cfloor = require( '@stdlib/math-base-special-cfloor' );

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 = cfloor( real(z), imag(z) );
    w = new Complex128( o[ 0 ], o[ 1 ] );
    console.log( 'floor(%s) = %s', z.toString(), w.toString() );
}

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.

@stdlib/math-base-special-cfloor