diff options
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; +} +``` |