compute-erfc

    3.0.1 • Public • Published

    erfc

    NPM version Build Status Coverage Status Dependencies

    Computes the complementary error function.

    The complementary error function is defined as

    Equation of the complementary error function.

    Equivalently, the complementary error function can be expressed using Craig's formula:

    Craig's formula of the complementary error function.

    Installation

    $ npm install compute-erfc

    For use in the browser, use browserify.

    Usage

    var erfc = require( 'compute-erfc' );

    erfc( x[, options] )

    Evaluates the complementary error function. x may be either a number, an array, a typed array, or a matrix. Values may include NaN, +infinity, and -infinity.

    var matrix = require( 'dstructs-matrix' ),
        data,
        mat,
        out,
        i;
     
    out = erfc( -1 );
    // returns ~1.8427
     
    out = erfc( [ -10, -1, 0, 1, 10 ] );
    // returns [ 2, 1.8427, 1, 0.1573, 2.0885e-45 ]
     
    data = [ 0, 1, 2 ];
    out = erfc( data );
    // returns [ 1, ~0.1573, ~0.0047 ]
     
    data = new Int8Array( data );
    out = erfc( data );
    // returns Float64Array( [ 1, ~0.1573, ~0.0047 ] )
     
    data = new Float64Array( 6 );
    for ( i = 0; i < 6; i++ ) {
        data[ i ] = i / 2;
    }
    mat = matrix( data, [3,2], 'float64' );
    /*
        [ 0  0.5
          1  1.5
          2  2.5 ]
    */
     
    out = erfc( mat );
    /*
        [  1    ~0.48
          ~0.16 ~0.03
          ~0    ~0    ]
    */

    The function accepts the following options:

    • accessor: accessor function for accessing array values.
    • dtype: output typed array or matrix data type. Default: float64.
    • copy: boolean indicating if the function 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', -10],
        ['boop', -1],
        ['bip', 0],
        ['bap', 1],
        ['baz', 10]
    ];
     
    function getValue( d, i ) {
        return d[ 1 ];
    }
     
    var out = erfc( data, {
        'accessor': getValue
    });
    // returns [ 2, 1.8427, 1, 0.1573, 2.0885e-45 ]

    To deepset an object array, provide a key path and, optionally, a key path separator.

    var data = [
        {'x':[0,-10]},
        {'x':[1,-1]},
        {'x':[2,0]},
        {'x':[3,1]},
        {'x':[4,10]}
    ];
     
    var out = erfc( data, 'x|1', '|' );
    /*
        [
            {'x':[0,2]},
            {'x':[1,1.8427]},
            {'x':[2,1]},
            {'x':[3,0.1573]},
            {'x':[4,2.0885e-45]}
        ]
    */
     
    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 = new Int8Array( [0, 1, 2] );
     
    out = erfc( data, {
        'dtype': 'int32'
    });
    // returns Int32Array( [1,0,0] )
     
    // Works for plain arrays, as well...
    out = erfc( [0, 1, 2], {
        'dtype': 'uint8'
    });
    // returns Uint8Array( [1,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 data,
        bool,
        mat,
        out,
        i;
     
    var data = [ -10, -1, 0, 1, 10 ];
     
    var out = erfc( data, {
        'copy': false
    });
    // returns [ 2, 1.8427, 1, 0.1573, 2.0885e-45 ]
     
    bool = ( data === out );
    // returns true
     
    data = new Float64Array( 6 );
    for ( i = 0; i < 6; i++ ) {
        data[ i ] = i / 2;
    }
    mat = matrix( data, [3,2], 'float64' );
    /*
        [  0  0.5
           1  1.5
           2  2.5 ]
    */
     
    out = erfc( mat, {
        'copy': false
    });
    /*
        [  1    ~0.48
          ~0.16 ~0.03
          ~0    ~0    ]
    */
     
    bool = ( mat === out );
    // returns true

    Notes

    • If an element is not a numeric value, the evaluated complementary error function is NaN.

      var data, out;
       
      out = erfc( null );
      // returns NaN
       
      out = erfc( true );
      // returns NaN
       
      out = erfc( {'a':'b'} );
      // returns NaN
       
      out = erfc( [ true, null, [] ] );
      // returns [ NaN, NaN, NaN ]
       
      function getValue( d, i ) {
          return d.x;
      }
      data = [
          {'x':true},
          {'x':[]},
          {'x':{}},
          {'x':null}
      ];
       
      out = erfc( data, {
          'accessor': getValue
      });
      // returns [ NaN, NaN, NaN, NaN ]
       
      out = erfc( data, {
          'path': 'x'
      });
      /*
          [
              {'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, as NaN values are cast to 0.

      var out = erfc( [ true, null, [] ], {
          'dtype': 'int8'
      });
      // returns Int8Array( [0,0,0] );

    Examples

    var matrix = require( 'dstructs-matrix' ),
        erfc = require( 'compute-erfc' );
     
    var data,
        mat,
        out,
        tmp,
        i;
     
    // Plain arrays...
    data = new Array( 10 );
    for ( i = 0; i < data.length; i++ ) {
        data[ i ] = Math.random()*20 - 10;
    }
    out = erfc( data );
     
    // Object arrays (accessors)...
    function getValue( d ) {
        return d.x;
    }
    for ( i = 0; i < data.length; i++ ) {
        data[ i ] = {
            'x': data[ i ]
        };
    }
    out = erfc( data, {
        'accessor': getValue
    });
     
    // Deep set arrays...
    for ( i = 0; i < data.length; i++ ) {
        data[ i ] = {
            'x': [ i, data[ i ].x ]
        };
    }
    out = erfc( data, {
        'path': 'x/1',
        'sep': '/'
    });
     
    // Typed arrays...
    data = new Int32Array( 10 );
    for ( i = 0; i < data.length; i++ ) {
        data[ i ] = Math.random()*20 - 10;
    }
    tmp = erfc( data );
    out = '';
    for ( i = 0; i < data.length; i++ ) {
        out += tmp[ i ];
        if ( i < data.length-1 ) {
            out += ',';
        }
    }
     
    // Matrices...
    mat = matrix( data, [5,2], 'int32' );
    out = erfc( mat );
     
    // Matrices (custom output data type)...
    out = erfc( mat, {
        'dtype': 'uint8'
    });

    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

    MIT license.

    Copyright

    Copyright © 2014-2015. The Compute.io Authors.

    Install

    npm i compute-erfc

    DownloadsWeekly Downloads

    309

    Version

    3.0.1

    License

    MIT

    Last publish

    Collaborators

    • kgryte
    • planeshifter