From c7dad1e929c0101386fbcdaa194e402d68f74752 Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Wed, 23 Aug 2017 22:56:53 +0100 Subject: Updating docs --- classyage_1_1Vector2.html | 362 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 347 insertions(+), 15 deletions(-) (limited to 'classyage_1_1Vector2.html') diff --git a/classyage_1_1Vector2.html b/classyage_1_1Vector2.html index ab3801f6..0988e1b6 100644 --- a/classyage_1_1Vector2.html +++ b/classyage_1_1Vector2.html @@ -9,6 +9,13 @@ + + + + + @@ -44,6 +51,21 @@ $(function() { }); + +
+ +
+
+
+ +
- -
+Public Member Functions | List of all members
yage::Vector2< Type > Class Template Reference
-

2D Vector class. +

2D Vector class. More...

#include <matrix.hpp>

- -

Inherits yage::Vector< Rows, Type >.

+
+Inheritance diagram for yage::Vector2< Type >:
+
+
+ + +yage::Vector< 2, Type > +yage::Matrix< Rows, 1, Type > + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Vector2 ()
 
 Vector2 (const std::vector< Type > &data)
 
 Vector2 (Type x, Type y)
 
 Vector2 (const Matrix< 2, 1, Type > &other)
 
Type & x ()
 
const Type & x () const
 
Type & y ()
 
const Type & y () const
 
- Public Member Functions inherited from yage::Vector< 2, Type >
 Vector ()
 
 Vector (const Matrix< Rows, 1, Type > &other)
 
 Vector (const std::vector< Type > &data)
 
Type & operator[] (int col)
 
const Type & operator[] (int col) const
 
std::string toString () const override override override
 prints out the matrix, but can also be implemented by other classes to print data differently More...
 
- Public Member Functions inherited from yage::Matrix< Rows, 1, Type >
 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 Matrixxs. 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
 
std::vector< Type >::iterator begin ()
 iterator support for begin More...
 
std::vector< Type >::iterator end ()
 iterator support for end 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)
 
+ + + + + +

+Additional Inherited Members

- Protected Attributes inherited from yage::Matrix< Rows, 1, Type >
std::vector< Type > data_
 Vector containing the data of the matrix. More...
 

Detailed Description

template<class Type = double>
class yage::Vector2< Type >

-

2D Vector class.

Two dimensional vector class.

-
The documentation for this class was generated from the following file:

Constructor & Destructor Documentation

+ +

◆ Vector2() [1/4]

+ +
+
+
+template<class Type = double>
+ + + + + +
+ + + + + + + +
yage::Vector2< Type >::Vector2 ()
+ 		+inline
+
+ +
+
+ +

◆ Vector2() [2/4]

+ +
+
+
+template<class Type = double>
+ + + + + +
+ + + + + + + + +
yage::Vector2< Type >::Vector2 (const std::vector< Type > & data)
+ 		+inline
+
+ +
+
+ +

◆ Vector2() [3/4]

+ +
+
+
+template<class Type = double>
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
yage::Vector2< Type >::Vector2 (Type x,
Type y 
)
+ 		+inline
+
+ +
+
+ +

◆ Vector2() [4/4]

+ +
+
+
+template<class Type = double>
+ + + + + +
+ + + + + + + + +
yage::Vector2< Type >::Vector2 (const Matrix< 2, 1, Type > & other)
+ 		+inline
+
+ +
+
+

Member Function Documentation

+ +

◆ x() [1/2]

+ +
+
+
+template<class Type = double>
+ + + + + +
+ + + + + + + +
Type& yage::Vector2< Type >::x ()
+ 		+inline
+
+ +
+
+ +

◆ x() [2/2]

+ +
+
+
+template<class Type = double>
+ + + + + +
+ + + + + + + +
const Type& yage::Vector2< Type >::x () const
+ 		+inline
+
+ +
+
+ +

◆ y() [1/2]

+ +
+
+
+template<class Type = double>
+ + + + + +
+ + + + + + + +
Type& yage::Vector2< Type >::y ()
+ 		+inline
+
+ +
+
+ +

◆ y() [2/2]

+ +
+
+
+template<class Type = double>
+ + + + + +
+ + + + + + + +
const Type& yage::Vector2< Type >::y () const
+ 		+inline
+
+ +
+
+
The documentation for this class was generated from the following file: + -
-Generated on Mon Aug 21 2017 20:54:26 for YAGE by   -doxygen - 1.8.13 -
+ -- cgit