feat: add stats/base/dists/bradford/stdev

PR-URL: #5333
Ref: #168

Reviewed-by: Philipp Burckhardt <[email protected]>

Author: anandkaranubc

lib/node_modules/@stdlib/stats/base/dists/bradford/stdev/README.md

@@ -0,0 +1,138 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# Standard Deviation
+
+> [Bradford][bradford-distribution] distribution [standard deviation][standard-deviation].
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+The [standard deviation][standard-deviation] for a [Bradford][bradford-distribution] random variable is
+
+<!-- <equation class="equation" label="eq:bradford_stdev" align="center" raw="\sigma = \sqrt{\frac{(c+2) \ln(1+c) - 2c}{2c (\ln(1+c))^2}}" alt="Standard deviation for a Bradford distribution."> -->
+
+```math
+\sigma = \sqrt{\frac{(c+2) \ln(1+c) - 2c}{2c (\ln(1+c))^2}}
+```
+
+<!-- <div class="equation" align="center" data-raw-text="\sigma = \sqrt{\frac{(c+2) \ln(1+c) - 2c}{2c (\ln(1+c))^2}}" data-equation="eq:bradford_stdev">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@591cf9d5c3a0cd3c1ceec961e5c49d73a68374cb/lib/node_modules/@stdlib/stats/base/dists/bradford/stdev/docs/img/equation_bradford_stdev.svg" alt="Standard deviation for a Bradford distribution.">
+    <br>
+</div> -->
+
+<!-- </equation> -->
+
+where `c` is the shape parameter.
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var stdev = require( '@stdlib/stats/base/dists/bradford/stdev' );
+```
+
+#### stdev( c )
+
+Returns the [standard deviation][standard-deviation] of a [Bradford][bradford-distribution] distribution with shape parameter `c`.
+
+```javascript
+var v = stdev( 0.1 );
+// returns ~0.289
+
+v = stdev( 10.0 );
+// returns ~0.276
+```
+
+If provided a shape parameter `c <= 0`, the function returns `NaN`.
+
+```javascript
+var v = stdev( 0.0 );
+// returns NaN
+
+v = stdev( -1.5 );
+// returns NaN
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var uniform = require( '@stdlib/random/array/uniform' );
+var stdev = require( '@stdlib/stats/base/dists/bradford/stdev' );
+
+var c = uniform( 10, 0.1, 10.0 );
+
+var v;
+var i;
+for ( i = 0; i < c.length; i++ ) {
+    v = stdev( c[ i ] );
+    console.log( 'c: %d, SD(X;c): %d', c[ i ].toFixed( 4 ), v.toFixed( 4 ) );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[bradford-distribution]: https://en.wikipedia.org/wiki/Bradford%27s_law
+
+[standard-deviation]: https://en.wikipedia.org/wiki/Standard_deviation
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/stats/base/dists/bradford/stdev/benchmark/benchmark.js

@@ -0,0 +1,52 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pkg = require( './../package.json' ).name;
+var stdev = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var c;
+	var y;
+	var i;
+
+	c = uniform( 100, 0.1, 10.0 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = stdev( c[ i % c.length ] );
+		if ( isnan( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/stats/base/dists/bradford/stdev/docs/img/equation_bradford_stdev.svg

@@ -0,0 +1,29 @@
+
+{{alias}}( c )
+    Returns the standard deviation of a Bradford distribution with shape
+    parameter `c`.
+
+    If `c <= 0`, the function returns `NaN`.
+
+    Parameters
+    ----------
+    c: number
+        Shape parameter.
+
+    Returns
+    -------
+    out: number
+        Standard deviation.
+
+    Examples
+    --------
+    > var v = {{alias}}( 0.1 )
+    ~0.289
+    > v = {{alias}}( 0.5 )
+    ~0.288
+    > v = {{alias}}( 10.0 )
+    ~0.276
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/stats/base/dists/bradford/stdev/docs/repl.txt

@@ -0,0 +1,60 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Returns the standard deviation of a Bradford distribution.
+*
+* ## Notes
+*
+* -   If `c <= 0`, the function returns `NaN`.
+*
+* @param c - shape parameter
+* @returns standard deviation
+*
+* @example
+* var v = stdev( 0.1 );
+* // returns ~0.289
+*
+* @example
+* var v = stdev( 0.5 );
+* // returns ~0.288
+*
+* @example
+* var v = stdev( 10.0 );
+* // returns ~0.276
+*
+* @example
+* var v = stdev( 0.0 );
+* // returns NaN
+*
+* @example
+* var v = stdev( -1.0 );
+* // returns NaN
+*
+* @example
+* var v = stdev( NaN );
+* // returns NaN
+*/
+declare function stdev( c: number ): number;
+
+
+// EXPORTS //
+
+export = stdev;

lib/node_modules/@stdlib/stats/base/dists/bradford/stdev/docs/types/index.d.ts

@@ -0,0 +1,44 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import stdev = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	stdev( 0.3 ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is provided a value other than a number...
+{
+	stdev( true ); // $ExpectError
+	stdev( false ); // $ExpectError
+	stdev( null ); // $ExpectError
+	stdev( undefined ); // $ExpectError
+	stdev( '5' ); // $ExpectError
+	stdev( [] ); // $ExpectError
+	stdev( {} ); // $ExpectError
+	stdev( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	stdev(); // $ExpectError
+}