README.md

ndarray-linspace

Fill an ndarray with equally spaced values

Example

var ndarray = require('ndarray');
var linspace = require('ndarray-linspace');

linspace(ndarray([], [5]), 2, 3);
// => ndarray([2, 2.25, 2.5, 2.75, 3])

linspace(ndarray([], [5]), 2, 3, {endpoint: false});
// => ndarray([2, 2.2, 2.4, 2.6, 2.8])

linspace(ndarray([], [2, 2]), 0, 1);
// y => [ 0, 0 ]
//      [ 1, 1 ]

linspace(ndarray([], [2, 2]), 0, 1, {axis: 1});
// y => [ 0, 1 ]
//      [ 0, 1 ]

Installation

npm install ndarray-linspace

API

require('ndarray-linspace')(output, start, end[, options])

An array of equally spaced values.

Arguments:

• output The destination array to be filled with values.
• start: starting value of the interval
• end: ending value of the interval
• options (optional): A hash of options. Options are:
  • endpoint (default: true): whether the output contains the endpoint of the interval
  • axis (default: 0): the dimension along which to fill the array. Must be an integer less than or equal to the dimension of the input.

Returns: A reference to the output

License

© 2015 Ricky Reusser. MIT License.