Crocoddyl
integ-action-base.hpp
1 // BSD 3-Clause License
3 //
4 // Copyright (C) 2021-2024, LAAS-CNRS, University of Edinburgh,
5 // University of Oxford, University of Trento,
6 // Heriot-Watt University
7 // Copyright note valid unless otherwise stated in individual files.
8 // All rights reserved.
10 
11 #ifndef CROCODDYL_CORE_INTEGRATED_ACTION_BASE_HPP_
12 #define CROCODDYL_CORE_INTEGRATED_ACTION_BASE_HPP_
13 
14 #include "crocoddyl/core/action-base.hpp"
15 #include "crocoddyl/core/control-base.hpp"
16 #include "crocoddyl/core/diff-action-base.hpp"
17 #include "crocoddyl/core/fwd.hpp"
18 #include "crocoddyl/core/utils/deprecate.hpp"
19 
20 namespace crocoddyl {
21 
40 template <typename _Scalar>
42  : public ActionModelAbstractTpl<_Scalar> {
43  public:
44  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
45 
46  typedef _Scalar Scalar;
55  typedef typename MathBase::VectorXs VectorXs;
56  typedef typename MathBase::MatrixXs MatrixXs;
57 
67  boost::shared_ptr<DifferentialActionModelAbstract> model,
68  boost::shared_ptr<ControlParametrizationModelAbstract> control,
69  const Scalar time_step = Scalar(1e-3),
70  const bool with_cost_residual = true);
71 
83  boost::shared_ptr<DifferentialActionModelAbstract> model,
84  const Scalar time_step = Scalar(1e-3),
85  const bool with_cost_residual = true);
87 
93  virtual boost::shared_ptr<ActionDataAbstract> createData();
94 
98  virtual std::size_t get_ng() const;
99 
103  virtual std::size_t get_nh() const;
104 
108  virtual std::size_t get_ng_T() const;
109 
113  virtual std::size_t get_nh_T() const;
114 
118  virtual const VectorXs& get_g_lb() const;
119 
123  virtual const VectorXs& get_g_ub() const;
124 
129  const boost::shared_ptr<DifferentialActionModelAbstract>& get_differential()
130  const;
131 
136  const boost::shared_ptr<ControlParametrizationModelAbstract>& get_control()
137  const;
138 
142  const Scalar get_dt() const;
143 
147  void set_dt(const Scalar dt);
148 
149  DEPRECATED("The DifferentialActionModel should be set at construction time",
150  void set_differential(
151  boost::shared_ptr<DifferentialActionModelAbstract> model));
152 
153  protected:
156  using Base::nr_;
157  using Base::nu_;
158  using Base::state_;
159  using Base::u_lb_;
160  using Base::u_ub_;
161 
162  void init();
163 
164  boost::shared_ptr<DifferentialActionModelAbstract>
166  boost::shared_ptr<ControlParametrizationModelAbstract>
168 
169  Scalar time_step_;
170  Scalar time_step2_;
171  bool
173 };
174 
175 template <typename _Scalar>
177  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
178 
179  typedef _Scalar Scalar;
182  typedef typename MathBase::VectorXs VectorXs;
183  typedef typename MathBase::MatrixXs MatrixXs;
184 
185  template <template <typename Scalar> class Model>
186  explicit IntegratedActionDataAbstractTpl(Model<Scalar>* const model)
187  : Base(model) {}
188  virtual ~IntegratedActionDataAbstractTpl() {}
189 
190  using Base::cost;
191  using Base::Fu;
192  using Base::Fx;
193  using Base::Lu;
194  using Base::Luu;
195  using Base::Lx;
196  using Base::Lxu;
197  using Base::Lxx;
198  using Base::r;
199  using Base::xnext;
200 };
201 
202 } // namespace crocoddyl
203 
204 /* --- Details -------------------------------------------------------------- */
205 /* --- Details -------------------------------------------------------------- */
206 /* --- Details -------------------------------------------------------------- */
207 #include "crocoddyl/core/integ-action-base.hxx"
208 
209 #endif // CROCODDYL_CORE_INTEGRATED_ACTION_BASE_HPP_
Abstract class for action model.
Definition: action-base.hpp:95
VectorXs u_lb_
Lower control limits.
VectorXs u_ub_
Upper control limits.
boost::shared_ptr< StateAbstract > state_
Model of the state.
std::size_t nu_
Control dimension.
std::size_t nr_
Dimension of the cost residual.
Abstract class for the control trajectory parametrization.
Abstract class for differential action model.
Abstract class for an integrated action model.
void init()
< Upper control limits
const Scalar get_dt() const
Return the time step used for the integration.
bool with_cost_residual_
Flag indicating whether a cost residual is used.
const boost::shared_ptr< ControlParametrizationModelAbstract > & get_control() const
Return the control parametrization model associated to this integrated action model.
virtual std::size_t get_ng() const
Return the number of inequality constraints.
Scalar time_step_
Time step used for integration.
virtual std::size_t get_nh() const
Return the number of equality constraints.
void set_dt(const Scalar dt)
Set the time step for the integration.
virtual const VectorXs & get_g_lb() const
Return the lower bound of the inequality constraints.
boost::shared_ptr< DifferentialActionModelAbstract > differential_
Differential action model that is integrated.
virtual std::size_t get_nh_T() const
Return the number of equality terminal constraints.
boost::shared_ptr< ControlParametrizationModelAbstract > control_
Model of the control parametrization.
IntegratedActionModelAbstractTpl(boost::shared_ptr< DifferentialActionModelAbstract > model, boost::shared_ptr< ControlParametrizationModelAbstract > control, const Scalar time_step=Scalar(1e-3), const bool with_cost_residual=true)
Initialize the integrator.
Scalar time_step2_
Square of the time step used for integration.
virtual std::size_t get_ng_T() const
Return the number of inequality terminal constraints.
virtual const VectorXs & get_g_ub() const
Return the upper bound of the inequality constraints.
IntegratedActionModelAbstractTpl(boost::shared_ptr< DifferentialActionModelAbstract > model, const Scalar time_step=Scalar(1e-3), const bool with_cost_residual=true)
Initialize the integrator.
const boost::shared_ptr< DifferentialActionModelAbstract > & get_differential() const
Return the differential action model associated to this integrated action model.
virtual boost::shared_ptr< ActionDataAbstract > createData()
Create the integrator data.
VectorXs xnext
evolution state
MatrixXs Fx
Jacobian of the dynamics w.r.t. the state .
MatrixXs Fu
Jacobian of the dynamics w.r.t. the control .
MatrixXs Luu
Hessian of the cost w.r.t. the control .
VectorXs Lx
Jacobian of the cost w.r.t. the state .
MatrixXs Lxx
Hessian of the cost w.r.t. the state .
VectorXs Lu
Jacobian of the cost w.r.t. the control .
VectorXs r
Cost residual.