From 1a8ec165031af3b860028ef1b360acc8e7baf9e6 Mon Sep 17 00:00:00 2001 From: TravisBot <> Date: Thu, 21 Sep 2017 23:32:46 +0000 Subject: Rebuilding documentation --- namespaceyage_1_1matrix.html | 225 ------------------------------------------- 1 file changed, 225 deletions(-) delete mode 100644 namespaceyage_1_1matrix.html (limited to 'namespaceyage_1_1matrix.html') diff --git a/namespaceyage_1_1matrix.html b/namespaceyage_1_1matrix.html deleted file mode 100644 index 9484962b..00000000 --- a/namespaceyage_1_1matrix.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - - - -YAGE: yage::matrix Namespace Reference - - - - - - - - - - - - - - -
-
- - - - - - -
-
YAGE -  v0.1.1 -
-
Yet Another Game Engine
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
-
-Functions
-
-
yage::matrix Namespace Reference
-
-
- -

Namespace containing functions that operate on matrices. -More...

- - - - - - - - - - - - - - -

-Functions

template<int M, int N, class T >
Matrix< N, M, T > transpose (const Matrix< M, N, T > &m)
 Transposes a matrix and returns the result. More...
 
template<int R, class T >
T dot (const Matrix< R, 1, T > &m1, const Matrix< R, 1, T > &m2)
 Returns the dot product between two vectors. More...
 
template<int M, int N, int P, int Q, class T >
Matrix< M, Q, T > multiply (const Matrix< M, N, T > &m1, const Matrix< P, Q, T > &m2)
 Multiplies two matrices together. More...
 
-

Detailed Description

-

Implementations defined here are meant to operate on anything that inherits from the base Matrix class.

-

Function Documentation

- -

◆ dot()

- -
-
-
-template<int R, class T >
- - - - - - - - - - - - - - - - - - -
T yage::matrix::dot (const Matrix< R, 1, T > & m1,
const Matrix< R, 1, T > & m2 
)
-
-
Parameters
- - -
m1,m2Input matrices.
-
-
- -
-
- -

◆ multiply()

- -
-
-
-template<int M, int N, int P, int Q, class T >
- - - - - - - - - - - - - - - - - - -
Matrix<M, Q, T> yage::matrix::multiply (const Matrix< M, N, T > & m1,
const Matrix< P, Q, T > & m2 
)
-
-
Parameters
- - -
m1,m2Matrix inputs
-
-
-

Requires the two matrices to be compatible with multiplication.

-
Todo:
Think if this should be a static_assert.
-

Performs multiplication by getting the rows and columns, transposing one of them and then doting the result.

- -
-
- -

◆ transpose()

- -
-
-
-template<int M, int N, class T >
- - - - - - - - -
Matrix<N, M, T> yage::matrix::transpose (const Matrix< M, N, T > & m)
-
-
Parameters
- - -
minput matrix.
-
-
- -
-
-
-
- - - - -- cgit