npmpackage.info

Gathering detailed insights and metrics for @stdlib/assert-is-unity-probability-array

@stdlib/assert-is-unity-probability-array - 0.2.2 | npmpackage.info

@stdlib/assert-is-unity-probability-array

Test if a value is an array of probabilities that sum to one.

0.2.2

Apache-2.0

JavaScript

29.88 kB

4.3

Installations

npm install @stdlib/assert-is-unity-probability-array

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=0.10.0

Node Version

16.20.2

NPM Version

8.19.4 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

stdlib-js

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Apache-2.0 License

2 Stars

64 Commits

3 Watchers

5 Branches

14 Contributors

Updated on Jun 30, 2025

Sponsor this package

https://opencollective.com/stdlib

Maintainers

View All 14 Contributors

Package Meta Information

Latest Version

0.2.2

Package Id

@stdlib/assert-is-unity-probability-array@0.2.2

Unpacked Size

29.88 kB

Size

8.44 kB

File Count

NPM Version

8.19.4

Node Version

16.20.2

Published on

Jul 28, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@stdlib/assert-is-array @stdlib/assert-is-number @stdlib/assert-is-typed-array @stdlib/constants-float64-sqrt-eps @stdlib/math-base-utils-absolute-difference

About stdlib...

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!

isUnityProbabilityArray

Test if a value is an array of probabilities that sum to one.

Installation

1npm install @stdlib/assert-is-unity-probability-array

Usage

1var isUnityProbabilityArray = require( '@stdlib/assert-is-unity-probability-array' );

isUnityProbabilityArray( value )

Tests if a value is an array of probabilities that sum to one.

1var Uint8Array = require( '@stdlib/array-uint8' );
2
3var bool = isUnityProbabilityArray( [ 0.25, 0.5, 0.25 ] );
4// returns true
5
6bool = isUnityProbabilityArray( new Uint8Array( [ 0, 1 ] ) );
7// returns true
8
9bool = isUnityProbabilityArray( [ 3.14, 0.0 ] );
10// returns false

Notes

Summation of finite-precision floating-point numbers often has numerical error. For example,
```
1var arr = [ 0.1, 0.2, 0.1, 0.1, 0.2, 0.2, 0.1 ]; // => 1.0
2var sum = 0.0;
3var i;
4for ( i = 0; i < arr.length; i++ ) {
5    sum += arr[ i ];
6}
7console.log( sum );
8// => 0.9999999999999999
```
To account for numerical error, the function tests if array elements sum to approximately one; specifically,
```
11.0 - sqrt(eps) <= sum(A) <= 1.0 + sqrt(eps)
```
where eps is double-precision floating-point epsilon (~2.22e-16) and sqrt(eps) ~ 1.49e-8. The above comparison ensures equality for approximately half the significand bits.

Examples

1var Uint8Array = require( '@stdlib/array-uint8' );
2var isUnityProbabilityArray = require( '@stdlib/assert-is-unity-probability-array' );
3
4var arr = [ 0.0, 1.0 ];
5var bool = isUnityProbabilityArray( arr );
6// returns true
7
8arr = [ 0.5, 0.25, 0.25 ];
9bool = isUnityProbabilityArray( arr );
10// returns true
11
12arr = new Uint8Array( [ 0, 0, 1, 0 ] );
13bool = isUnityProbabilityArray( arr );
14// returns true
15
16arr = [ 0.4, 0.4, 0.4 ];
17bool = isUnityProbabilityArray( arr );
18// returns false
19
20arr = [ 3.14, -1.0 ];
21bool = isUnityProbabilityArray( arr );
22// returns false
23
24bool = isUnityProbabilityArray( [] );
25// returns false
26
27bool = isUnityProbabilityArray( null );
28// 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.

Community

License

See LICENSE.

Copyright

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

9

Security-Policy

Determines if the project has published a security policy.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:275: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/assert-is-unity-probability-array/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:449: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/assert-is-unity-probability-array/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:457: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/assert-is-unity-probability-array/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:623: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/assert-is-unity-probability-array/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/assert-is-unity-probability-array/productionize.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:165
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:83
Warn: npmCommand not pinned by hash: .github/workflows/test_bundles.yml:72
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:74
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_published_package.yml:93
Info: 33 out of 33 GitHub-owned GitHubAction dependencies pinned
Info: 19 out of 24 third-party GitHubAction dependencies pinned
Info: 0 out of 32 npmCommand dependencies pinned

1

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

Score

4.3

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@stdlib/assert-is-unity-probability-array

Installations

Developer Guide

Yes

CommonJS

>=0.10.0

16.20.2

8.19.4

Pull Requests

0

0

0

Issues

0

0

0

Releases

Unable to fetch releases

Languages

Developer

Download Statistics

GitHub Statistics

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

isUnityProbabilityArray

Installation

Usage

isUnityProbabilityArray( value )

Notes

Examples

See Also

Notice

Community

License

Copyright

10

10

10

10

9

3

1

0

0

0

0

0

0

4.3

/10