digamma
Computes the digamma function.
The digamma function ψ
is the logarithmic derivative of the gamma function, i.e.
Installation
$ npm install compute-digamma
For use in the browser, use browserify.
Usage
var digamma = ;
digamma( x[, options] )
Evaluates the digamma function (element-wise). x
may be either a number
, an array
, a typed array
, or a matrix
.
var matrix =datamatouti;out = ;// returns NaNout = ;// returns [ ~1.103, NaN, NaN, ~-0.577, ~2.252 ]data = 0 1 2 ;out = ;// returns [ NaN, ~-0.5772, ~0.423 ]data = data ;out = ;// returns Float64Array( [NaN,~-0.577,~0.423] )data = 6 ;for i = 0; i < 6; i++data i = i / 2;mat = ;/*[ 0 0.51 1.52 2.5 ]*/out = ;/*[ NaN ~-1.964~-0.577 ~0.036~0.423 ~0.703 ]*/
The function accepts the following options
:
- 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:
'.'
.
For non-numeric arrays
, provide an accessor function
for accessing array
values.
var data ='beep' -25'boop' -1'bip' 0'bap' 1'baz' 10;{return d 1 ;}var out =;// returns [ ~1.103, NaN, NaN, ~-0.577, ~2.252 ]
To deepset an object array
, provide a key path and, optionally, a key path separator.
var data ='x':0-25'x':1-1'x':20'x':31'x':410;var out =;/*[{'x':[0,~1.103]},{'x':[1,NaN]},{'x':[2,NaN]},{'x':[3,~-0.577]},{'x':[4,~2.252]}]*/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 data out;data = 0 1 2 ;out =;// returns Int32Array( [0,0,0] )// Works for plain arrays, as well...out =;// returns Uint8Array( [0,0,0] )
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 databoolmatouti;var data = -25 -1 0 1 10 ;var out =;// returns [ ~1.103, NaN, NaN, ~-0.577,~ 2.252 ]bool = data === out ;// returns truedata = 6 ;for i = 0; i < 6; i++data i = i / 2;mat = ;/*[ 0 0.51 1.52 2.5 ]*/out =;/*[ NaN ~-1.964~-0.577 ~0.036~0.423 ~0.703 ]*/bool = mat === out ;// returns true
Implementation
The function has been adapted from the implementation found in the Boost C++ library. See the Boost documentation about implementation details. Only the necessary parts for 17 significant digits were translated, as JavaScript floating-point numbers cannot the high-precision versions.
Notes
-
If an element is not a numeric value, the evaluated error 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 matrix =digamma = ;var datamatouttmpi;// Plain arrays...data = 10 ;for i = 0; i < datalength; i++data i = Math*20 - 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 = Math * 100;tmp = ;out = '';for i = 0; i < datalength; i++out += tmp i ;if i < datalength-1out += ',';// 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.