JavaScript Matrix Library
JavaScript Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
examples
projects
src
submodules
tests
third
.gitignore
.gitmodules
Makefile
README.md
index.html
licence.txt

README.md

JSM

The JavaScript Matrix Library

This library intends to provide an easy way to deal with nd-array. This implementation has many advantages since

  • it use typed array for fast computation and controled memory comsumption ;
  • parameters consistency is well checked ;
  • design allows it to work with real as well as complex values ;
  • it is easy to use thanks to the object notation.

Many modules are developed

  • for nd-array manipulation including value selection and modifications ;
  • for arithmetic and boolean operation ;
  • for linear algebra ;
  • for image processing, such as filtering, FFT, image matching ;
  • for statistical processing ; ...

A list of supported functions (not necessarily up to date) may be found here. A brief introduction is available here.

The inspiration is the well known Matlab software though there are some differences in the syntax we used.

Documentation and demos

The documentation can be consulted here. The code is documented using jsduck. Once it is installed just use the command make doc If you experience problem, be sure that you installed the ruby1.9-dev (or more recent) package and check this page.

Here are links to some demos that have been realized with this project. Note that they have been tested on Firefox and Google Chrome, and not with other browsers. Please be careful as well with large images, they might require large amount of memory and processing might take a lot of time !

How to compile and test it

Compilation

In order to regenerate the modules from the sources, you simply need to use the command make (Unix system). To minify the modules and the projects, you have to install uglifyjs. Once it's done, just enter make minify.

Test

To test it, just download the modules that you need, they are located in the ./modules/ directory. The core module is JSM.js and it is the concatenation of the Matrix.js, Matrix.js and Tools.js modules. The other modules such that Plot.js and Matching.js are independent. In the directory ./min/ you can find the minified version of the modules.

Nodejs and npm

There is not yet a specific package that can be install with npm but the modules JSM.js and JSM.min.js can be imported in nodejs script by using one of these instruction :

  • var JSM = require('./<path to the modules>/module/JSM.js'); ;
  • var JSM = require('./<path to the modules minified>/min/JSM.min.js');.

To be able to read and write images you have to install npm canvas package. To this end, ensure that the following packages are installed (on Ubuntu/Debian) :

  • node-legacy
  • libcairo2-dev
  • libgif-dev
  • libjpeg8-dev / libjpeg9-dev
  • libpango1.0-dev

Also, do not forget to add the path to nodejs modules, it should look like that : export NODE_PATH="/usr/local/lib/node_modules"

Why develop a JavaScript library for numerical computing ?

Many reasons can justify this. First, JavaScript is fun. It's easy too use and it has very powerful features (closures, prototype, ...). Also, put it together with HTML and CSS and you have a perfect team to build great and very efficient UIs. For research purpose, it allows to make online demonstrations which can be used directly in the browser.

More and more web applications request to deal with numerical data, and we do not found a library providing a complete and robust JavaScript framework to do it.

Other JavaScript libraries for numerical computation

Here comes a list made of JS library that we found interesting. This list does not pretend to exhaustive and if you would like to see a link to your website added here please send an email.

Content of the JSM project

./
+- doc/
|   +  jsduck.json              - doc. configuration file
|   +  guides.json              - tutorials configuration file
|   +- html/                    - generated documentation (HTML format)
|   |   +  index.html           - main page of the documentation
|   +- content/                 - doc. content (raw)
|   |   +  readme.md            - content of the doc. main page
|   +- tag/                     - custom tags definitions
+- examples/                    - examples of use of the Matrix class
+- modules/                     - modules grouping files together
|   +  JSM.js                   - standalone source file, containing all the JS code for the Matrix class
|   +  <files>.js               - others modules/projects minified
+- min/                         - minify versions of the Matrix class and related
|   +  JSM.min.js               - standalone source file, containing all the JS code for the Matrix class
|   +  <files>.min.js           - other module projects files minified
+- projects/                    - projects making use of the Matrix class
+- src/                         - source files
|   +- Matrix                   - Matrix JavaScript class, split into several files
|   +- MatrixView               - MatrixView JavaScript class, split into several files
|   +- Tools                    - Tools JavaScript object, split into several files
|   +- <modules>                - Other modules
+- third/                       - used to store third part projects
+ licence.txt                   - short licence description, included in JS files
+ Makefile                      - Makefile used to generate documentation, minified files and lint