feat: add docs, benchmarks and examples

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: na
  - task: run_cpp_examples
    status: na
  - task: run_javascript_readme_examples
    status: na
  - task: run_c_benchmarks
    status: na
  - task: run_cpp_benchmarks
    status: na
  - task: run_fortran_benchmarks
    status: na
  - task: run_javascript_benchmarks
    status: na
  - task: run_julia_benchmarks
    status: na
  - task: run_python_benchmarks
    status: na
  - task: run_r_benchmarks
    status: na
  - task: run_javascript_tests
    status: na
---

Author: anandkaranubc

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

@@ -20,22 +20,22 @@ limitations under the License.
 
 # Mean
 
-> [Bradford][bradford-distribution] distribution [median][median].
+> [Bradford][bradford-distribution] distribution [variance][variance].
 
 <!-- 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 [median][median] for a [Bradford][bradford-distribution] random variable is
+The [variance][variance] for a [Bradford][bradford-distribution] random variable is
 
-<!-- <equation class="equation" label="eq:bradford_median" align="center" raw="\mathop{\mathrm{Median}}\left( X \right) = \frac{\sqrt{1 + c} - 1}{c}" alt="Median for a Bradford distribution."> -->
+<!-- <equation class="equation" label="eq:bradford_variance" align="center" raw="\mathop{\mathrm{Var}}\left( X \right) = \frac{(c+2) \ln(1+c) - 2c}{2c (\ln(1+c))^2}" alt="Variance for a Bradford distribution."> -->
 
 ```math
-\mathop{\mathrm{Median}}\left( X \right) = \frac{\sqrt{1 + c} - 1}{c}
+\mathop{\mathrm{Var}}\left( X \right) = \frac{(c+2) \ln(1+c) - 2c}{2c (\ln(1+c))^2}
 ```
 
-<!-- <div class="equation" align="center" data-raw-text="\mathop{\mathrm{Median}}\left( X \right) = \frac{\sqrt{1 + c} - 1}{c}" data-equation="eq:bradford_median">
-    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@591cf9d5c3a0cd3c1ceec961e5c49d73a68374cb/lib/node_modules/@stdlib/stats/base/dists/bradford/median/docs/img/equation_bradford_median.svg" alt="Median for a Bradford distribution.">
+<!-- <div class="equation" align="center" data-raw-text="\mathop{\mathrm{Var}}\left( X \right) = \frac{(c+2) \ln(1+c) - 2c}{2c (\ln(1+c))^2}" data-equation="eq:bradford_variance">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@591cf9d5c3a0cd3c1ceec961e5c49d73a68374cb/lib/node_modules/@stdlib/stats/base/dists/bradford/variance/docs/img/equation_bradford_variance.svg" alt="Variance for a Bradford distribution.">
     <br>
 </div> -->
 
@@ -54,31 +54,28 @@ where `c` is the shape parameter.
 ## Usage
 
 ```javascript
-var median = require( '@stdlib/stats/base/dists/bradford/median' );
+var variance = require( '@stdlib/stats/base/dists/bradford/variance' );
 ```
 
-#### median( c )
+#### variance( c )
 
-Returns the [median][median] of a [Bradford][bradford-distribution] distribution with shape parameter `c`.
+Returns the [variance][variance] of a [Bradford][bradford-distribution] distribution with shape parameter `c`.
 
 ```javascript
-var v = median( 0.1 );
-// returns ~0.488
+var v = variance( 0.1 );
+// returns ~0.083
 
-v = median( 10.0 );
-// returns ~0.232
+v = variance( 10.0 );
+// returns ~0.076
 ```
 
-If `c <= 0`, the function returns `NaN`.
+If provided `c <= 0`, the function returns `NaN`.
 
 ```javascript
-var v = median( NaN );
+v = variance( 0.0 );
 // returns NaN
 
-v = median( 0.0 );
-// returns NaN
-
-v = median( -1.5 );
+v = variance( -1.5 );
 // returns NaN
 ```
 
@@ -104,15 +101,15 @@ v = median( -1.5 );
 
 ```javascript
 var uniform = require( '@stdlib/random/array/uniform' );
-var median = require( '@stdlib/stats/base/dists/bradford/median' );
+var variance = require( '@stdlib/stats/base/dists/bradford/variance' );
 
 var c = uniform( 10, 0.1, 10.0 );
 
 var v;
 var i;
 for ( i = 0; i < c.length; i++ ) {
-    v = median( c[ i ] );
-    console.log( 'c: %d, Median(X;c): %d', c[ i ].toFixed( 4 ), v.toFixed( 4 ) );
+    v = variance( c[ i ] );
+    console.log( 'c: %d, Var(X;c): %d', c[ i ].toFixed( 4 ), v.toFixed( 4 ) );
 }
 ```
 
@@ -134,7 +131,7 @@ for ( i = 0; i < c.length; i++ ) {
 
 [bradford-distribution]: https://en.wikipedia.org/wiki/Bradford%27s_law
 
-[median]: https://en.wikipedia.org/wiki/Median
+[variance]: https://en.wikipedia.org/wiki/Variance
 
 </section>
 

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

@@ -24,7 +24,7 @@ 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 median = require( './../lib' );
+var variance = require( './../lib' );
 
 
 // MAIN //
@@ -38,7 +38,7 @@ bench( pkg, function benchmark( b ) {
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		y = median( c[ i % c.length ] );
+		y = variance( c[ i % c.length ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}

…ce/docs/img/equation_bradford_median.svg …/docs/img/equation_bradford_variance.svglib/node_modules/@stdlib/stats/base/dists/bradford/variance/docs/img/equation_bradford_median.svg renamed to lib/node_modules/@stdlib/stats/base/dists/bradford/variance/docs/img/equation_bradford_variance.svg lib/node_modules/@stdlib/stats/base/dists/bradford/variance/docs/img/equation_bradford_median.svg renamed to lib/node_modules/@stdlib/stats/base/dists/bradford/variance/docs/img/equation_bradford_variance.svg

@@ -1,6 +1,6 @@
 
 {{alias}}( c )
-    Returns the median of a Bradford distribution with shape
+    Returns the variance of a Bradford distribution with shape
     parameter `c`.
 
     If `c <= 0`, the function returns `NaN`.
@@ -13,16 +13,16 @@
     Returns
     -------
     out: number
-        Median.
+        Variance.
 
     Examples
     --------
     > var v = {{alias}}( 0.1 )
-    ~0.488
+    ~0.083
     > v = {{alias}}( 0.5 )
-    ~0.449
+    ~0.083
     > v = {{alias}}( 10.0 )
-    ~0.232
+    ~0.076
 
     See Also
     --------

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

@@ -19,42 +19,42 @@
 // TypeScript Version: 4.1
 
 /**
-* Returns the median of a Bradford distribution.
+* Returns the variance of a Bradford distribution.
 *
 * ## Notes
 *
 * -   If `c <= 0`, the function returns `NaN`.
 *
 * @param c - shape parameter
-* @returns median
+* @returns variance
 *
 * @example
-* var v = median( 0.1 );
-* // returns ~0.488
+* var v = variance( 0.1 );
+* // returns ~0.083
 *
 * @example
-* var v = median( 0.5 );
-* // returns ~0.449
+* var v = variance( 0.5 );
+* // returns ~0.083
 *
 * @example
-* var v = median( 10.0 );
-* // returns ~0.232
+* var v = variance( 10.0 );
+* // returns ~0.076
 *
 * @example
-* var v = median( 0.0 );
+* var v = variance( 0.0 );
 * // returns NaN
 *
 * @example
-* var v = median( -1.0 );
+* var v = variance( -1.0 );
 * // returns NaN
 *
 * @example
-* var v = median( NaN );
+* var v = variance( NaN );
 * // returns NaN
 */
-declare function median( c: number ): number;
+declare function variance( c: number ): number;
 
 
 // EXPORTS //
 
-export = median;
+export = variance;