ready for next patch release

fibo · Jun 9, 2016 · 544c496 · 544c496
1 parent d5f068e
commit 544c496
Show file tree

Hide file tree

Showing 5 changed files with 188 additions and 145 deletions.
diff --git a/_data/package.json b/_data/package.json
@@ -1,7 +1,7 @@
 {
   "name": "algebra",
   "description": "means completeness and balancing, from the Arabic word الجبر",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "engines": {
     "node": ">= 4.4.0"
   },
@@ -13,9 +13,7 @@
   "license": "MIT",
   "main": "index.js",
   "scripts": {
-    "_build": "npm test && npm run browserify && npm run minify && npm run tex && npm run jekyll; git status",
-    "_pull": "git pull origin master && npm run gh-pages:pull",
-    "_push": "git push origin master && npm run gh-pages:push",
+    "build": "npm test && npm run browserify && npm run minify && npm run tex && npm run jekyll; git status",
     "browserify": "npm run browserify:dist; npm run browserify:test",
     "browserify:dist": "browserify -r ./index.js:${npm_package_name} -t babelify -o dist/${npm_package_name}.js",
     "browserify:test": "browserify test/*.js -t babelify -o gh-pages/test/bundle.js",
@@ -39,7 +37,12 @@
     "tex:display": "ls gh-pages/tex-snippets/display/*.tex | while read texfile; do cat $texfile | katex --display-mode > gh-pages/_includes/display/$(basename ${texfile%.tex}).html; done",
     "tex:inline": "ls gh-pages/tex-snippets/inline/*.tex | while read texfile; do cat $texfile | katex > gh-pages/_includes/inline/$(basename ${texfile%.tex}).html; done",
     "postversion": "git push origin v${npm_package_version}; npm publish; npm run _push",
-    "test": "mocha --reporter min"
+    "postpublish": "npm run gh-pages:_data; git commit -am ':arrow_up: updated version'; npm run push",
+    "postupdate-deps": "npm test && git commit -am ':arrow_up: updated deps' || git checkout -- package.json",
+    "pull": "git pull origin master && npm run gh-pages:pull",
+    "push": "git push origin master && npm run gh-pages:push",
+    "test": "mocha --reporter min",
+    "update-deps": "npm update --save --dev"
   },
   "pre-commit": [
     "lint",
@@ -50,6 +53,7 @@
     "type": "git",
     "url": "git://github.com/fibo/algebra.git"
   },
+  "changelog": "gh-pages/changelog.md",
   "keywords": [
     "algebra",
     "matrix",
@@ -65,22 +69,20 @@
     "babelify": "^7.2.0",
     "browserify": "^13.0.0",
     "coveralls": "^2.11.9",
-    "install": "^0.6.1",
     "istanbul": "^0.4.1",
-    "katex": "^0.5.1",
+    "katex": "^0.6.0",
     "mocha": "^2.3.4",
     "mocha-lcov-reporter": "1.2.0",
     "pre-commit": "^1.1.2",
-    "should": "^8.3.1",
-    "standard": "^6.0.8",
+    "should": "^9.0.0",
+    "standard": "^7.0.0",
     "uglify-js": "^2.6.2"
   },
   "dependencies": {
     "algebra-cyclic": "^0.2.0",
     "cayley-dickson": "^0.3.0",
     "indices-permutations": "^0.2.0",
     "inherits": "^2.0.1",
-    "is-integer": "^1.0.6",
     "laplace-determinant": "^0.1.0",
     "matrix-multiplication": "^0.4.0",
     "multidim-array-index": "^0.5.0",

diff --git a/_data/tags.json b/_data/tags.json
@@ -1,4 +1,13 @@
 [
+  {
+    "name": "v0.10.0",
+    "zipball_url": "https://api.github.com/repos/fibo/algebra/zipball/v0.10.0",
+    "tarball_url": "https://api.github.com/repos/fibo/algebra/tarball/v0.10.0",
+    "commit": {
+      "sha": "f403137ce9c5c5a8eb2467a2fbcbf989df02ff75",
+      "url": "https://api.github.com/repos/fibo/algebra/commits/f403137ce9c5c5a8eb2467a2fbcbf989df02ff75"
+    }
+  },
   {
     "name": "v0.9.0",
     "zipball_url": "https://api.github.com/repos/fibo/algebra/zipball/v0.9.0",

diff --git a/changelog.md b/changelog.md
@@ -15,8 +15,13 @@ Changelog format adheres to [Keep a Changelog](http://keepachangelog.com/)</sub>
 
 ## [Unreleased]
 
+## [v0.10.1] - 2016-06-09
+
 - Replaced jshint with standardjs
 - fixed math formulas rendering in blog
+- few tests added
+- few doc improvements
+- using new static-props features
 
 ## [v0.10.0] - 2016-04-16
 

diff --git a/index.md b/index.md
@@ -5,15 +5,15 @@ title: algebra
 
 > Vectors, Matrices; Real, Complex, Quaternion; custom groups and rings for Node.js
 
-[![Node engine](https://img.shields.io/node/v/algebra.svg)](https://nodejs.org/en/) [![NPM version](https://badge.fury.io/js/algebra.svg)](http://badge.fury.io/js/algebra) [![Build Status](https://travis-ci.org/fibo/algebra.svg?branch=master)](https://travis-ci.org/fibo/algebra?branch=master) [![Dependency Status](https://gemnasium.com/fibo/algebra.svg)](https://gemnasium.com/fibo/algebra) [![Coverage Status](https://coveralls.io/repos/fibo/algebra/badge.svg?branch=master)](https://coveralls.io/r/fibo/algebra?branch=master) [![Test page](https://img.shields.io/badge/test-page-blue.svg)](http://g14n.info/algebra/test) [![Change log](https://img.shields.io/badge/change-log-blue.svg)](http://g14n.info/algebra/changelog)
+[![Node engine](https://img.shields.io/node/v/algebra.svg)](https://nodejs.org/en/) [![NPM version](https://badge.fury.io/js/algebra.svg)](http://badge.fury.io/js/algebra) [![Build Status](https://travis-ci.org/fibo/algebra.svg?branch=master)](https://travis-ci.org/fibo/algebra?branch=master) [![Dependency Status](https://david-dm.org/fibo/algebra.svg)](https://david-dm.org/fibo/algebra) [![Coverage Status](https://coveralls.io/repos/fibo/algebra/badge.svg?branch=master)](https://coveralls.io/r/fibo/algebra?branch=master) [![Test page](https://img.shields.io/badge/test-page-blue.svg)](http://g14n.info/algebra/test) [![Change log](https://img.shields.io/badge/change-log-blue.svg)](http://g14n.info/algebra/changelog)
 
 [![Whatchers](https://g14n.info/svg/github/watchers/algebra.svg)](https://github.com/fibo/algebra/watchers) [![Stargazers](https://g14n.info/svg/github/stars/algebra.svg)](https://github.com/fibo/algebra/stargazers) [![Forks](https://g14n.info/svg/github/forks/algebra.svg)](https://github.com/fibo/algebra/network/members)
 
 [![NPM](https://nodei.co/npm-dl/algebra.png)](https://nodei.co/npm-dl/algebra/)
 
 ![Algebra](http://g14n.info/algebra/images/Cover-Algebra.png) ![OnQuaternionsAndOctonions](http://g14n.info/algebra/images/Cover-OnQuaternionsAndOctonions.png)
 
-**Table Of Contents:**
+## Table Of Contents
 
 * [Status](#status)
 * [Features](#features)
@@ -26,56 +26,14 @@ title: algebra
   - [About operators](#about-operators)
   - [Cyclic](#cyclic)
   - [Scalar](#scalar)
-    - [attributes](#scalar-attributes)
-      - [one](#scalarone)
-      - [zero](#scalarzero)
-      - [data](#scalardata)
-      - [order](#scalar-order)
-    - [operators](#scalar-operators)
-      - [equality](#scalar-equality)
-      - [disequality](#scalar-disequality)
-      - [addition](#scalar-addition)
-      - [subtraction](#scalar-subtraction)
-      - [multiplication](#scalar-multiplication)
-      - [division](#scalar-division)
-      - [negation](#scalar-negation)
-      - [inversion](#scalar-inversion)
-      - [conjugation](#scalar-conjugation)
   - [Real](#real)
   - [Complex](#complex)
   - [Quaternion](#quaternion)
   - [Octonion](#octonion)
   - [Common spaces](#common-spaces)
-    - [R](#r)
-    - [R2](#r2)
-    - [R3](#r3)
-    - [R2x2](#r2x2)
-    - [C](#c)
-    - [H](#h)
   - [Vector](#vector)
-    - [attributes](#vector-attributes)
-    - [operators](#vector-operators)
-      - [cross product](#cross-product)
   - [Matrix](#matrix)
-    - [attributes](#matrix-attributes)
-      - [isSquare](#matrixissquare)
-      - [numCols](#matrixnumcols)
-      - [numRows](#matrixnumrows)
-    - [operators](#matrix-operators)
-      - [multiplication](#matrix-multiplication)
-      - [inversion](#matrix-inversion)
-      - [determinant](#matrix-determinant)
-      - [adjoint](#matrix-adjoint)
   - [Tensor](#tensor)
-    - [attributes](#tensor-attributes)
-      - [one](#tensorone)
-      - [zero](#tensorzero)
-      - [data](#tensordata)
-      - [indices](#tensor-indices)
-      - [order](#tensor-order)
-    - [operators](#tensor-operators)
-      - [equality](#tensor-equality)
-      - [scalarMultiplication](#scalar-multiplication)
 * [License](#license)
 
 ## Status
@@ -86,35 +44,35 @@ I am currently adding more tests and examples to achieve a stable version.
 
 Many functionalities of previous versions are now in separated atomic packages:
 
-* [algebra-cyclic](http://npm.im/algebra-cyclic)
-* [algebra-group](http://npm.im/algebra-group)
-* [algebra-ring][algebra-ring]
-* [cayley-dickson](http://npm.im/cayley-dickson)
-* [indices-permutations](http://npm.im/indices-permutations)
-* [laplace-determinant](http://npm.im/laplace-determinant)
-* [matrix-multiplication](http://npm.im/matrix-multiplication)
-* [multidim-array-index](http://npm.im/multidim-array-index)
-* [tensor-contraction](http://npm.im/tensor-contraction)
-* [tensor-permutation](http://npm.im/tensor-product)
+* [algebra-cyclic]
+* [algebra-group]
+* [algebra-ring]
+* [cayley-dickson]
+* [indices-permutations]
+* [laplace-determinant]
+* [matrix-multiplication]
+* [multidim-array-index]
+* [tensor-contraction]
+* [tensor-permutation]
 
 ## Features
 
 * Real, Complex, Quaternion, Octonion numbers.
-* [Vector](#vectors) and [Matrix](#matrices) spaces over any field (included [Real numbers](#scalars), of course :).
+* [Vector](#vectors) and [Matrix](#matrices) spaces over any field (included [Real numbers](#real), of course :).
 * Expressive syntax.
 * Everything is a Tensor.
 * [Immutable objects](https://en.wikipedia.org/wiki/Immutable_object).
 * [math blog][blog] with articles explaining algebra concepts and practical examples. I started [blogging about math](http://g14n.info/algebra/2015/08/i-love-math/) hoping it can help other people learning about the *Queen of Science*.
 
 ## Installation
 
-With [npm](https://npmjs.org/) do
+With [npm] do
 
 ```bash
 npm install algebra
 ```
 
-With [bower](http://bower.io/) do
+With [bower] do
 
 ```bash
 bower install algebra
@@ -576,10 +534,43 @@ Inherits everything from [Tensor](#tensor).
 
 ### Vector attributes
 
-##### `Vector.dimension`
+#### Vector dimension
+
+##### `Vector dimension`
+
+```javascript
+R2.dimension // 2
+```
+
+##### `vector.dimension`
+
+```javascript
+var vector = new R2([1, 1])
+
+vector.dimension // 2
+```
 
 ### Vector operators
 
+#### Addition
+
+##### `Vector.addition(vector1, vector2)`
+
+```javascript
+R2.addition([2, 1], [1, 2]) // [3, 3]
+```
+
+##### `vector1.addition(vector2)`
+
+```javascript
+var vector1 = new R2([2, 1])
+var vector2 = new R2([2, 2])
+
+var vector3 = vector1.addition(vector2)
+
+vector3 // Vector { data: [4, 3] }
+```
+
 #### Cross product
 
 It is defined only in dimension three. See [Cross product on wikipedia](https://en.wikipedia.org/wiki/Cross_product).
@@ -736,8 +727,19 @@ tensor2.equality(tensor2) // false
 
 [MIT](http://g14n.info/mit-license/)
 
+[npm]: https://npmjs.org/
+[bower]: http://bower.io/
 [blog]: http://g14n.info/algebra/articles "algebra blog"
-[algebra-ring]: http://npm.im/algebra-ring "algebra-ring"
 [composition-algebra]: https://en.wikipedia.org/wiki/Composition_algebra "Composition algebra"
 [booleanField]: https://github.com/fibo/algebra/blob/master/src/booleanField.js "boolean field"
 [realField]: https://github.com/fibo/algebra/blob/master/src/realField.js "real field"
+[algebra-cyclic]: http://npm.im/algebra-cyclic
+[algebra-group]: http://npm.im/algebra-group
+[algebra-ring]: http://npm.im/algebra-ring
+[cayley-dickson]: http://npm.im/cayley-dickson
+[indices-permutations]: http://npm.im/indices-permutations
+[laplace-determinant]: http://npm.im/laplace-determinant
+[matrix-multiplication]: http://npm.im/matrix-multiplication
+[multidim-array-index]: http://npm.im/multidim-array-index
+[tensor-contraction]: http://npm.im/tensor-contraction
+[tensor-permutation]: http://npm.im/tensor-product