Initial commit

Author: rreusser

LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Ricky Reusser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,50 @@
+# ndarray-linspace [![Build Status](https://travis-ci.org/scijs/ndarray-linspace.svg)](https://travis-ci.org/scijs/ndarray-linspace) [![npm version](https://badge.fury.io/js/ndarray-linspace.svg)](https://badge.fury.io/js/ndarray-linspace) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+
+> Fill an ndarray with equally spaced values
+
+## Example
+
+```javascript
+
+linspace(2, 3, 4, {endpoint: false})
+// => [ 2, 2.25, 2.5, 2.75 ]
+
+linspace(2, 3, 5, {endpoint: false})
+// => [ 2, 2.25, 2.5, 2.75, 3 ]
+
+linspace(2, 4, 10, {dtype: 'int8'})
+// => [ 2, 2, 2, 2, 2, 3, 3, 3, 3, 4 ]
+
+var y = pool.zeros([5])
+linspace(y, 1, 3, 5)
+// y => [ 1, 1.5, 2, 2.5, 3 ]
+
+var y = pool.zeros([2, 2])
+linspace(y, 0, 1, 2)
+// y => [ 0, 0 ]
+//      [ 1, 1 ]
+
+```
+
+## Installation
+
+```bash
+npm install ndarray-linspace
+```
+
+## API
+
+#### require('ndarray-linspace')([output,] start, end, steps[, options])
+An array of equally spaced values.
+
+Arguments:
+- `output` (options): if provided, the destination array to be filled with values. If the number of dimensions is greater than one, then the length of the first dimension must match the number of values and the entire ndarray will be filled with the linspace corresponding to the index of the first dimension.
+- `start`: starting value of the interval
+- `end`: ending value of the interval
+- `steps`: number of divisions
+- `options` (optional): A hash of options. Options are:
+  - `dtype`: dtype of output array (only used if output array not specified)
+  - `endpoint` (boolean): whether the output contains the endpoint of the interval
+
+## License
+© 2015 Ricky Reusser. MIT License.

examples/index.js

@@ -0,0 +1,7 @@
+'use strict'
+
+var linspace = require('../')
+
+console.log(linspace(2, 3, 10, {endpoint: false}))
+
+console.log(linspace(2, 4, 10, {dtype: 'int8'}))

index.js

@@ -0,0 +1,40 @@
+'use strict'
+
+var pool = require('ndarray-scratch')
+var fill = require('ndarray-fill')
+
+module.exports = linspace
+
+var defaults = {
+  endpoint: true,
+  dtype: 'double'
+}
+
+function linspace () {
+  var start, end, n, options, output
+
+  if (Number.isFinite(arguments[0])) {
+    start = arguments[0]
+    end = arguments[1]
+    n = arguments[2]
+    options = Object.assign({}, defaults, arguments[3] || {})
+    output = pool.zeros([n], options.dtype)
+  } else {
+    output = arguments[0]
+    start = arguments[1]
+    end = arguments[2]
+    n = arguments[3]
+    options = Object.assign({}, defaults, arguments[4] || {})
+
+    if (output.shape[0] !== n) {
+      throw new Error('number of values (' + n + ') must match the first dimension of the output (' + output.shape[0] + ')')
+    }
+  }
+
+  var d = (end - start) / (n - (options.endpoint ? 1 : 0))
+  fill(output, function (i) {
+    return start + i * d
+  })
+
+  return output
+}

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "ndarray-linspace",
+  "version": "1.0.0",
+  "description": "Fill an ndarray with equally spaced values",
+  "main": "index.js",
+  "scripts": {
+    "test": "standard && mocha test/*"
+  },
+  "keywords": [
+    "ndarray",
+    "linspace"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/scijs/ndarray-linspace.git"
+  },
+  "author": "Ricky Reusser",
+  "license": "MIT",
+  "devDependencies": {
+    "chai": "^3.4.1",
+    "mocha": "^2.3.4",
+    "ndarray": "^1.0.18",
+    "ndarray-tests": "^1.3.0",
+    "standard": "^5.4.1"
+  },
+  "dependencies": {
+    "ndarray-fill": "^1.0.1",
+    "ndarray-scratch": "^1.2.0"
+  }
+}

test/index.js

@@ -0,0 +1,50 @@
+/* global describe, it */
+'use strict'
+
+var ndarray = require('ndarray')
+var ndt = require('ndarray-tests')
+var linspace = require('../')
+var assert = require('chai').assert
+var pool = require('ndarray-scratch')
+
+describe('linspace', function () {
+  it('create a new linspace with and endpoint', function () {
+    var x = linspace(0, 1, 11)
+    var y = ndarray([0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1])
+    assert(ndt.equal(x, y, 1e-8))
+  })
+
+  it('create a new linspace without and endpoint', function () {
+    var x = linspace(0, 1, 10, {endpoint: false})
+    var y = ndarray([0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9])
+    assert(ndt.equal(x, y, 1e-8))
+  })
+
+  it('allows a dtype', function () {
+    var x = linspace(0, 10, 5, {dtype: 'int8'})
+    var y = ndarray([0, 2, 5, 7, 10])
+    assert(ndt.equal(x, y, 1e-8))
+  })
+
+  it('writes in place if output array provided', function () {
+    var x = pool.zeros([10])
+    linspace(x, 0, 1, 10, {endpoint: false})
+    var y = ndarray([0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9])
+    assert(ndt.equal(x, y, 1e-8))
+  })
+
+  it('fills in more than one dimension', function () {
+    var x = pool.zeros([2, 2])
+    linspace(x, 0, 1, 2)
+    var y = ndarray([0, 0, 1, 1], [2, 2])
+    assert(ndt.equal(x, y, 1e-8))
+  })
+
+  it("throws an error if the size of the first dimension doesn't match the number of points", function () {
+    var x = pool.zeros([2,2])
+    assert.throws(function () {
+      linspace(x, 0, 1, 10)
+    }, Error, 'must match')
+  })
+})
+