aboutsummaryrefslogtreecommitdiffstats
path: root/docs/matrix.dox
diff options
context:
space:
mode:
authorTravisBot <>2017-09-21 23:32:46 +0000
committerTravisBot <>2017-09-21 23:32:46 +0000
commit1a8ec165031af3b860028ef1b360acc8e7baf9e6 (patch)
treeb9d2e956005b4de847417baf4a66ab3f028f1bc1 /docs/matrix.dox
parentf5ecbc445977654e84120b3b02a9fe5d86dae5c8 (diff)
downloadYAGE-1a8ec165031af3b860028ef1b360acc8e7baf9e6.tar.gz
YAGE-1a8ec165031af3b860028ef1b360acc8e7baf9e6.zip
Rebuilding documentation
Diffstat (limited to 'docs/matrix.dox')
-rw-r--r--docs/matrix.dox33
1 files changed, 33 insertions, 0 deletions
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;
+}
+```
+
+*/