From a37bc49882cd028b831b1d50f8e5ed586b64d65b Mon Sep 17 00:00:00 2001 From: Mark Hintz Date: Sat, 9 Apr 2016 18:44:23 +0200 Subject: [PATCH] Add note about column-vector convention 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. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 62f5568..b9e6d1e 100644 --- a/README.md +++ b/README.md @@ -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