Matrix Class Reference

The Matrix class. More...

#include <RobotAPI/libraries/aron/core/type/variant/ndarray/Matrix.h>

Inheritance diagram for Matrix:

Public Member Functions
int	getCols () const
type::matrix::ElementType	getElementType () const
std::string	getFullName () const override
	get the full name of this specific type More...
int	getRows () const
std::string	getShortName () const override
	get a short name of this specific type More...
	Matrix (const Path &path=Path())
	Matrix (const type::dto::Matrix &, const Path &path=Path())
void	setCols (const int)
void	setElementType (const type::matrix::ElementType)
void	setRows (const int)
type::dto::MatrixPtr	toMatrixDTO () const
Public Member Functions inherited from NDArrayVariant< type::dto::Matrix, Matrix >
size_t	childrenSize () const override
std::vector< VariantPtr >	getChildren () const override
	get all child elements More...
std::string	getDefaultValue () const
VariantPtr	navigateAbsolute (const Path &path) const override
	naviate absolute More...
void	setDefaultValue (const std::string &v)
virtual	~NDArrayVariant ()=default
Public Member Functions inherited from SpecializedVariantBase< type::dto::Matrix, Matrix >
type::Maybe	getMaybe () const override
	get the maybe type More...
VariantPtr	navigateRelative (const Path &path) const override
	navigate relative More...
	operator type::dto::Matrix ()
bool	operator== (const Matrix &other) const
bool	operator== (const Variant &other) const override
void	setMaybe (const type::Maybe m) override
	set the maybetype of this type More...
	SpecializedVariantBase (const type::Descriptor &descriptor, const Path &path)
	SpecializedVariantBase (const type::dto::Matrix &o, const type::Descriptor &descriptor, const Path &path)
type::dto::GenericTypePtr	toAronDTO () const override
	convert this variant to a dto object. More...
virtual	~SpecializedVariantBase ()=default
Public Member Functions inherited from Variant
virtual size_t	childrenSize () const =0
virtual std::vector< VariantPtr >	getChildren () const =0
	get all child elements More...
type::Descriptor	getDescriptor () const
virtual type::Maybe	getMaybe () const =0
	get the maybe type More...
Path	getPath () const
bool	operator== (const VariantPtr &other) const
std::string	pathToString () const
virtual type::dto::GenericTypePtr	toAronDTO () const =0
	convert this variant to a dto object. More...
	Variant (const type::Descriptor &descriptor, const Path &path=Path())
virtual	~Variant ()=default

Static Public Attributes
static const std::map< matrix::ElementType, std::string >	Elementtype2String
static const std::map< std::string, matrix::ElementType >	String2Elementtype

Additional Inherited Members
Public Types inherited from Variant
using	PointerType = VariantPtr
Static Public Member Functions inherited from SpecializedVariantBase< type::dto::Matrix, Matrix >
static const Matrix &	DynamicCast (const Variant &n)
static std::shared_ptr< Matrix >	DynamicCast (const VariantPtr &n)
static Matrix &	DynamicCast (Variant &n)
static std::shared_ptr< Matrix >	DynamicCastAndCheck (const VariantPtr &n)
Static Public Member Functions inherited from Variant
static VariantPtr	FromAronDTO (const type::dto::GenericType &, const Path &=Path())
	create a variant object from an dto object More...
Protected Attributes inherited from SpecializedVariantBase< type::dto::Matrix, Matrix >
type::dto::Matrix ::PointerType	aron
Protected Attributes inherited from Variant
const type::Descriptor	descriptor
const Path	path

Detailed Description

The Matrix class.

It represents the matrix type A Matrix is defined through the number of rows, cols and the element type

Definition at line 39 of file Matrix.h.

Constructor & Destructor Documentation

Matrix() [1/2]

Matrix

(

const Path &

path = Path()

)

Definition at line 43 of file Matrix.cpp.

Matrix() [2/2]

Matrix	(	const type::dto::Matrix &	o,
		const Path &	path = Path()
	)

Definition at line 48 of file Matrix.cpp.

Member Function Documentation

getCols()

int getCols

(

)

const

Definition at line 60 of file Matrix.cpp.

Here is the caller graph for this function:

getElementType()

type::matrix::ElementType getElementType

(

)

const

Definition at line 88 of file Matrix.cpp.

Here is the caller graph for this function:

getFullName()

std::string getFullName ( ) const

overridevirtual

get the full name of this specific type

Implements Variant.

Definition at line 113 of file Matrix.cpp.

Here is the call graph for this function:

getRows()

int getRows

(

)

const

Definition at line 54 of file Matrix.cpp.

Here is the caller graph for this function:

getShortName()

std::string getShortName ( ) const

overridevirtual

get a short name of this specific type

Implements Variant.

Definition at line 107 of file Matrix.cpp.

setCols()

void setCols

(

const int

h

)

Definition at line 77 of file Matrix.cpp.

Here is the call graph for this function:

setElementType()

void setElementType

(

const type::matrix::ElementType

u

)

Definition at line 94 of file Matrix.cpp.

setRows()

void setRows

(

const int

w

)

Definition at line 66 of file Matrix.cpp.

Here is the call graph for this function:

toMatrixDTO()

type::dto::MatrixPtr toMatrixDTO

(

)

const

Definition at line 100 of file Matrix.cpp.

Member Data Documentation

Elementtype2String

const std::map< matrix::ElementType, std::string > Elementtype2String

static

Initial value:

{
        {matrix::ElementType::INT16, "INT16"},
        {matrix::ElementType::INT32, "INT32"},
        {matrix::ElementType::INT64, "INT64"},
        {matrix::ElementType::FLOAT32, "FLOAT32"},
        {matrix::ElementType::FLOAT64, "FLOAT64"}}

Definition at line 60 of file Matrix.h.

String2Elementtype

const std::map< std::string, matrix::ElementType > String2Elementtype

static

Initial value:

=
        conversion::util::InvertMap(Elementtype2String)

Definition at line 61 of file Matrix.h.

---

The documentation for this class was generated from the following files:

• RobotAPI/libraries/aron/core/type/variant/ndarray/Matrix.h
• RobotAPI/libraries/aron/core/type/variant/ndarray/Matrix.cpp