Crocoddyl
action.hpp
1 // BSD 3-Clause License
3 //
4 // Copyright (C) 2019-2023, LAAS-CNRS, New York University,
5 // Max Planck Gesellschaft, University of Edinburgh
6 // Copyright note valid unless otherwise stated in individual files.
7 // All rights reserved.
9 
10 #ifndef CROCODDYL_CORE_NUMDIFF_ACTION_HPP_
11 #define CROCODDYL_CORE_NUMDIFF_ACTION_HPP_
12 
13 #include <vector>
14 
15 #include "crocoddyl/core/action-base.hpp"
16 #include "crocoddyl/core/fwd.hpp"
17 
18 namespace crocoddyl {
19 
44 template <typename _Scalar>
45 class ActionModelNumDiffTpl : public ActionModelAbstractTpl<_Scalar> {
46  public:
47  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
48 
49  typedef _Scalar Scalar;
50  typedef ActionDataAbstractTpl<Scalar> ActionDataAbstract;
51  typedef ActionModelAbstractTpl<Scalar> Base;
52  typedef ActionDataNumDiffTpl<Scalar> Data;
53  typedef MathBaseTpl<Scalar> MathBase;
54  typedef typename MathBaseTpl<Scalar>::VectorXs VectorXs;
55  typedef typename MathBaseTpl<Scalar>::MatrixXs MatrixXs;
56 
65  explicit ActionModelNumDiffTpl(boost::shared_ptr<Base> model,
66  bool with_gauss_approx = false);
67  virtual ~ActionModelNumDiffTpl();
68 
72  virtual void calc(const boost::shared_ptr<ActionDataAbstract>& data,
73  const Eigen::Ref<const VectorXs>& x,
74  const Eigen::Ref<const VectorXs>& u);
75 
80  virtual void calc(const boost::shared_ptr<ActionDataAbstract>& data,
81  const Eigen::Ref<const VectorXs>& x);
82 
86  virtual void calcDiff(const boost::shared_ptr<ActionDataAbstract>& data,
87  const Eigen::Ref<const VectorXs>& x,
88  const Eigen::Ref<const VectorXs>& u);
89 
94  virtual void calcDiff(const boost::shared_ptr<ActionDataAbstract>& data,
95  const Eigen::Ref<const VectorXs>& x);
96 
100  virtual boost::shared_ptr<ActionDataAbstract> createData();
101 
105  virtual void quasiStatic(const boost::shared_ptr<ActionDataAbstract>& data,
106  Eigen::Ref<VectorXs> u,
107  const Eigen::Ref<const VectorXs>& x,
108  const std::size_t maxiter = 100,
109  const Scalar tol = Scalar(1e-9));
110 
114  const boost::shared_ptr<Base>& get_model() const;
115 
120  const Scalar get_disturbance() const;
121 
126  void set_disturbance(const Scalar disturbance);
127 
131  bool get_with_gauss_approx();
132 
138  virtual void print(std::ostream& os) const;
139 
140  protected:
142  using Base::nr_;
144  using Base::nu_;
145  using Base::state_;
146  using Base::u_lb_;
147  using Base::u_ub_;
148  using Base::unone_;
149 
150  private:
162  void assertStableStateFD(const Eigen::Ref<const VectorXs>& x);
163 
164  boost::shared_ptr<Base> model_;
165  Scalar e_jac_;
167  Scalar e_hess_;
169  bool with_gauss_approx_;
171 };
173 
174 template <typename _Scalar>
175 struct ActionDataNumDiffTpl : public ActionDataAbstractTpl<_Scalar> {
176  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
177 
178  typedef _Scalar Scalar;
179  typedef MathBaseTpl<Scalar> MathBase;
180  typedef ActionDataAbstractTpl<Scalar> Base;
181  typedef typename MathBaseTpl<Scalar>::VectorXs VectorXs;
182  typedef typename MathBaseTpl<Scalar>::MatrixXs MatrixXs;
183 
190  template <template <typename Scalar> class Model>
191  explicit ActionDataNumDiffTpl(Model<Scalar>* const model)
192  : Base(model),
193  Rx(model->get_model()->get_nr(),
194  model->get_model()->get_state()->get_ndx()),
195  Ru(model->get_model()->get_nr(), model->get_model()->get_nu()),
196  dx(model->get_model()->get_state()->get_ndx()),
197  du(model->get_model()->get_nu()),
198  xp(model->get_model()->get_state()->get_nx()) {
199  Rx.setZero();
200  Ru.setZero();
201  dx.setZero();
202  du.setZero();
203  xp.setZero();
204 
205  const std::size_t ndx = model->get_model()->get_state()->get_ndx();
206  const std::size_t nu = model->get_model()->get_nu();
207  data_0 = model->get_model()->createData();
208  for (std::size_t i = 0; i < ndx; ++i) {
209  data_x.push_back(model->get_model()->createData());
210  }
211  for (std::size_t i = 0; i < nu; ++i) {
212  data_u.push_back(model->get_model()->createData());
213  }
214  }
215 
216  using Base::cost;
217  using Base::Fu;
218  using Base::Fx;
219  using Base::Lu;
220  using Base::Luu;
221  using Base::Lx;
222  using Base::Lxu;
223  using Base::Lxx;
224  using Base::r;
225  using Base::xnext;
226 
227  Scalar x_norm;
228  Scalar
230  Scalar
232  Scalar xh_hess;
233  Scalar uh_hess;
235  Scalar xh_hess_pow2;
237  Scalar uh_hess_pow2;
238  Scalar xuh_hess_pow2;
239  MatrixXs Rx;
240  MatrixXs Ru;
241  VectorXs dx;
242  VectorXs du;
243  VectorXs xp;
244  boost::shared_ptr<Base> data_0;
246  std::vector<boost::shared_ptr<Base> >
248  std::vector<boost::shared_ptr<Base> >
250 };
251 
252 } // namespace crocoddyl
253 
254 /* --- Details -------------------------------------------------------------- */
255 /* --- Details -------------------------------------------------------------- */
256 /* --- Details -------------------------------------------------------------- */
257 #include "crocoddyl/core/numdiff/action.hxx"
258 
259 #endif // CROCODDYL_CORE_NUMDIFF_ACTION_HPP_
crocoddyl::ActionDataAbstractTpl
Definition: action-base.hpp:329
crocoddyl::ActionModelNumDiffTpl::ActionModelNumDiffTpl
ActionModelNumDiffTpl(boost::shared_ptr< Base > model, bool with_gauss_approx=false)
Initialize the numdiff action model.
crocoddyl::ActionModelAbstractTpl::has_control_limits_
bool has_control_limits_
Definition: action-base.hpp:315
crocoddyl::ActionModelNumDiffTpl::calcDiff
virtual void calcDiff(const boost::shared_ptr< ActionDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u)
Compute the derivatives of the dynamics and cost functions.
crocoddyl::ActionDataAbstractTpl::Lxu
MatrixXs Lxu
Definition: action-base.hpp:382
crocoddyl::ActionDataNumDiffTpl::data_x
std::vector< boost::shared_ptr< Base > > data_x
The temporary data associated with the state variation.
Definition: action.hpp:247
crocoddyl::ActionModelNumDiffTpl::print
virtual void print(std::ostream &os) const
Print relevant information of the diff-action numdiff model.
crocoddyl::ActionDataNumDiffTpl::data_u
std::vector< boost::shared_ptr< Base > > data_u
The temporary data associated with the control variation.
Definition: action.hpp:249
crocoddyl::ActionDataNumDiffTpl::Rx
MatrixXs Rx
Cost residual jacobian: .
Definition: action.hpp:239
crocoddyl::ActionModelNumDiffTpl::set_disturbance
void set_disturbance(const Scalar disturbance)
Modify the disturbance constant used in the numerical differentiation routine.
crocoddyl::ActionModelAbstractTpl::nu_
std::size_t nu_
Control dimension.
Definition: action-base.hpp:305
crocoddyl::ActionDataAbstractTpl::Lx
VectorXs Lx
Jacobian of the cost w.r.t. the state .
Definition: action-base.hpp:379
crocoddyl::ActionDataNumDiffTpl::du
VectorXs du
Control disturbance.
Definition: action.hpp:242
crocoddyl::ActionModelNumDiffTpl::quasiStatic
virtual void quasiStatic(const boost::shared_ptr< ActionDataAbstract > &data, Eigen::Ref< VectorXs > u, const Eigen::Ref< const VectorXs > &x, const std::size_t maxiter=100, const Scalar tol=Scalar(1e-9))
Computes the quasic static commands.
crocoddyl::ActionModelNumDiffTpl::get_with_gauss_approx
bool get_with_gauss_approx()
Identify if the Gauss approximation is going to be used or not.
crocoddyl::ActionDataAbstractTpl::xnext
VectorXs xnext
evolution state
Definition: action-base.hpp:374
crocoddyl::ActionDataNumDiffTpl::xh_hess
Scalar xh_hess
Definition: action.hpp:232
crocoddyl::ActionModelNumDiffTpl::createData
virtual boost::shared_ptr< ActionDataAbstract > createData()
Create the action data.
crocoddyl::ActionDataAbstractTpl::cost
Scalar cost
cost value
Definition: action-base.hpp:373
crocoddyl::ActionDataNumDiffTpl::ActionDataNumDiffTpl
ActionDataNumDiffTpl(Model< Scalar > *const model)
Initialize the numdiff action data.
Definition: action.hpp:191
crocoddyl::ActionDataNumDiffTpl::uh_hess
Scalar uh_hess
Definition: action.hpp:234
crocoddyl::ActionDataNumDiffTpl::dx
VectorXs dx
State disturbance.
Definition: action.hpp:241
crocoddyl::ActionDataAbstractTpl::r
VectorXs r
Cost residual.
Definition: action-base.hpp:378
crocoddyl::ActionModelAbstractTpl::state_
boost::shared_ptr< StateAbstract > state_
Model of the state.
Definition: action-base.hpp:309
crocoddyl::ActionModelAbstractTpl::unone_
VectorXs unone_
Neutral state.
Definition: action-base.hpp:310
crocoddyl::ActionDataNumDiffTpl::x_norm
Scalar x_norm
Norm of the state vector.
Definition: action.hpp:227
crocoddyl::ActionModelNumDiffTpl::get_model
const boost::shared_ptr< Base > & get_model() const
Return the acton model that we use to numerical differentiate.
crocoddyl::ActionDataAbstractTpl::Fx
MatrixXs Fx
Jacobian of the dynamics w.r.t. the state .
Definition: action-base.hpp:375
crocoddyl::ActionModelNumDiffTpl::calc
virtual void calc(const boost::shared_ptr< ActionDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u)
Compute the next state and cost value.
crocoddyl::ActionModelAbstractTpl::u_lb_
VectorXs u_lb_
Lower control limits.
Definition: action-base.hpp:313
crocoddyl::ActionDataNumDiffTpl::uh_jac
Scalar uh_jac
Disturbance value used for computing .
Definition: action.hpp:231
crocoddyl::ActionModelAbstractTpl::u_ub_
VectorXs u_ub_
Upper control limits.
Definition: action-base.hpp:314
crocoddyl::ActionDataNumDiffTpl::Ru
MatrixXs Ru
Cost residual jacobian: .
Definition: action.hpp:240
crocoddyl::ActionDataNumDiffTpl::xh_jac
Scalar xh_jac
Disturbance value used for computing .
Definition: action.hpp:229
crocoddyl::ActionDataAbstractTpl::Lu
VectorXs Lu
Jacobian of the cost w.r.t. the control .
Definition: action-base.hpp:380
crocoddyl::ActionModelNumDiffTpl::get_disturbance
const Scalar get_disturbance() const
Return the disturbance constant used in the numerical differentiation routine.
crocoddyl::ActionDataAbstractTpl::Lxx
MatrixXs Lxx
Hessian of the cost w.r.t. the state .
Definition: action-base.hpp:381
crocoddyl::ActionDataAbstractTpl::Fu
MatrixXs Fu
Jacobian of the dynamics w.r.t. the control .
Definition: action-base.hpp:377
crocoddyl::ActionModelAbstractTpl::nr_
std::size_t nr_
Dimension of the cost residual.
Definition: action-base.hpp:306
crocoddyl::ActionDataAbstractTpl::Luu
MatrixXs Luu
Hessian of the cost w.r.t. the control .
Definition: action-base.hpp:384
crocoddyl::ActionDataNumDiffTpl::xp
VectorXs xp
Definition: action.hpp:243
crocoddyl::ActionDataNumDiffTpl::data_0
boost::shared_ptr< Base > data_0
The data that contains the final results.
Definition: action.hpp:245