time-to-botec/squiggle/node_modules/@stdlib/assert/is-unity-probability-array/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

30 lines
593 B
Plaintext

{{alias}}( value )
Tests if a value is an array of probabilities that sum to one.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is an array of probabilities that sum
to one.
Examples
--------
> var bool = {{alias}}( [ 0.25, 0.5, 0.25 ] )
true
> bool = {{alias}}( new {{alias:@stdlib/array/uint8}}( [ 0, 1 ] ) )
true
> bool = {{alias}}( [ 0.4, 0.4, 0.4 ] )
false
> bool = {{alias}}( [ 3.14, 0.0 ] )
false
See Also
--------