The ndarray-bundle is a Node module including ndarray and related useful libraries.
Usage
You include the module the same way you'd include ndarray:
var ndarray = require('ndarray-bundle');Other useful functionality (e.g. complex numbers, convolution, FFT) is available as properties or sub-properties:
ndarray.fill(arr, function (i, j) {
return i + j;
});Module structure
These are the modules that are included in the bundle - click the module names for documentation:
{
- complex: "ndarray-complex",
- fill: "ndarray-fill",
- is: "isndarray",
- ops: "ndarray-ops",
- pool: "ndarray-scratch",
- sort: "ndarray-sort",
- zeros: "zeros",
- image: {
- colorMap: "apply-colormap",
- linearInterpolate: "ndarray-linear-interpolate",
- luminance: "luminance",
- phaseAlign: "phase-align",
- rotate: "image-rotate",
- warp: "ndarray-warp"
- io: {
- string: "ndarray-string",
- wav: "ndarray-wav",
- binvox: {
- save: "ndarray-to-binvox"
- pixels: {
- get: "get-pixels",
- save: "save-pixels"
- matrix: {
- mul: "ndgemm"
- numeric: {
- distance: "ndarray-distance",
- moments: "ndarray-moments",
- prefixSum: "ndarray-prefix-sum"
- signal: {
- convolve: "ndarray-convolve",
- fft: "ndarray-fft",
- phaseUnwrap: "phase-unwrap",
- translate: "ndarray-translate",
- filters: {
- gaussian: "ndarray-gaussian-filter",
- translateFft: "ndarray-translate-fft"
- sparse: {
- bit: "ndarray-bit",
- hash: "ndarray-hash",
- proxy: "ndarray-proxy",
- segment: "ndarray-segment"
- util: {
- binarySearch: "binary-search-bounds",
- imshow: "ndarray-imshow",
- pack: "ndarray-pack",
- select: "ndarray-select",
- unpack: "ndarray-unpack"
If you only want to include specific things, there is code-generation available so you can create an equivalently-shaped bundle that only includes what you want. This is useful for Browserify, or applications where unnecessary modules are costly.
Contribute
Written an ndarray module, then please raise an issue on the GitHub repo. Pull requests are also welcome!