time-to-botec/squiggle/node_modules/@stdlib/assert/is-positive-zero/README.md

isPositiveZero

Test if a value is a number equal to positive zero.

Usage

var isPositiveZero = require( '@stdlib/assert/is-positive-zero' );

isPositiveZero( value )

Tests if a value is a number having a value equal to positive zero.

var Number = require( '@stdlib/number/ctor' );

var bool = isPositiveZero( 0.0 );
// returns true

bool = isPositiveZero( new Number( 0.0 ) );
// returns true

bool = isPositiveZero( -3.14 );
// returns false

bool = isPositiveZero( -0.0 );
// returns false

bool = isPositiveZero( null );
// returns false

isPositiveZero.isPrimitive( value )

Tests if a value is a primitive number equal to positive zero.

var Number = require( '@stdlib/number/ctor' );

var bool = isPositiveZero.isPrimitive( 0.0 );
// returns true

bool = isPositiveZero.isPrimitive( new Number( 0.0 ) );
// returns false

isPositiveZero.isObject( value )

Tests if a value is a Number object having a value equal to positive zero.

var Number = require( '@stdlib/number/ctor' );

var bool = isPositiveZero.isObject( 0.0 );
// returns false

bool = isPositiveZero.isObject( new Number( 0.0 ) );
// returns true

Examples

var Number = require( '@stdlib/number/ctor' );
var isPositiveZero = require( '@stdlib/assert/is-positive-zero' );

var bool = isPositiveZero( 0.0 );
// returns true

bool = isPositiveZero( new Number( 0.0 ) );
// returns true

bool = isPositiveZero( -3.14 );
// returns false

bool = isPositiveZero( -0.0 );
// returns false

bool = isPositiveZero( 5.0 );
// returns false

bool = isPositiveZero( '0' );
// returns false

bool = isPositiveZero( null );
// returns false