[WIP] Add Rademacher statistical distribution

lib/node_modules/@stdlib/stats/base/dists/rademacher/README.md

@@ -0,0 +1,112 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2018 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.
+
+-->
+
+# Rademacher
+
+> Rademacher distribution.
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var rademacher = require( '@stdlib/stats/base/dists/rademacher' );
+```
+
+#### rademacher
+
+Rademacher distribution.
+
+```javascript
+var dist = rademacher;
+// returns {...}
+```
+
+The namespace contsiner the following distribution functions:
+
+<!-- <toc pattern="*+(cdf|pmf|mgf|quantile)*"> -->
+
+<!-- </toc> -->
+
+The namespace contains the following functions for calculating distribution properties:
+
+<!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> -->
+
+<!-- </toc> -->
+
+The namespace container a constructor function for creating a [Rademacher][rademacher-distribution] distribution object.
+
+<!-- <toc pattern="*ctor*"> -->
+
+<!-- </toc> -->
+
+```javascript
+var Rademacher = require( '@stdlib/stats/base/dists/rademacher' ).Rademacher;
+
+var dist = new Rademacher( 5.0 );
+
+var y = dist.pmf( -1.0 );
+// returns 0.5
+
+y = dist.pmf( 1.0 );
+// returns 0.5
+
+y = dist.pmf( 0.4 );
+// returns 0.0
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var getKeys = require( '@stdlib/utils/keys' );
+var rademacher = require( '@stdlib/stats/base/dists/rademacher' );
+
+console.log( getKeys( rademacher ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[rademacher-distribution]: https://en.wikipedia.org/wiki/Rademacher_distribution 
+
+<!-- <toc-links> -->
+
+<!-- </toc-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/stats/base/dists/rademacher/cdf/README.md

@@ -0,0 +1,107 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2018 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.
+
+-->
+
+# Cumulative Distribution Function
+
+> [Rademacher][rademacher-distribution] distribution [cumulative distribution function][cdf].
+
+<section class="intro">
+
+The [cumulative distribution function][cdf] for a [Rademacher][rademacher-distribution] random variable is
+
+<!-- <equation class="equation" label="eq:rademacher_cdf" align="center" raw="F(k)= \begin{cases} 0 & \text{ for } k < -1 \\ 1/2 & \text{ for } -1  \le k < 1  \\ 1 & \text{ for } k \ge 1 \end{cases}" alt="Cumulative distribution function for a Rademacher distribution."> -->
+
+<div class="equation" align="center" data-raw-text="F(k)= \begin{cases} 0 & \text{ for } k < -1 \\ 1/2 & \text{ for } -1  \le k < 1  \\ 1 & \text{ for } k \ge 1 \end{cases}" data-equation="eq:rademacher_cdf">
+    <img src="" alt="Cumulative distribution function for a Rademacher distribution." />
+    <br />
+</div>
+
+<!-- </equation> -->
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var cdf = require( '@stdlib/stats/base/dists/rademacher/cdf' );
+```
+
+#### cdf( k )
+
+Evaluates the [cumulative distribution function][cdf] for a [Rademacher][rademacher-distribution] distribution.
+
+```javascript
+var v = cdf( 0.0 );
+// returns 0.5
+
+v = cdf( 1.0 );
+// returns 1.0
+
+v = cdf( -2.0 );
+// returns 0.0
+
+v = cdf( NaN );
+// returns NaN
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var randu = require( '@stdlib/random/base/randu' );
+var cdf = require( '@stdlib/stats/base/dists/rademacher/cdf' );
+
+var p;
+var k;
+var i;
+
+for ( i = 0; i < 10; i++ ) {
+    k = ( randu()*4.0 ) - 2.0;
+    p = cdf( k );
+    console.log( 'k: %d, F(k): %d', k.toFixed( 4 ), p.toFixed( 4 ) );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<section class="links">
+
+[cdf]: https://en.wikipedia.org/wiki/Cumulative_distribution_function
+
+[rademacher-distribution]: https://en.wikipedia.org/wiki/Rademacher_distribution
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/stats/base/dists/rademacher/cdf/benchmark/benchmark.js

@@ -0,0 +1,51 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 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 randu = require( '@stdlib/random/base/randu' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var cdf = require( './../lib' );
+var pkg = require( './../package.json' ).name;
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var i;
+	var p;
+	var k;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		k = ( randu()*2.0 ) - 1.0;
+		p = cdf( k );
+		if ( isnan( p ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( p ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/stats/base/dists/rademacher/cdf/docs/repl.txt

@@ -0,0 +1,31 @@
+
+{{alias}}( k )
+    Evaluates the cumulative distribution function (CDF) for a Rademacher
+    distribution.
+
+    If provided `NaN`, the function returns `NaN`.
+
+    Parameters
+    ----------
+    k: number
+        Input value.
+
+    Returns
+    -------
+    out: number
+        Evaluated CDF.
+
+    Examples
+    --------
+    > var v = {{alias}}( 0.0 )
+    0.5
+    > v = {{alias}}( 1.0 )
+    1.0
+    > v = {{alias}}( -2.0 )
+    0.0
+    > v = {{alias}}( NaN )
+    NaN
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/stats/base/dists/rademacher/cdf/examples/index.js

@@ -0,0 +1,32 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 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';
+
+var randu = require( '@stdlib/random/base/randu' );
+var cdf = require( '@stdlib/stats/base/dists/rademacher/cdf' );
+
+var p;
+var k;
+var i;
+
+for ( i = 0; i < 10; i++ ) {
+	k = ( randu()*4.0 ) - 2.0;
+	p = cdf( k );
+	console.log( 'k: %d, F(k): %d', k.toFixed( 4 ), p.toFixed( 4 ) );
+}

lib/node_modules/@stdlib/stats/base/dists/rademacher/cdf/lib/index.js

@@ -0,0 +1,49 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 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';
+
+/**
+* Rademacher distribution cumulative distribution function (CDF).
+*
+* @module @stdlib/stats/base/dists/rademacher/cdf
+*
+* @example
+* var cdf = require( '@stdlib/stats/base/dists/rademacher/cdf' );
+*
+* var v = cdf( 0.0 );
+* // returns 0.5
+*
+* v = cdf( 1.0 );
+* // returns 1.0
+*
+* v = cdf( -2.0 );
+* // returns 0.0
+*
+* v = cdf( NaN );
+* // returns NaN
+*/
+
+// MODULES //
+
+var cdf = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = cdf;