diff options
author | Yann Herklotz <ymherklotz@gmail.com> | 2018-01-07 23:09:06 +0000 |
---|---|---|
committer | Yann Herklotz <ymherklotz@gmail.com> | 2018-01-07 23:09:06 +0000 |
commit | 0a42123b150e06f28ae82e460e854984c2dc9648 (patch) | |
tree | a5909cde7cebe6d2d9f1a9da6f121b378846696e /docs/matrix.md | |
parent | f066218b1fce4398588d6b139477399a15f750b7 (diff) | |
download | YAGE-0a42123b150e06f28ae82e460e854984c2dc9648.tar.gz YAGE-0a42123b150e06f28ae82e460e854984c2dc9648.zip |
[Docs] Changing documentation
Diffstat (limited to 'docs/matrix.md')
-rw-r--r-- | docs/matrix.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/matrix.md b/docs/matrix.md new file mode 100644 index 00000000..93138bb9 --- /dev/null +++ b/docs/matrix.md @@ -0,0 +1,29 @@ +Matrix Guide {#matrix_guide} +============ + +The matrix class is a templated class which implements a mathematical %Matrix. + + +Usage Guide +----------- + +The class can be instantiated + + +Example Code +------------ + +Creating a %Matrix and performing operations on it. + +``` c++ +#include <YAGE/Math/matrix.hpp> + +int main(int, char **) +{ + yage::Matrix<2, 2, int> mat1 {{1, 2, 3, 4}}; + yage::Matrix<2, 2, int> mat2 {{5, 6, 7, 8}}; + + int dot = yage::math::dot(mat1, mat2); + return 0; +} +``` |