time-to-botec/js/node_modules/@stdlib/math/base/assert/is-odd/README.md

isOdd

Test if a finite numeric value is an odd number.

Usage

var isOdd = require( '@stdlib/math/base/assert/is-odd' );

isOdd( x )

Tests if a finite numeric value is an odd number.

var bool = isOdd( 5.0 );
// returns true

bool = isOdd( -2.0 );
// returns false

bool = isOdd( 0.0 );
// returns false

bool = isOdd( 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:

  function check( x ) {
      return (
          x < Infinity &&
          x > -Infinity &&
          isOdd( x )
      );
  }
  
  var bool = check( Infinity );
  // returns false
  
  bool = check( -Infinity );
  // returns false
  

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var isOdd = require( '@stdlib/math/base/assert/is-odd' );

var bool;
var x;
var i;

for ( i = 0; i < 100; i++ ) {
    x = round( randu()*100.0 );
    bool = isOdd( x );
    console.log( '%d is %s', x, ( bool ) ? 'odd' : 'not odd' );
}