hodasemi/cgmath
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add note about column-vector convention

Browse source 
This is something which I think every vector math library should have, as it clears
up the convention for newcomers and saves them the trouble of figuring that out for themselves.
This commit is contained in:
Mark Hintz 2016-04-09 18:44:23 +02:00
parent cfeb001ea7
commit a37bc49882
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -25,6 +25,13 @@ is not fully covered by the testsuite. If you encounter any mistakes or
omissions please let me know by posting an issue, or even better: send me a
pull request with a fix.
## Conventions
cgmath interprets its vectors as column matrices (also known as "column
vectors"), meaning when transforming a vector with a matrix, the matrix goes
on the left. This is reflected in the fact that cgmath implements the
multiplication operator for Matrix * Vector, but not Vector * Matrix.
## Limitations
cgmath is _not_ an n-dimensional library and is aimed at computer graphics