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_1Matrix.html | 41 ++++++++++++++++++++++++++++------------- 1 file changed, 28 insertions(+), 13 deletions(-) (limited to 'classyage_1_1Matrix.html') diff --git a/classyage_1_1Matrix.html b/classyage_1_1Matrix.html index 1ff33119..81c2b6b0 100644 --- a/classyage_1_1Matrix.html +++ b/classyage_1_1Matrix.html @@ -29,7 +29,7 @@
YAGE -  0.02 +  v0.1.1
Yet Another Game Engine
@@ -94,7 +94,7 @@ $(document).ready(function(){initNavTree('classyage_1_1Matrix.html','');});

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

-

#include <matrix.hpp>

+

#include <matrix.h>

@@ -107,21 +107,22 @@ Public Member Functions - + + - + - + - + @@ -147,9 +148,13 @@ Friends

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

-

Matrix class

-

This is the base matrix class that can be used by all the other matrix like data structures.

-

Constructor & Destructor Documentation

+

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;
}

Constructor & Destructor Documentation

◆ Matrix() [1/2]

@@ -230,6 +235,7 @@ template<int Rows = 4, int Cols = 4, class Type = double>

Public Member Functions

 Returns the row size of the Matrix. More...
 
int colSize () const
 Returns the column size of the Matrixxs. More...
 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 begin More...
 Iterator support for the start. More...
 
std::vector< Type >::iterator end ()
 iterator support for end More...
 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...
 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)
 
+
Returns
Iterator pointing to the start of the data.
@@ -284,6 +290,7 @@ template<int Rows = 4, int Cols = 4, class Type = double>
+
Returns
Iterator pointing to the end of the data.
@@ -312,6 +319,13 @@ template<int Rows = 4, int Cols = 4, class Type = double>
+
Parameters
+ + +
colColumn number to be returned.
+
+
+
Returns
Column Matrix of the selected column.
@@ -342,11 +356,11 @@ template<int Rows = 4, int Cols = 4, class Type = double>
Parameters
- +
rowRow number to be returned
rowRow number to be returned.
-

Returns the row that is specified by the row variables.

+
Returns
The row that is specified by the row variables.
@@ -513,6 +527,7 @@ template<int Rows = 4, int Cols = 4, class Type = double>
+
Bug:
When printing certain matrices, it omits a row or column. Still need to determine under which conditions.

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

@@ -569,7 +584,7 @@ template<int Rows = 4, int Cols = 4, class Type = double>
The documentation for this class was generated from the following file: @@ -577,7 +592,7 @@ template<int Rows = 4, int Cols = 4, class Type = double>