aboutsummaryrefslogtreecommitdiffstats
path: root/docs/matrix.md
blob: 93138bb96191beb3df01ce55ca560b8f27bdb8b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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;
}
```