Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/math-base-special-cfloorf

Round a single-precision complex floating-point number toward negative infinity.
https://github.com/stdlib-js/math-base-special-cfloorf

cfloor cmplx complex floor integer javascript math mathematics nearest node node-js nodejs number round stdlib value

Last synced: 1 day ago
JSON representation

Round a single-precision complex floating-point number toward negative infinity.

Awesome Lists containing this project

README 

        



  

    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!



# cfloorf



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Round each component of a single-precision complex floating-point number toward negative infinity.



## Installation



```bash

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

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

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

```



#### cfloorf( z )



Rounds each component of a single-precision complex floating-point number toward negative infinity.



```javascript

var Complex64 = require( '@stdlib/complex-float32-ctor' );

var real = require( '@stdlib/complex-float32-real' );

var imag = require( '@stdlib/complex-float32-imag' );



var v = cfloorf( new Complex64( -4.2, 5.5 ) );

// returns 



var re = real( v );

// returns -5.0



var im = imag( v );

// returns 5.0



v = cfloorf( new Complex64( 9.99999, 0.1 ) );

// returns 



re = real( v );

// returns 9.0



im = imag( v );

// returns 0.0



v = cfloorf( new Complex64( 0.0, 0.0 ) );

// returns 



re = real( v );

// returns 0.0



im = imag( v );

// returns 0.0



v = cfloorf( new Complex64( NaN, NaN ) );

// returns 



re = real( v );

// returns NaN



im = imag( v );

// returns NaN

```



## Examples



```javascript

var Complex64 = require( '@stdlib/complex-float32-ctor' );

var uniform = require( '@stdlib/random-base-uniform' ).factory;

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



var rand = uniform( -50.0, 50.0 );

var z;

var i;

for ( i = 0; i < 100; i++ ) {

    z = new Complex64( rand(), rand() );

    console.log( 'cfloorf(%s) = %s', z, cfloorf( z ) );

}

```



* * *



## C APIs



### Usage



```c

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

```



#### stdlib_base_cfloorf( z )



Rounds each component of a single-precision complex floating-point number toward negative infinity.



```c

#include "stdlib/complex/float32/ctor.h"

#include "stdlib/complex/float32/real.h"

#include "stdlib/complex/float32/imag.h"



stdlib_complex64_t z = stdlib_complex64( 2.5f, -1.5f );



stdlib_complex64_t out = stdlib_base_cfloorf( z );



float re = stdlib_complex64_real( out );

// returns 2.0f



float im = stdlib_complex64_imag( out );

// returns -2.0f

```



The function accepts the following arguments:



-   **z**: `[in] stdlib_complex64_t` input value.



```c

stdlib_complex64_t stdlib_base_cfloorf( const stdlib_complex64_t z );

```



### Examples



```c

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

#include "stdlib/complex/float32/ctor.h"

#include "stdlib/complex/float32/reim.h"

#include 



int main( void ) {

    const stdlib_complex64_t x[] = {

        stdlib_complex64( 3.14f, 1.5f ),

        stdlib_complex64( -3.14f, -1.5f ),

        stdlib_complex64( 0.0f, 0.0f ),

        stdlib_complex64( 0.0f / 0.0f, 0.0f / 0.0f )

    };



    stdlib_complex64_t v;

    stdlib_complex64_t y;

    float re1;

    float im1;

    float re2;

    float im2;

    int i;

    for ( i = 0; i < 4; i++ ) {

        v = x[ i ];

        y = stdlib_base_cfloorf( v );

        stdlib_complex64_reim( v, &re1, &im1 );

        stdlib_complex64_reim( y, &re2, &im2 );

        printf( "cfloorf(%f + %fi) = %f + %fi\n", re1, im1, re2, im2 );

    }

}

```



* * *



## Notice



This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-cfloorf.svg

[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-cfloorf



[test-image]: https://github.com/stdlib-js/math-base-special-cfloorf/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/math-base-special-cfloorf/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-cfloorf/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-cfloorf?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/math-base-special-cfloorf/tree/deno

[deno-readme]: https://github.com/stdlib-js/math-base-special-cfloorf/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/math-base-special-cfloorf/tree/umd

[umd-readme]: https://github.com/stdlib-js/math-base-special-cfloorf/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/math-base-special-cfloorf/tree/esm

[esm-readme]: https://github.com/stdlib-js/math-base-special-cfloorf/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/math-base-special-cfloorf/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-cfloorf/main/LICENSE