# isProbability

> Test if a value is a probability.

<section class="intro">

A **probability** is defined as a numeric value on the interval `[0,1]`.

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var isProbability = require( '@stdlib/assert/is-probability' );
```

#### isProbability( value )

Tests if a `value` is a probability.

<!-- eslint-disable no-new-wrappers -->

```javascript
var bool = isProbability( 0.5 );
// returns true

bool = isProbability( new Number( 0.5 ) );
// returns true

bool = isProbability( 3.14 );
// returns false

bool = isProbability( -5.0 );
// returns false

bool = isProbability( NaN );
// returns false

bool = isProbability( null );
// returns false
```

#### isProbability.isPrimitive( value )

Tests if a `value` is a primitive probability.

<!-- eslint-disable no-new-wrappers -->

```javascript
var bool = isProbability.isPrimitive( 0.33 );
// returns true

bool = isProbability.isPrimitive( new Number( 0.33 ) );
// returns false
```

#### isProbability.isObject( value )

Tests if a `value` is a `Number` object having a value which is a probability.

<!-- eslint-disable no-new-wrappers -->

```javascript
var bool = isProbability.isObject( 0.11 );
// returns false

bool = isProbability.isObject( new Number( 0.11 ) );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- eslint-disable no-new-wrappers -->

<!-- eslint no-undef: "error" -->

```javascript
var isProbability = require( '@stdlib/assert/is-probability' );

var bool = isProbability( 0.5 );
// returns true

bool = isProbability( new Number( 0.5 ) );
// returns true

bool = isProbability( 0.0 );
// returns true

bool = isProbability( 1.0 );
// returns true

bool = isProbability( 3.14 );
// returns false

bool = isProbability( -5.0 );
// returns false

bool = isProbability( NaN );
// returns false

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

bool = isProbability( null );
// returns false
```

</section>

<!-- /.examples -->

<section class="links">

</section>

<!-- /.links -->
