compute-ones

    1.0.1 • Public • Published

    Ones

    NPM version Build Status Coverage Status Dependencies

    Creates a ones-filled matrix or array.

    Installation

    $ npm install compute-ones

    For use in the browser, use browserify.

    Usage

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

    ones( dims[, opts] )

    Creates a ones-filled matrix or array. The dims argument may either be a positive integer specifying a length or an array of positive integers specifying dimensions.

    var out;
     
    out = ones( 5 );
    // returns [ 1, 1, 1, 1, 1 ];
     
    out = ones( [2,1,2] );
    // returns [ [ [1,1] ], [ [1,1] ] ]

    The function accepts the following options:

    By default, the output data structure is a generic array. To output a typed array or matrix, set the dtype option (see matrix for a list of acceptable data types).

    var out;
     
    out = ones( 5, {
        'dtype': 'float32'
    });
    // returns Float32Array( [1,1,1,1,1] );
     
    out = ones( [3,2], {
        'dtype': 'int32'
    });
    /*
        [ 1 1
          1 1
          1 1 ]
    */

    Notes:

    • Currently, for more than 2 dimensions, the function outputs a generic array and ignores any specified dtype.

      var out = ones( [2,1,3], {
          'dtype': 'float32'
      });
      // returns [ [ [1,1,1] ], [ [1,1,1] ] ]

    ones.compile( dims )

    Compiles a function for creating ones-filled arrays having specified dimensions.

    var fcn, out;
     
    fcn = ones.compile( [2,1,3] );
     
    out = fcn();
    // returns [ [ [1,1,1] ], [ [1,1,1] ] ]
     
    out = fcn();
    // returns [ [ [1,1,1] ], [ [1,1,1] ] ]

    Notes:

    • When repeatedly creating arrays having the same shape, creating a customized ones function will provide performance benefits.

    Examples

    var ones = require( 'compute-ones' ),
        out;
     
    // Plain arrays...
     
    // 1x10:
    out = ones( 10 );
     
    // 2x1x3:
    out = ones( [2,1,3] );
     
    // 5x5x5:
    out = ones( [5,5,5] );
     
    // 10x5x10x20:
    out = ones( [10,5,10,20] );
     
    // Typed arrays...
    out = ones( 10, {
        'dtype': 'float32'
    });
     
    // Matrices...
    out = ones( [3,2], {
        'dtype': 'int32'
    });

    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 © 2015-2016. The Compute.io Authors.

    Install

    npm i compute-ones

    DownloadsWeekly Downloads

    3

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • kgryte
    • planeshifter