Support runkit documentation

Author: Jason Walsh

README.md

@@ -16,26 +16,26 @@ Real-world examples will be provided from some of the following texts or courses
 
 ## Usage
 
-### ES2015
+### CommonJS
 
 ```javascript
-import * as stoch from '@jwalsh/stochastic';
-const exp = stoch.exp(20);
+var stochastic = require('@jwalsh/stochastic');
+var norm = stochastic.norm(1, 1, 100);
 ```
 
-### CommonJS
+### ES2015
 
 ```javascript
-var stoch = require('@jwalsh/stochastic');
-var norm = stoch.norm(1, 1, 100);
+import * as stochastic from '@jwalsh/stochastic';
+const exp = stochastic.exp(20);
 ```
 
 ### CDN
 
 ```html
 <script src="https://cdn.rawgit.com/jwalsh/stochastic/master/dist/bundle.min.js"></script>
 <script>
-  console.log(stoch.exp(20));
+  console.log(stochastic.exp(20));
 </script>
 ```
 
@@ -64,11 +64,11 @@ over the course of a standard 261 work-day year
 **Examples**
 
 ```javascript
-const poissP = stoch.poissP(1, 100, true);
+const poissP = stochastic.poissP(1, 100, true);
 ```
 
 ```javascript
-const emails = stoch.hist(Array(261).fill().map(e => stoch.poissP(10, 8, true).length));
+const emails = stochastic.hist(Array(261).fill().map(e => stochastic.poissP(10, 8, true).length));
 ```
 
 Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** times of each arrival in a Poisson Process
@@ -85,11 +85,28 @@ Returns the average.
 **Examples**
 
 ```javascript
-const avg = stoch.average([1, 2, 3]);
+const avg = stochastic.average([1, 2, 3]);
 ```
 
 Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** average
 
+### mode
+
+Returns the mode.
+
+**Parameters**
+
+-   `data`  
+-   `values` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** 
+
+**Examples**
+
+```javascript
+const mode = stochastic.mode([1, 2, 3]);
+```
+
+Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** mode
+
 ### std
 
 Returns the standard deviation.
@@ -101,7 +118,7 @@ Returns the standard deviation.
 **Examples**
 
 ```javascript
-const std = stoch.std([2, 3, 4, 4, 4, 5, 6]);
+const std = stochastic.std([2, 3, 4, 4, 4, 5, 6]);
 ```
 
 Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** standard deviation as positive number
@@ -117,7 +134,7 @@ Provides a summary of a set of data.
 **Examples**
 
 ```javascript
-const summary = stoch.summary([1, 2, 3]);
+const summary = stochastic.summary([1, 2, 3]);
 ```
 
 Returns **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** R-like summary of values
@@ -136,11 +153,31 @@ Returns a mock data set that uses the same standard deviation and average.
 **Examples**
 
 ```javascript
-const mock = stoch.mock(stoch.norm(1, 1, 100));
+const mock = stochastic.mock(stochastic.norm(1, 1, 100));
 ```
 
 Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** standard deviation as positive number
 
+### rsn
+
+Returns the Skew-Normal (SN) probability distribution.
+<http://azzalini.stat.unipd.it/SN/>
+
+**Parameters**
+
+-   `n` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** 
+-   `location` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** 
+-   `scale` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** 
+-   `shape` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** 0 is the normal distribution (optional, default `/*: number */0`)
+
+**Examples**
+
+```javascript
+const rsn = stochastic.rsn(10000, 1.256269, 1.605681, 5);
+```
+
+Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** average
+
 ### norm
 
 Returns an array with `num` normal random variables in a [normal distribution](http://en.wikipedia.org/wiki/Normal_distribution) of mean `mu` and standard deviation `sigma`.
@@ -152,11 +189,12 @@ Returns an array with `num` normal random variables in a [normal distribution](h
 -   `mu` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the mean or expectation of the distribution (and also its median and mode) (optional, default `1`)
 -   `sigma` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** standard deviation as positive number (optional, default `0`)
 -   `num` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** a positive integer (optional, default `1`)
+-   `xi`  
 
 **Examples**
 
 ```javascript
-const norm = stoch.norm(1, 1, 100);
+const norm = stochastic.norm(1, 1, 100);
 ```
 
 Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** normal random values
@@ -178,7 +216,7 @@ Returns an array corresponding to the path of [Brownian motion](http://en.wikipe
 **Examples**
 
 ```javascript
-const brown = stoch.brown(1.0, -0.1, +0.1, 100, true);
+const brown = stochastic.brown(1.0, -0.1, +0.1, 100, true);
 ```
 
 Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** Brownian motion path
@@ -201,7 +239,7 @@ Returns an array corresponding to the path of [geometric Brownian motion](http:/
 **Examples**
 
 ```javascript
-const GBM = stoch.GBM(1.0, -0.1, 0.1, 1.0, 100, true);
+const GBM = stochastic.GBM(1.0, -0.1, 0.1, 1.0, 100, true);
 ```
 
 Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** geometric Brownian motion
@@ -217,12 +255,12 @@ Returns an array with the states at each step of the [discrete-time Markov Chain
 -   `transMatrix` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>>** 
 -   `steps` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** (positive integer)
 -   `start` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** 
--   `path` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
+-   `path` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `true`)
 
 **Examples**
 
 ```javascript
-const DTMC = stoch.DTMC([[0,1,0],[0,0,1],[1,0,0]], 20, 0, true);
+const DTMC = stochastic.DTMC([[0,1,0],[0,0,1],[1,0,0]], 20, 0, true);
 ```
 
 Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** 
@@ -238,7 +276,7 @@ Returns the `transMatrix` for an array of mapped `states` to numerical values.
 **Examples**
 
 ```javascript
-const collate = stoch.collate([0,1,0,0,0,1,1,0,0]);
+const collate = stochastic.collate([0,1,0,0,0,1,1,0,0]);
 ```
 
 Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>>** transMatrix
@@ -259,7 +297,7 @@ Returns an object with the {key:value} pair {time:state} at each step of the [co
 **Examples**
 
 ```javascript
-const CTMC = stoch.CTMC([[0,1,0],[0,0,1],[1,0,0]], 20, 0, true);
+const CTMC = stochastic.CTMC([[0,1,0],[0,0,1],[1,0,0]], 20, 0, true);
 ```
 
 Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Continuous-time Markov chain
@@ -276,7 +314,7 @@ Generates a random sample (with replacement) from array `arr` of observations. N
 **Examples**
 
 ```javascript
-const sample = stoch.sample([1,2,3,4,5], +10);
+const sample = stochastic.sample([1,2,3,4,5], +10);
 ```
 
 Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** random sample
@@ -292,7 +330,7 @@ Generates an exponential random variable with rate parameter `lambda`.
 **Examples**
 
 ```javascript
-const exp = stoch.exp(20);
+const exp = stochastic.exp(20);
 ```
 
 Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** variable
@@ -310,7 +348,7 @@ Generates a Pareto random variables with parameters `x_m` and `alpha`.
 **Examples**
 
 ```javascript
-const pareto = stoch.pareto(+20.0, -1.0);
+const pareto = stochastic.pareto(+20.0, -1.0);
 ```
 
 Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** distribution
@@ -329,7 +367,7 @@ Generates a histogram object from an array of data. Keys denote the lower bound
 **Examples**
 
 ```javascript
-const hist = stoch.hist([1,1,1,1,2,3,3,4,4,4]);
+const hist = stochastic.hist([1,1,1,1,2,3,3,4,4,4]);
 ```
 
 Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** histogram

examples/CTMC.js

@@ -3,16 +3,16 @@
 // CTMC(transMatrix, T, start, path)
 import {plot} from 'plotter';
 
-import * as stoch from '../src/index';
+import * as stochastic from '../src/index';
 
 // switch to state 2 90% of the time; otherwise even probablity of staying or leaving state 2
 const transMatrixTwo = [
         [0.1, 0.9],
         [0.5, 0.5]
 ];
 
-// var CTMC = stoch.CTMC(transMatrixTwo, 20, 0, true);
-const CTMC = stoch.CTMC([[0,1,0],[0,0,1],[.5,.5,0]], 20, 0, true);
+// var CTMC = stochastic.CTMC(transMatrixTwo, 20, 0, true);
+const CTMC = stochastic.CTMC([[0,1,0],[0,0,1],[.5,.5,0]], 20, 0, true);
 
 plot({
     data:       {tick: CTMC},

examples/DTMC-biased-coin.js

@@ -1,5 +1,5 @@
 // Problem: Determine when a biased coin has been switched
-import * as stoch from '../src/index';
+import * as stochastic from '../src/index';
 
 // Is the biased or fair coin used
 const coinMode = [
@@ -9,7 +9,7 @@ const coinMode = [
 
 // Visualize the ground true for when a coin has been switch between fair and biased
 // Use 1000 as the base example
-const activeCoin = stoch.DTMC(coinMode, 1000, 0, true);
+const activeCoin = stochastic.DTMC(coinMode, 1000, 0, true);
 // console.log(activeCoin);
 const stateCoin = ['H', 'T'];
 

examples/DTMC.js

@@ -2,17 +2,17 @@
 
 import {plot} from 'plotter';
 
-import * as stoch from '../src/index';
+import * as stochastic from '../src/index';
 
 const transMatrixTwo = [
     [0, 1, 0],
     [0.4, 0.2, 0.4],
     [0, 1, 0]
 ];
 
-// var DTMC = stoch.DTMC([[0,1,0],[0,0,1],[1,0,0]], 20, 0, true);
-const DTMC = stoch.DTMC([[0,1,0],[0,0,1],[.5,.5,0]], 20, 0, true);
-// var DTMC = stoch.DTMC(transMatrixTwo, 20, 0, true);
+// var DTMC = stochastic.DTMC([[0,1,0],[0,0,1],[1,0,0]], 20, 0, true);
+const DTMC = stochastic.DTMC([[0,1,0],[0,0,1],[.5,.5,0]], 20, 0, true);
+// var DTMC = stochastic.DTMC(transMatrixTwo, 20, 0, true);
 
 console.log(DTMC);
 

examples/GBM.js

@@ -1,9 +1,9 @@
 // GBM(S0, mu, sigma, T, steps, path)
 import {plot} from 'plotter';
 
-import * as stoch from '../src/index';
+import * as stochastic from '../src/index';
 
-const GBM = stoch.GBM(1.0, -0.1, 0.1, 1.0, 100, true);
+const GBM = stochastic.GBM(1.0, -0.1, 0.1, 1.0, 100, true);
 
 console.log(GBM);
 

examples/collate.js

@@ -1,5 +1,5 @@
 // Problem: Determine when a biased coin has been switched
-import * as stoch from '../src/index';
+import * as stochastic from '../src/index';
 
 // http://www.lipsum.com/
 const lorem = 'Interdum et malesuada fames ac ante ipsum primis in faucibus. Donec cursus velit ut metus consequat, et consequat nisl lobortis. Donec pellentesque scelerisque tincidunt. Quisque in arcu neque. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Maecenas aliquam ullamcorper mi porta facilisis. Morbi molestie lacus nisi, sit amet sodales mauris suscipit quis. Quisque congue faucibus orci, fermentum dapibus diam auctor et. Curabitur dictum bibendum nisl nec facilisis. Aliquam et pellentesque nisi. Fusce sollicitudin porttitor purus vel pellentesque. Nullam maximus pulvinar massa, et scelerisque nibh bibendum sit amet. Pellentesque vestibulum ultricies felis eu auctor. Maecenas vitae enim a nulla sodales eleifend. Cras interdum augue eu varius tristique. Mauris feugiat semper magna, et tincidunt urna aliquet quis.';
@@ -44,8 +44,8 @@ const lookup = uniques
 const states = example
         .map((e, i, c) => lookup[e]);
 
-const transMatrix = stoch.collate(states);
+const transMatrix = stochastic.collate(states);
 // console.log(transMatrix);
 
-const dtmc = stoch.DTMC(transMatrix, 100, 0, true);
+const dtmc = stochastic.DTMC(transMatrix, 100, 0, true);
 console.log('Example:', dtmc.map((e, i, c) => uniques[e]).join(JOINER));