From 8ad8165816929301a87e90bbb32c3df6b69030ee Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Sat, 2 Sep 2017 12:28:11 +0100 Subject: Updating docs --- classyage_1_1math_1_1Matrix.html | 602 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 602 insertions(+) create mode 100644 classyage_1_1math_1_1Matrix.html (limited to 'classyage_1_1math_1_1Matrix.html') diff --git a/classyage_1_1math_1_1Matrix.html b/classyage_1_1math_1_1Matrix.html new file mode 100644 index 00000000..68360a39 --- /dev/null +++ b/classyage_1_1math_1_1Matrix.html @@ -0,0 +1,602 @@ + + + + + + + +YAGE: yage::math::Matrix< Rows, Cols, Type > Class Template Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
YAGE +  v0.1.1 +
+
Yet Another Game Engine
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +Protected Attributes | +Friends | +List of all members
+
+
yage::math::Matrix< Rows, Cols, Type > Class Template Reference
+
+
+ +

Base Matrix class used by other similar classes. + More...

+ +

#include <matrix.hpp>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Matrix ()
 Initializes the size of the data_ vector. More...
 
 Matrix (const std::vector< Type > &data)
 
int rowSize () const
 Returns the row size of the Matrix. More...
 
int colSize () const
 Returns the column size of the Matrix. More...
 
Matrix< 1, Cols, Type > getRow (int row) const
 Return the row specified row as a Matrix with only one row. More...
 
Matrix< Rows, 1, Type > getCol (int col) const
 Get a specific column in a column vector. More...
 
std::vector< Type >::iterator begin ()
 Iterator support for the start. More...
 
std::vector< Type >::iterator end ()
 Iterator support for the end. More...
 
virtual std::string toString () const
 Prints out the matrix, but can also be implemented by other classes to print data differently. More...
 
detail::Row< Rows, Cols, Type > operator[] (int row)
 
detail::Row< Rows, Cols, Type > operator[] (int row) const
 
Matrix< Rows, Cols, Type > & operator+= (const Matrix< Rows, Cols, Type > &rhs)
 
Matrix< Rows, Cols, Type > & operator-= (const Matrix< Rows, Cols, Type > &rhs)
 
+ + + + +

+Protected Attributes

std::vector< Type > data_
 Vector containing the data of the matrix. More...
 
+ + + +

+Friends

class detail::Row< Rows, Cols, Type >
 
+

Detailed Description

+

template<int Rows = 4, int Cols = 4, class Type = double>
+class yage::math::Matrix< Rows, Cols, Type >

+ +

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 argc, char **argv)
{
yage::math::Matrix mat1;
return 0;
}

Constructor & Destructor Documentation

+ +

◆ Matrix() [1/2]

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + +
yage::math::Matrix< Rows, Cols, Type >::Matrix ()
+ 		+inline
+
+ +
+
+ +

◆ Matrix() [2/2]

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + + +
yage::math::Matrix< Rows, Cols, Type >::Matrix (const std::vector< Type > & data)
+ 		+inline
+
+ +
+
+

Member Function Documentation

+ +

◆ begin()

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + +
std::vector<Type>::iterator yage::math::Matrix< Rows, Cols, Type >::begin ()
+ 		+inline
+
+
Returns
Iterator pointing to the start of the data.
+ +
+
+ +

◆ colSize()

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + +
int yage::math::Matrix< Rows, Cols, Type >::colSize () const
+ 		+inline
+
+ +
+
+ +

◆ end()

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + +
std::vector<Type>::iterator yage::math::Matrix< Rows, Cols, Type >::end ()
+ 		+inline
+
+
Returns
Iterator pointing to the end of the data.
+ +
+
+ +

◆ getCol()

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + + +
Matrix<Rows, 1, Type> yage::math::Matrix< Rows, Cols, Type >::getCol (int col) const
+ 		+inline
+
+
Parameters
+ + +
colColumn number to be returned.
+
+
+
Returns
Column Matrix of the selected column.
+ +
+
+ +

◆ getRow()

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + + +
Matrix<1, Cols, Type> yage::math::Matrix< Rows, Cols, Type >::getRow (int row) const
+ 		+inline
+
+
Parameters
+ + +
rowRow number to be returned.
+
+
+
Returns
The row that is specified by the row variables.
+ +
+
+ +

◆ operator+=()

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + + +
Matrix<Rows, Cols, Type>& yage::math::Matrix< Rows, Cols, Type >::operator+= (const Matrix< Rows, Cols, Type > & rhs)
+ 		+inline
+
+ +
+
+ +

◆ operator-=()

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + + +
Matrix<Rows, Cols, Type>& yage::math::Matrix< Rows, Cols, Type >::operator-= (const Matrix< Rows, Cols, Type > & rhs)
+ 		+inline
+
+ +
+
+ +

◆ operator[]() [1/2]

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + + +
detail::Row<Rows, Cols, Type> yage::math::Matrix< Rows, Cols, Type >::operator[] (int row)
+ 		+inline
+
+ +
+
+ +

◆ operator[]() [2/2]

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + + +
detail::Row<Rows, Cols, Type> yage::math::Matrix< Rows, Cols, Type >::operator[] (int row) const
+ 		+inline
+
+
Todo:
got to fix this
+ +
+
+ +

◆ rowSize()

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + +
int yage::math::Matrix< Rows, Cols, Type >::rowSize () const
+ 		+inline
+
+ +
+
+ +

◆ toString()

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + + + + +
virtual std::string yage::math::Matrix< Rows, Cols, Type >::toString () const
+ 		+inlinevirtual
+
+
Bug:
When printing certain matrices, it omits a row or column. Still need to determine under which conditions.
+ +

Reimplemented in yage::math::Vector< Rows, Type >, and yage::math::Vector< 2, Type >.

+ +
+
+

Friends And Related Function Documentation

+ +

◆ detail::Row< Rows, Cols, Type >

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + +
friend class detail::Row< Rows, Cols, Type >
+ 		+friend
+
+ +
+
+

Member Data Documentation

+ +

◆ data_

+ +
+
+
+template<int Rows = 4, int Cols = 4, class Type = double>
+ + + + + +
+ + + + +
std::vector<Type> yage::math::Matrix< Rows, Cols, Type >::data_
+ 		+protected
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit