- 3.0.1 core module.
ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR > Class Template Reference

Computes the linearization of a general non-linear ControlledSystem using Automatic Differentiation (without code generation) More...

#include <AutoDiffLinearizer.h>

Inheritance diagram for ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >:
ct::core::LinearSystem< STATE_DIM, CONTROL_DIM, SCALAR > ct::core::ControlledSystem< STATE_DIM, CONTROL_DIM, SCALAR > ct::core::System< STATE_DIM, SCALAR >

Public Types

typedef CppAD::AD< SCALARADScalar
 
typedef ControlledSystem< STATE_DIM, CONTROL_DIM, ADScalarsystem_t
 type of system to be linearized More...
 
typedef DynamicsLinearizerAD< STATE_DIM, CONTROL_DIM, ADScalar, ADScalarlinearizer_t
 type of linearizer to be used More...
 
typedef Base::state_vector_t state_vector_t
 state vector type More...
 
typedef Base::control_vector_t control_vector_t
 input vector type More...
 
typedef Base::state_matrix_t state_matrix_t
 state Jacobian type More...
 
typedef Base::state_control_matrix_t state_control_matrix_t
 input Jacobian type More...
 
- Public Types inherited from ct::core::LinearSystem< STATE_DIM, CONTROL_DIM, SCALAR >
typedef Base::time_t time_t
 
typedef StateVector< STATE_DIM, SCALARstate_vector_t
 state vector type More...
 
typedef ControlVector< CONTROL_DIM, SCALARcontrol_vector_t
 input vector type More...
 
typedef StateMatrix< STATE_DIM, SCALARstate_matrix_t
 state Jacobian type More...
 
typedef StateControlMatrix< STATE_DIM, CONTROL_DIM, SCALARstate_control_matrix_t
 input Jacobian type More...
 
- Public Types inherited from ct::core::ControlledSystem< STATE_DIM, CONTROL_DIM, SCALAR >
typedef std::shared_ptr< ControlledSystem< STATE_DIM, CONTROL_DIM, SCALAR > > Ptr
 
typedef Base::time_t time_t
 
- Public Types inherited from ct::core::System< STATE_DIM, SCALAR >
typedef SCALAR time_t
 the type of the time variable More...
 

Public Member Functions

 AutoDiffLinearizer (std::shared_ptr< system_t > nonlinearSystem)
 default constructor More...
 
 AutoDiffLinearizer (const AutoDiffLinearizer &arg)
 copy constructor More...
 
virtual ~AutoDiffLinearizer ()
 destructor More...
 
AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR > * clone () const override
 deep cloning More...
 
virtual const state_matrix_tgetDerivativeState (const state_vector_t &x, const control_vector_t &u, const SCALAR t=SCALAR(0.0)) override
 get the Jacobian with respect to the state More...
 
virtual const state_control_matrix_tgetDerivativeControl (const state_vector_t &x, const control_vector_t &u, const SCALAR t=SCALAR(0.0)) override
 get the Jacobian with respect to the input More...
 
- Public Member Functions inherited from ct::core::LinearSystem< STATE_DIM, CONTROL_DIM, SCALAR >
 LinearSystem (const ct::core::SYSTEM_TYPE &type=ct::core::SYSTEM_TYPE::GENERAL)
 default constructor More...
 
virtual ~LinearSystem ()
 destructor More...
 
virtual void computeControlledDynamics (const state_vector_t &state, const time_t &t, const control_vector_t &control, state_vector_t &derivative) override
 compute the system dynamics More...
 
virtual const state_matrix_tgetDerivativeState (const state_vector_t &x, const control_vector_t &u, const time_t t=time_t(0.0))=0
 get the A matrix of a linear system More...
 
virtual const state_control_matrix_tgetDerivativeControl (const state_vector_t &x, const control_vector_t &u, const time_t t=time_t(0.0))=0
 get the B matrix of a linear system More...
 
virtual void getDerivatives (state_matrix_t &A, state_control_matrix_t &B, const state_vector_t &x, const control_vector_t &u, const time_t t=time_t(0.0))
 Get both linear system matrices A and B in one call. More...
 
- Public Member Functions inherited from ct::core::ControlledSystem< STATE_DIM, CONTROL_DIM, SCALAR >
 ControlledSystem (const SYSTEM_TYPE &type=SYSTEM_TYPE::GENERAL)
 default constructor More...
 
 ControlledSystem (std::shared_ptr< ct::core::Controller< STATE_DIM, CONTROL_DIM, SCALAR >> controller, const SYSTEM_TYPE &type=SYSTEM_TYPE::GENERAL)
 constructor More...
 
 ControlledSystem (const ControlledSystem &arg)
 copy constructor More...
 
virtual ~ControlledSystem ()
 destructor More...
 
void setController (const std::shared_ptr< Controller< STATE_DIM, CONTROL_DIM, SCALAR >> &controller)
 set a new controller More...
 
void getController (std::shared_ptr< Controller< STATE_DIM, CONTROL_DIM, SCALAR >> &controller) const
 get the controller instance More...
 
std::shared_ptr< Controller< STATE_DIM, CONTROL_DIM, SCALAR > > getController ()
 get the controller instace More...
 
virtual void computeDynamics (const StateVector< STATE_DIM, SCALAR > &state, const time_t &t, StateVector< STATE_DIM, SCALAR > &derivative) override
 compute the dynamics of the system More...
 
virtual void computeControlledDynamics (const StateVector< STATE_DIM, SCALAR > &state, const time_t &t, const ControlVector< CONTROL_DIM, SCALAR > &control, StateVector< STATE_DIM, SCALAR > &derivative)=0
 
ControlVector< CONTROL_DIM, SCALARgetLastControlAction ()
 
- Public Member Functions inherited from ct::core::System< STATE_DIM, SCALAR >
 System (const SYSTEM_TYPE &type=SYSTEM_TYPE::GENERAL)
 default constructor More...
 
 System (const System &other)
 copy constructor More...
 
virtual ~System ()
 destructor More...
 
virtual void computeDynamics (const StateVector< STATE_DIM, SCALAR > &state, const time_t &t, StateVector< STATE_DIM, SCALAR > &derivative)=0
 computes the system dynamics More...
 
SYSTEM_TYPE getType () const
 get the type of system More...
 
virtual bool isSymplectic () const
 Determines if the system is in symplectic form. More...
 

Public Attributes

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef LinearSystem< STATE_DIM, CONTROL_DIM, SCALARBase
 Base class type. More...
 
- Public Attributes inherited from ct::core::LinearSystem< STATE_DIM, CONTROL_DIM, SCALAR >
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef ControlledSystem< STATE_DIM, CONTROL_DIM, SCALARBase
 
- Public Attributes inherited from ct::core::ControlledSystem< STATE_DIM, CONTROL_DIM, SCALAR >
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef System< STATE_DIM, SCALARBase
 
- Public Attributes inherited from ct::core::System< STATE_DIM, SCALAR >
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef SCALAR S
 the scalar type More...
 

Protected Attributes

state_matrix_t dFdx_
 
state_control_matrix_t dFdu_
 
std::shared_ptr< system_tnonlinearSystem_
 instance of non-linear system More...
 
linearizer_t linearizer_
 instance of ad-linearizer More...
 
- Protected Attributes inherited from ct::core::ControlledSystem< STATE_DIM, CONTROL_DIM, SCALAR >
std::shared_ptr< Controller< STATE_DIM, CONTROL_DIM, SCALAR > > controller_
 the controller instance More...
 
ControlVector< CONTROL_DIM, SCALARcontrolAction_
 
- Protected Attributes inherited from ct::core::System< STATE_DIM, SCALAR >
SYSTEM_TYPE type_
 type of system More...
 

Detailed Description

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
class ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >

Computes the linearization of a general non-linear ControlledSystem using Automatic Differentiation (without code generation)

This class takes a non-linear ControlledSystem $ \dot{x} = f(x,u,t) $ and computes the linearization around a certain point $ x = x_s $, $ u = u_s $.

\[ \dot{x} = A x + B u \]

where

\[ \begin{aligned} A &= \frac{df}{dx} |_{x=x_s, u=u_s} \\ B &= \frac{df}{du} |_{x=x_s, u=u_s} \end{aligned} \]

Note
This is generally the most accurate way to generate the linearization of system dynamics together with ADCodegenLinearizer. However, the latter is much faster. Consider using the latter for production code.

Unit test AutoDiffLinearizerTest.cpp illustrates the use of the AutoDiffLinearizer.

Warning
You should ensure that your ControlledSystem is templated on the scalar type and does not contain branching (if/else statements, switch cases etc.)
This function still has some issues with pure time dependency
Todo:
Make time an Auto-Diff parameter
Template Parameters
dimensionof state vector
dimensionof control vector
SCALARprimitive type of resultant linear system
Examples:
AutoDiffLinearizerTest.cpp.

Member Typedef Documentation

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
typedef CppAD::AD<SCALAR> ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::ADScalar
template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
typedef ControlledSystem<STATE_DIM, CONTROL_DIM, ADScalar> ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::system_t

type of system to be linearized

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
typedef DynamicsLinearizerAD<STATE_DIM, CONTROL_DIM, ADScalar, ADScalar> ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::linearizer_t

type of linearizer to be used

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
typedef Base::state_vector_t ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::state_vector_t

state vector type

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
typedef Base::control_vector_t ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::control_vector_t

input vector type

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
typedef Base::state_matrix_t ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::state_matrix_t

state Jacobian type

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
typedef Base::state_control_matrix_t ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::state_control_matrix_t

input Jacobian type

Constructor & Destructor Documentation

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::AutoDiffLinearizer ( std::shared_ptr< system_t nonlinearSystem)
inline

default constructor

Parameters
nonlinearSystemnon-linear system instance to linearize
template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::AutoDiffLinearizer ( const AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR > &  arg)
inline

copy constructor

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
virtual ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::~AutoDiffLinearizer ( )
inlinevirtual

destructor

Member Function Documentation

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
AutoDiffLinearizer<STATE_DIM, CONTROL_DIM, SCALAR>* ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::clone ( ) const
inlineoverridevirtual

deep cloning

Implements ct::core::LinearSystem< STATE_DIM, CONTROL_DIM, SCALAR >.

Referenced by TEST().

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
virtual const state_matrix_t& ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::getDerivativeState ( const state_vector_t x,
const control_vector_t u,
const SCALAR  t = SCALAR(0.0) 
)
inlineoverridevirtual

get the Jacobian with respect to the state

This computes the linearization of the system with respect to the state at a given point $ x=x_s $, $ u=u_s $, i.e. it computes

\[ A = \frac{df}{dx} |_{x=x_s, u=u_s} \]

Parameters
xstate to linearize at
ucontrol to linearize at
ttime
Returns
Jacobian wrt state

References ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::dFdx_, ct::core::DynamicsLinearizerAD< STATE_DIM, CONTROL_DIM, SCALAR, TIME >::getDerivativeState(), ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::linearizer_, and t.

Referenced by TEST().

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
virtual const state_control_matrix_t& ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::getDerivativeControl ( const state_vector_t x,
const control_vector_t u,
const SCALAR  t = SCALAR(0.0) 
)
inlineoverridevirtual

get the Jacobian with respect to the input

This computes the linearization of the system with respect to the input at a given point $ x=x_s $, $ u=u_s $, i.e. it computes

\[ B = \frac{df}{du} |_{x=x_s, u=u_s} \]

Parameters
xstate to linearize at
ucontrol to linearize at
ttime
Returns
Jacobian wrt input

References ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::dFdu_, ct::core::DynamicsLinearizerAD< STATE_DIM, CONTROL_DIM, SCALAR, TIME >::getDerivativeControl(), ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::linearizer_, and t.

Referenced by TEST().

Member Data Documentation

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef LinearSystem<STATE_DIM, CONTROL_DIM, SCALAR> ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::Base

Base class type.

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
state_matrix_t ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::dFdx_
protected
template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
state_control_matrix_t ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::dFdu_
protected
template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
std::shared_ptr<system_t> ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::nonlinearSystem_
protected

instance of non-linear system

template<size_t STATE_DIM, size_t CONTROL_DIM, typename SCALAR = double>
linearizer_t ct::core::AutoDiffLinearizer< STATE_DIM, CONTROL_DIM, SCALAR >::linearizer_
protected

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