time-to-botec/js/node_modules/@stdlib/assert/is-composite/README.md

isComposite

Test if a value is a composite number.

A composite number is defined as a positive integer value greater than 1 which has at least one divisor other than 1 and itself (i.e., an integer value which can be formed by multiplying two smaller positive integers).

Usage

var isComposite = require( '@stdlib/assert/is-composite' );

isComposite( value )

Tests if a value is a composite number.

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

var bool = isComposite( 4.0 );
// returns true

bool = isComposite( new Number( 4.0 ) );
// returns true

bool = isComposite( 3.14 );
// returns false

bool = isComposite( -4.0 );
// returns false

bool = isComposite( NaN );
// returns false

bool = isComposite( null );
// returns false

isComposite.isPrimitive( value )

Tests if a value is a primitive composite number.

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

var bool = isComposite.isPrimitive( 4.0 );
// returns true

bool = isComposite.isPrimitive( new Number( 4.0 ) );
// returns false

isComposite.isObject( value )

Tests if a value is a Number object having a value which is a composite number.

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

var bool = isComposite.isObject( 4.0 );
// returns false

bool = isComposite.isObject( new Number( 4.0 ) );
// returns true

Examples

var Number = require( '@stdlib/number/ctor' );
var isComposite = require( '@stdlib/assert/is-composite' );

var bool = isComposite( 4.0 );
// returns true

bool = isComposite( new Number( 4.0 ) );
// returns true

bool = isComposite( 10.0 );
// returns true

bool = isComposite( 7.0 );
// returns false

bool = isComposite( 3.14 );
// returns false

bool = isComposite( -4.0 );
// returns false

bool = isComposite( NaN );
// returns false

bool = isComposite( '0.5' );
// returns false

bool = isComposite( null );
// returns false