Skip to content

Commit

Permalink
[UPDATE] README.
Browse files Browse the repository at this point in the history
  • Loading branch information
kgryte committed May 30, 2015
1 parent 0fe2a03 commit 93143c3
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ __Note__: while a `Matrix` has a `length` property, a `Matrix` should __not__ be
var data = new Float32Array( 10 );

var mat = matrix( data, [10,1] );
// [ 0 0 0 0 0 0 0 0 0 0 ]

var value = mat.get( 3, 1 );
// returns 0
Expand Down Expand Up @@ -322,15 +323,15 @@ The `shape` and `dtype` parameters are the same as above.
<a name="matrix-raw-properties-methods"></a>
### Properties and Methods

`Matrix` properties and methods are the same as for the higher-level API, with the exception that the properties are __no__ longer read-only.
`Matrix` properties and methods are the same as for the higher-level API, with the exception that `Matrix` properties are __no__ longer read-only.

Setting properties is __not__ recommended as the `Matrix` can become corrupted; e.g., incompatible dimensions, out-of-bounds indexing, etc. In contrast to the strict API above, setting these properties will __not__ result in an `error` being thrown. Accordingly, property modification may introduce silent bugs.
Setting properties is __not__ recommended as the `Matrix` can become corrupted; e.g., incompatible dimensions, out-of-bounds indexing, etc. In contrast to the strict API above, setting `Matrix` properties will __not__ result in an `error` being thrown. Accordingly, property modification may introduce silent bugs.


<a name="matrix-raw-constructors"></a>
### Constructors
<a name="matrix-raw-constructor"></a>
### Constructor

Constructors produced using the lower-level API have the same interface as those created via the higher-level API.
The lower-level `Matrix` constructor has the same interface as the higher-level `Matrix` constructor.



Expand Down

0 comments on commit 93143c3

Please sign in to comment.