icarus::Mat3Handle< Scalar > Struct Template Reference

Handle for accessing a Mat3 signal as nine scalar components. More...

#include <VecHandle.hpp>

Collaboration diagram for icarus::Mat3Handle< Scalar >:

Public Member Functions
Mat3< Scalar >	get () const
	Read all components as a Mat3.
void	set (const Mat3< Scalar > &m)
	Write all components from a Mat3.
bool	valid () const
	Check if all handles are valid.
	operator bool () const
	Check if handle is valid.

Public Attributes
SignalHandle< Scalar >	m00
SignalHandle< Scalar >	m10
SignalHandle< Scalar >	m20
	Column 0.
SignalHandle< Scalar >	m01
SignalHandle< Scalar >	m11
SignalHandle< Scalar >	m21
	Column 1.
SignalHandle< Scalar >	m02
SignalHandle< Scalar >	m12
SignalHandle< Scalar >	m22
	Column 2.

Detailed Description

template<typename Scalar>
struct icarus::Mat3Handle< Scalar >

Handle for accessing a Mat3 signal as nine scalar components.

Matrix elements are stored in column-major order to match Eigen.

Template Parameters

Scalar

The scalar type (double or casadi::MX)

Member Function Documentation

get()

template<typename Scalar>

Mat3< Scalar > icarus::Mat3Handle< Scalar >::get ( ) const

inlinenodiscard

Read all components as a Mat3.

operator bool()

template<typename Scalar>

icarus::Mat3Handle< Scalar >::operator bool ( ) const

inlineexplicit

Check if handle is valid.

set()

template<typename Scalar>

void icarus::Mat3Handle< Scalar >::set ( const Mat3< Scalar > & m )

inline

Write all components from a Mat3.

valid()

template<typename Scalar>

bool icarus::Mat3Handle< Scalar >::valid ( ) const

inlinenodiscard

Check if all handles are valid.

Member Data Documentation

m00

template<typename Scalar>

SignalHandle<Scalar> icarus::Mat3Handle< Scalar >::m00

m01

template<typename Scalar>

SignalHandle<Scalar> icarus::Mat3Handle< Scalar >::m01

m02

template<typename Scalar>

SignalHandle<Scalar> icarus::Mat3Handle< Scalar >::m02

m10

template<typename Scalar>

SignalHandle<Scalar> icarus::Mat3Handle< Scalar >::m10

m11

template<typename Scalar>

SignalHandle<Scalar> icarus::Mat3Handle< Scalar >::m11

m12

template<typename Scalar>

SignalHandle<Scalar> icarus::Mat3Handle< Scalar >::m12

m20

template<typename Scalar>

SignalHandle<Scalar> icarus::Mat3Handle< Scalar >::m20

Column 0.

m21

template<typename Scalar>

SignalHandle<Scalar> icarus::Mat3Handle< Scalar >::m21

Column 1.

m22

template<typename Scalar>

SignalHandle<Scalar> icarus::Mat3Handle< Scalar >::m22

Column 2.

---

The documentation for this struct was generated from the following file:

• include/icarus/signal/VecHandle.hpp