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-assert-is-evenf

Test if a finite single-precision floating-point number is an even number.
https://github.com/stdlib-js/math-base-assert-is-evenf

assert assertion even float flt is javascript math mathematics node node-js nodejs number numeric single stdlib util utilities utility utils

Last synced: 1 day ago
JSON representation

Test if a finite single-precision floating-point number is an even number.

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!



# isEvenf



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



> Test if a finite single-precision floating-point number is an even number.



## Installation



```bash

npm install @stdlib/math-base-assert-is-evenf

```



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 isEvenf = require( '@stdlib/math-base-assert-is-evenf' );

```



#### isEvenf( x )



Tests if a **finite** single-precision floating-point number is an even number.



```javascript

var bool = isEvenf( 5.0 );

// returns false



bool = isEvenf( -2.0 );

// returns true



bool = isEvenf( 0.0 );

// returns true



bool = isEvenf( NaN );

// returns false

```



## Notes



-   The function assumes a **finite** `number`. If provided positive or negative `infinity`, the function will return `true`, when, in fact, the result is undefined. If `x` can be `infinite`, wrap the implementation as follows:



    ```javascript

    function check( x ) {

        return (

            x < Infinity &&

            x > -Infinity &&

            isEvenf( x )

        );

    }



    var bool = check( Infinity );

    // returns false



    bool = check( -Infinity );

    // returns false

    ```



## Examples



```javascript

var randu = require( '@stdlib/random-array-discrete-uniform' );

var isEvenf = require( '@stdlib/math-base-assert-is-evenf' );



var x = randu( 100, 0, 100 );



var i;

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

    console.log( '%d is %s', x[ i ], ( isEvenf( x[ i ] ) ) ? 'even' : 'not even' );

}

```



* * *



## C APIs



### Usage



```c

#include "stdlib/math/base/assert/is_evenf.h"

```



#### stdlib_base_is_evenf( x )



Tests if a finite single-precision floating-point number is an even number.



```c

#include 



bool out = stdlib_base_is_evenf( 1.0f );

// returns false



out = stdlib_base_is_evenf( 4.0f );

// returns true

```



The function accepts the following arguments:



-   **x**: `[in] float` input value.



```c

bool stdlib_base_is_evenf( const float x );

```



### Examples



```c

#include "stdlib/math/base/assert/is_evenf.h"

#include 

#include 

#include 



int main( void ) {

    float x;

    bool v;

    int i;



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

        x = ( ( (float)rand() / (float)RAND_MAX ) * 100.0f );

        v = stdlib_base_is_evenf( x );

        printf( "x = %f, is_evenf(x) = %s\n", x, ( v ) ? "even" : "not even" );

    }

}

```



* * *



## 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-assert-is-evenf.svg

[npm-url]: https://npmjs.org/package/@stdlib/math-base-assert-is-evenf



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

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



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

[coverage-url]: https://codecov.io/github/stdlib-js/math-base-assert-is-evenf?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-assert-is-evenf/tree/deno

[deno-readme]: https://github.com/stdlib-js/math-base-assert-is-evenf/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/math-base-assert-is-evenf/tree/umd

[umd-readme]: https://github.com/stdlib-js/math-base-assert-is-evenf/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/math-base-assert-is-evenf/tree/esm

[esm-readme]: https://github.com/stdlib-js/math-base-assert-is-evenf/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/math-base-assert-is-evenf/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-assert-is-evenf/main/LICENSE