Quantile Function
Lognormal distribution quantile function.
The quantile function for a lognormal random variable is
for 0 <= p < 1
, where mu
is the location parameter and sigma > 0
is the scale parameter.
Installation
$ npm install distributions-lognormal-quantile
For use in the browser, use browserify.
Usage
var quantile = ;
quantile( p[, options] )
Evaluates the quantile function for the lognormal distribution. p
may be either a number
between 0
and 1
, an array
, a typed array
, or a matrix
.
var matrix =matoutxi;out = ;// returns ~0.509x = 0 02 04 06 08 1 ;out = ;// returns [ 0, ~0.431, ~0.776, ~1.29, ~2.32, +Infinity ]x = x ;out = ;// returns Float64Array( [0,~0.431,~0.776,~1.29,~2.32,+Infinity] )x = 6 ;for i = 0; i < 6; i++x i = i / 6;mat = ;/*[ 0 1/62/6 3/64/5 5/6 ]*/out = ;/*[ 0 ~0.38~0.65 ~1~1.54 ~2.63 ]*/
The function accepts the following options
:
- mu: location parameter. Default:
0
. - sigma: scale parameter. Default:
1
. - accessor: accessor
function
for accessingarray
values. - dtype: output
typed array
ormatrix
data type. Default:float64
. - copy:
boolean
indicating if thefunction
should return a new data structure. Default:true
. - path: deepget/deepset key path.
- sep: deepget/deepset key path separator. Default:
'.'
.
A Lognormal distribution is a function of two parameter(s): mu
(location parameter) and sigma > 0
(scale parameter). By default, mu
is equal to 0
and sigma
is equal to 1
. To adjust either parameter, set the corresponding option.
var x = 0 02 04 06 08 1 ;var out =;// returns [0,~1.3,~95,~2981,~93510,~6847352]
For non-numeric arrays
, provide an accessor function
for accessing array
values.
var data =0010220430640851;{return d 1 ;}var out =;// returns [ 0, ~0.431, ~0.776, ~1.29, ~2.32, +Infinity ]
To deepset an object array
, provide a key path and, optionally, a key path separator.
var data ='x':00'x':102'x':204'x':306'x':408'x':51;var out =;/*[{'x':[0,0]},{'x':[1,~0.431]},{'x':[2,~0.776]},{'x':[3,~1.29]},{'x':[4,~2.32]},{'x':[5,+Infinity]}]*/var bool = data === out ;// returns true
By default, when provided a typed array
or matrix
, the output data structure is float64
in order to preserve precision. To specify a different data type, set the dtype
option (see matrix
for a list of acceptable data types).
var x out;x = 02040608 ;out =;// returns Int32Array( [0,0,1,2] )// Works for plain arrays, as well...out =;// returns Uint8Array( [0,0,1,2] )
By default, the function returns a new data structure. To mutate the input data structure (e.g., when input values can be discarded or when optimizing memory usage), set the copy
option to false
.
var boolmatoutxi;x = 0 02 04 06 08 1 ;out =;// returns [ 0, ~0.431, ~0.776, ~1.29, ~2.32, +Infinity ]bool = x === out ;// returns truex = 6 ;for i = 0; i < 6; i++x i = i / 6 ;mat = ;/*[ 0 1/62/6 3/64/5 5/6 ]*/out =;/*[ 0 ~0.38~0.65 ~1~1.54 ~2.63 ]*/bool = mat === out ;// returns true
Notes
-
For any
p
outside the interval[0,1]
, the the evaluated quantile function isNaN
.var out;out = ;// returns NaNout = ;// returns NaN -
If an element is not a numeric value, the evaluated quantile function is
NaN
.var data out;out = ;// returns NaNout = ;// returns NaNout = ;// returns NaNout = ;// returns [ NaN, NaN, NaN ]{return dx;}data ='x':true'x':'x':{}'x':null;out =;// returns [ NaN, NaN, NaN, NaN ]out =;/*[{'x':NaN},{'x':NaN},{'x':NaN,{'x':NaN}]*/ -
Be careful when providing a data structure which contains non-numeric elements and specifying an
integer
output data type, asNaN
values are cast to0
.var out =;// returns Int8Array( [0,0,0] );
Examples
var quantile =matrix = ;var datamatouttmpi;// Plain arrays...data = 10 ;for i = 0; i < datalength; i++data i = i / 10;out = ;// Object arrays (accessors)...{return dx;}for i = 0; i < datalength; i++data i ='x': data i;out =;// Deep set arrays...for i = 0; i < datalength; i++data i ='x': i data i x;out =;// Typed arrays...data = 10 ;for i = 0; i < datalength; i++data i = i / 10;out = ;// Matrices...mat = ;out = ;// Matrices (custom output data type)...out =;
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
License
Copyright
Copyright © 2015. The Compute.io Authors.