Square Root
Computes an element-wise principal square root.
The principal square root is defined as
For negative numbers, the principal square root is not defined.
Installation
$ npm install compute-sqrt
For use in the browser, use browserify.
Usage
var sqrt = ;
sqrt( x[, opts] )
Computes an element-wise principal square root. x
may be either a number
, an array
, a typed array
, or a matrix
.
var matrix =datamatouti;out = ;// returns 3out = ;// returns NaNdata = 4 9 16 ;out = ;// returns [ 2, 3, 4 ]data = data ;out = ;// returns Float64Array( [2,3,4] )data = 6 ;for i = 0; i < 6; i++data i = i*i;mat = ;/*[ 0 14 916 25 ]*/out = ;/*[ 0 12 34 5 ]*/
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 =0419216325436;{return d 1 ;}var out =;// returns [ 2, 3, 4, 5, 6 ]
To deepset an object array
, provide a key path and, optionally, a key path separator.
var data ='x':04'x':19'x':216'x':325'x':436;var out = ;/*[{'x':[0,2]},{'x':[1,3]},{'x':[2,4]},{'x':[3,5]},{'x':[4,6]}]*/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 = 4916 ;out =;// returns Int32Array( [2,3,4] )// Works for plain arrays, as well...out =;// returns Uint8Array( [2,3,4] )
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;data = 4 9 16 ;out =;// returns [ 2, 3, 4 ]bool = data === out ;// returns truedata = 6 ;for i = 0; i < 6; i++data i = i*i;mat = ;/*[ 0 14 916 25 ]*/out =;/*[ 0 12 34 5 ]*/bool = mat === out ;// returns true
Notes
-
If an element is not a numeric value, the evaluated principal square root 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 =sqrt = ;var datamatouttmpi;// Plain arrays...data = 10 ;for i = 0; i < datalength; i++data i = Math;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;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 © 2014-2015. The Compute.io Authors.