@stdlib/assert-is-composite
v0.2.2
Published
Test if a value is a composite number.
Downloads
65
Readme
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).
Installation
npm install @stdlib/assert-is-composite
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
See Also
@stdlib/assert-is-integer
: test if a value is a number having an integer value.@stdlib/assert-is-number
: test if a value is a number.@stdlib/assert-is-prime
: test if a value is a prime number.
Notice
This package is part of 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, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.