# @stdlib/assert-is-composite

0.2.1 • Public • Published

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!

# 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```

## 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.

## Package Sidebar

### Install

`npm i @stdlib/assert-is-composite`

### Repository

github.com/stdlib-js/assert-is-composite

stdlib.io

4

0.2.1

Apache-2.0

37.4 kB

13