diff options
author | Yann Herklotz <ymherklotz@gmail.com> | 2017-08-28 20:59:20 +0100 |
---|---|---|
committer | Yann Herklotz <ymherklotz@gmail.com> | 2017-08-28 20:59:20 +0100 |
commit | 0b1004135890380d2594b4aff3bb2fb17d64b6c4 (patch) | |
tree | 2f75aa321be525f99801f698a9a66a6667f4cced /docs | |
parent | 05685988739382343031b1fb2c94b74699f4ff7e (diff) | |
download | YAGE-0b1004135890380d2594b4aff3bb2fb17d64b6c4.tar.gz YAGE-0b1004135890380d2594b4aff3bb2fb17d64b6c4.zip |
Adding more documentation and improving tests.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/README.md | 2 | ||||
-rw-r--r-- | docs/matrix.dox | 33 |
2 files changed, 34 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md index ce85d85f..f39d0f8e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ Documentation -================ +============= Visit this [page](https://www.yannherklotz.com/YAGE) for the documentation. diff --git a/docs/matrix.dox b/docs/matrix.dox new file mode 100644 index 00000000..c1c99dde --- /dev/null +++ b/docs/matrix.dox @@ -0,0 +1,33 @@ +/** @class yage::Matrix + +%Matrix Class +============ + +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. + +``` +#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; +} +``` + +*/ |