Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ limitations under the License.

The [mode][mode] for a [beta prime][betaprime-distribution] random variable is

<!-- <equation class="equation" label="eq:betaprime_expectation" align="center" raw="\operatorname{mode}(X) = \begin{cases}\frac{\alpha-1}{\beta+1} & \text{ if } \alpha \ge 1 \\ 0 & \text{ otherwise }\end{cases}" alt="Expected value for a beta prime distribution."> -->
<!-- <equation class="equation" label="eq:betaprime_mode" align="center" raw="\operatorname{mode}(X) = \begin{cases}\frac{\alpha-1}{\beta+1} & \text{ if } \alpha \ge 1 \\ 0 & \text{ otherwise }\end{cases}" alt="Mode for a beta prime distribution."> -->

```math
\mathop{\mathrm{mode}}(X) = \begin{cases}\frac{\alpha-1}{\beta+1} & \text{ if } \alpha \ge 1 \\ 0 & \text{ otherwise }\end{cases}
```

<!-- <div class="equation" align="center" data-raw-text="\operatorname{mode}(X) = \begin{cases}\frac{\alpha-1}{\beta+1} &amp; \text{ if } \alpha \ge 1 \\ 0 &amp; \text{ otherwise }\end{cases}" data-equation="eq:betaprime_expectation">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@51534079fef45e990850102147e8945fb023d1d0/lib/node_modules/@stdlib/stats/base/dists/betaprime/mode/docs/img/equation_betaprime_expectation.svg" alt="Expected value for a beta prime distribution.">
<!-- <div class="equation" align="center" data-raw-text="\operatorname{mode}(X) = \begin{cases}\frac{\alpha-1}{\beta+1} &amp; \text{ if } \alpha \ge 1 \\ 0 &amp; \text{ otherwise }\end{cases}" data-equation="eq:betaprime_mode">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@51534079fef45e990850102147e8945fb023d1d0/lib/node_modules/@stdlib/stats/base/dists/betaprime/mode/docs/img/equation_betaprime_expectation.svg" alt="Mode for a beta prime distribution.">
<br>
</div> -->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,41 +16,41 @@
* limitations under the License.
*/

import stdev = require( './index' );
import variance = require( './index' );


// TESTS //

// The function returns a number...
{
stdev( 8, 5 ); // $ExpectType number
variance( 8, 5 ); // $ExpectType number
}

// The compiler throws an error if the function is provided values other than two numbers...
{
stdev( true, 3 ); // $ExpectError
stdev( false, 2 ); // $ExpectError
stdev( '5', 1 ); // $ExpectError
stdev( [], 1 ); // $ExpectError
stdev( {}, 2 ); // $ExpectError
stdev( ( x: number ): number => x, 2 ); // $ExpectError

stdev( 9, true ); // $ExpectError
stdev( 9, false ); // $ExpectError
stdev( 5, '5' ); // $ExpectError
stdev( 8, [] ); // $ExpectError
stdev( 9, {} ); // $ExpectError
stdev( 8, ( x: number ): number => x ); // $ExpectError

stdev( [], true ); // $ExpectError
stdev( {}, false ); // $ExpectError
stdev( false, '5' ); // $ExpectError
stdev( {}, [] ); // $ExpectError
stdev( '5', ( x: number ): number => x ); // $ExpectError
variance( true, 3 ); // $ExpectError
variance( false, 2 ); // $ExpectError
variance( '5', 1 ); // $ExpectError
variance( [], 1 ); // $ExpectError
variance( {}, 2 ); // $ExpectError
variance( ( x: number ): number => x, 2 ); // $ExpectError

variance( 9, true ); // $ExpectError
variance( 9, false ); // $ExpectError
variance( 5, '5' ); // $ExpectError
variance( 8, [] ); // $ExpectError
variance( 9, {} ); // $ExpectError
variance( 8, ( x: number ): number => x ); // $ExpectError

variance( [], true ); // $ExpectError
variance( {}, false ); // $ExpectError
variance( false, '5' ); // $ExpectError
variance( {}, [] ); // $ExpectError
variance( '5', ( x: number ): number => x ); // $ExpectError
}

// The compiler throws an error if the function is provided insufficient arguments...
{
stdev(); // $ExpectError
stdev( 3 ); // $ExpectError
variance(); // $ExpectError
variance( 3 ); // $ExpectError
}