Crocoddyl
diff-action.hpp
1 // BSD 3-Clause License
3 //
4 // Copyright (C) 2019-2023, LAAS-CNRS, University of Edinburgh,
5 // New York University, Max Planck Gesellschaft
6 // Heriot-Watt University
7 // Copyright note valid unless otherwise stated in individual files.
8 // All rights reserved.
10 
11 #ifndef CROCODDYL_CORE_NUMDIFF_DIFF_ACTION_HPP_
12 #define CROCODDYL_CORE_NUMDIFF_DIFF_ACTION_HPP_
13 
14 #include <iostream>
15 #include <vector>
16 
17 #include "crocoddyl/core/diff-action-base.hpp"
18 
19 namespace crocoddyl {
20 
46 template <typename _Scalar>
47 class DifferentialActionModelNumDiffTpl
48  : public DifferentialActionModelAbstractTpl<_Scalar> {
49  public:
50  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
51 
52  typedef _Scalar Scalar;
53  typedef MathBaseTpl<Scalar> MathBase;
54  typedef DifferentialActionModelAbstractTpl<Scalar> Base;
55  typedef DifferentialActionDataNumDiffTpl<Scalar> Data;
56  typedef DifferentialActionDataAbstractTpl<Scalar>
57  DifferentialActionDataAbstract;
58  typedef typename MathBase::VectorXs VectorXs;
59  typedef typename MathBase::MatrixXs MatrixXs;
60 
70  boost::shared_ptr<Base> model, const bool with_gauss_approx = false);
72 
76  virtual void calc(
77  const boost::shared_ptr<DifferentialActionDataAbstract>& data,
78  const Eigen::Ref<const VectorXs>& x, const Eigen::Ref<const VectorXs>& u);
79 
85  virtual void calc(
86  const boost::shared_ptr<DifferentialActionDataAbstract>& data,
87  const Eigen::Ref<const VectorXs>& x);
88 
92  virtual void calcDiff(
93  const boost::shared_ptr<DifferentialActionDataAbstract>& data,
94  const Eigen::Ref<const VectorXs>& x, const Eigen::Ref<const VectorXs>& u);
95 
101  virtual void calcDiff(
102  const boost::shared_ptr<DifferentialActionDataAbstract>& data,
103  const Eigen::Ref<const VectorXs>& x);
104 
108  virtual boost::shared_ptr<DifferentialActionDataAbstract> createData();
109 
113  virtual void quasiStatic(
114  const boost::shared_ptr<DifferentialActionDataAbstract>& data,
115  Eigen::Ref<VectorXs> u, const Eigen::Ref<const VectorXs>& x,
116  const std::size_t maxiter = 100, const Scalar tol = Scalar(1e-9));
117 
122  const boost::shared_ptr<Base>& get_model() const;
123 
128  const Scalar get_disturbance() const;
129 
134  void set_disturbance(const Scalar disturbance);
135 
139  bool get_with_gauss_approx();
140 
146  virtual void print(std::ostream& os) const;
147 
148  protected:
150  using Base::nr_;
152  using Base::nu_;
153  using Base::state_;
154  using Base::u_lb_;
155  using Base::u_ub_;
156  using Base::unone_;
157 
158  private:
159  void assertStableStateFD(const Eigen::Ref<const VectorXs>& x);
160  boost::shared_ptr<Base> model_;
161  bool with_gauss_approx_;
162  Scalar e_jac_;
163  Scalar e_hess_;
165 };
167 
168 template <typename _Scalar>
169 struct DifferentialActionDataNumDiffTpl
170  : public DifferentialActionDataAbstractTpl<_Scalar> {
171  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
172 
173  typedef _Scalar Scalar;
174  typedef MathBaseTpl<Scalar> MathBase;
175  typedef DifferentialActionDataAbstractTpl<Scalar> Base;
176  typedef typename MathBase::VectorXs VectorXs;
177  typedef typename MathBase::MatrixXs MatrixXs;
178 
185  template <template <typename Scalar> class Model>
186  explicit DifferentialActionDataNumDiffTpl(Model<Scalar>* const model)
187  : Base(model),
188  Rx(model->get_model()->get_nr(),
189  model->get_model()->get_state()->get_ndx()),
190  Ru(model->get_model()->get_nr(), model->get_model()->get_nu()),
191  dx(model->get_model()->get_state()->get_ndx()),
192  du(model->get_model()->get_nu()),
193  xp(model->get_model()->get_state()->get_nx()) {
194  Rx.setZero();
195  Ru.setZero();
196  dx.setZero();
197  du.setZero();
198  xp.setZero();
199 
200  const std::size_t ndx = model->get_model()->get_state()->get_ndx();
201  const std::size_t nu = model->get_model()->get_nu();
202  data_0 = model->get_model()->createData();
203  for (std::size_t i = 0; i < ndx; ++i) {
204  data_x.push_back(model->get_model()->createData());
205  }
206  for (std::size_t i = 0; i < nu; ++i) {
207  data_u.push_back(model->get_model()->createData());
208  }
209  }
210 
211  Scalar x_norm;
212  Scalar
214  Scalar
216  Scalar xh_hess;
217  Scalar uh_hess;
219  Scalar xh_hess_pow2;
221  Scalar uh_hess_pow2;
222  Scalar xuh_hess_pow2;
223  MatrixXs Rx;
224  MatrixXs Ru;
225  VectorXs dx;
226  VectorXs du;
227  VectorXs xp;
228  boost::shared_ptr<Base> data_0;
229  std::vector<boost::shared_ptr<Base> > data_x;
230  std::vector<boost::shared_ptr<Base> > data_u;
231 
232  using Base::cost;
233  using Base::Fu;
234  using Base::Fx;
235  using Base::g;
236  using Base::Gu;
237  using Base::Gx;
238  using Base::h;
239  using Base::Hu;
240  using Base::Hx;
241  using Base::Lu;
242  using Base::Luu;
243  using Base::Lx;
244  using Base::Lxu;
245  using Base::Lxx;
246  using Base::r;
247  using Base::xout;
248 };
249 
250 } // namespace crocoddyl
251 
252 /* --- Details -------------------------------------------------------------- */
253 /* --- Details -------------------------------------------------------------- */
254 /* --- Details -------------------------------------------------------------- */
255 #include "crocoddyl/core/numdiff/diff-action.hxx"
256 
257 #endif // CROCODDYL_CORE_NUMDIFF_DIFF_ACTION_HPP_
crocoddyl::DifferentialActionDataAbstractTpl::Lxu
MatrixXs Lxu
Definition: diff-action-base.hpp:424
crocoddyl::DifferentialActionModelNumDiffTpl::quasiStatic
virtual void quasiStatic(const boost::shared_ptr< DifferentialActionDataAbstract > &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::DifferentialActionModelAbstractTpl::nr_
std::size_t nr_
Dimension of the cost residual.
Definition: diff-action-base.hpp:346
crocoddyl::DifferentialActionModelNumDiffTpl::set_disturbance
void set_disturbance(const Scalar disturbance)
Modify the disturbance constant used in the numerical differentiation routine.
crocoddyl::DifferentialActionDataAbstractTpl::g
VectorXs g
Inequality constraint values.
Definition: diff-action-base.hpp:427
crocoddyl::DifferentialActionModelNumDiffTpl::print
virtual void print(std::ostream &os) const
Print relevant information of the action numdiff model.
crocoddyl::DifferentialActionDataAbstractTpl::h
VectorXs h
Equality constraint values.
Definition: diff-action-base.hpp:432
crocoddyl::DifferentialActionModelNumDiffTpl::get_model
const boost::shared_ptr< Base > & get_model() const
Return the differential acton model that we use to numerical differentiate.
crocoddyl::DifferentialActionDataAbstractTpl::Lx
VectorXs Lx
Jacobian of the cost w.r.t. the state .
Definition: diff-action-base.hpp:421
crocoddyl::DifferentialActionDataNumDiffTpl::uh_jac
Scalar uh_jac
Disturbance value used for computing .
Definition: diff-action.hpp:215
crocoddyl::DifferentialActionModelAbstractTpl::has_control_limits_
bool has_control_limits_
Definition: diff-action-base.hpp:355
crocoddyl::DifferentialActionDataAbstractTpl::Hu
MatrixXs Hu
Definition: diff-action-base.hpp:435
crocoddyl::DifferentialActionDataNumDiffTpl::uh_hess
Scalar uh_hess
Definition: diff-action.hpp:218
crocoddyl::DifferentialActionDataAbstractTpl::Lu
VectorXs Lu
Jacobian of the cost w.r.t. the control .
Definition: diff-action-base.hpp:422
crocoddyl::DifferentialActionModelAbstractTpl::unone_
VectorXs unone_
Neutral state.
Definition: diff-action-base.hpp:350
crocoddyl::DifferentialActionModelNumDiffTpl::calc
virtual void calc(const boost::shared_ptr< DifferentialActionDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u)
Compute the system acceleration and cost value.
crocoddyl::DifferentialActionDataAbstractTpl::Fx
MatrixXs Fx
Jacobian of the dynamics w.r.t. the state .
Definition: diff-action-base.hpp:417
crocoddyl::DifferentialActionDataAbstractTpl::xout
VectorXs xout
evolution state
Definition: diff-action-base.hpp:416
crocoddyl::DifferentialActionModelAbstractTpl::nu_
std::size_t nu_
Control dimension.
Definition: diff-action-base.hpp:345
crocoddyl::DifferentialActionModelNumDiffTpl::get_with_gauss_approx
bool get_with_gauss_approx()
Identify if the Gauss approximation is going to be used or not.
crocoddyl::DifferentialActionModelNumDiffTpl::DifferentialActionModelNumDiffTpl
DifferentialActionModelNumDiffTpl(boost::shared_ptr< Base > model, const bool with_gauss_approx=false)
Initialize the numdiff differential action model.
crocoddyl::DifferentialActionModelNumDiffTpl::calcDiff
virtual void calcDiff(const boost::shared_ptr< DifferentialActionDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u)
Compute the derivatives of the dynamics and cost functions.
crocoddyl::DifferentialActionDataAbstractTpl::Gu
MatrixXs Gu
Definition: diff-action-base.hpp:430
crocoddyl::DifferentialActionDataAbstractTpl::r
VectorXs r
Cost residual.
Definition: diff-action-base.hpp:420
crocoddyl::DifferentialActionDataAbstractTpl
Definition: diff-action-base.hpp:371
crocoddyl::DifferentialActionModelNumDiffTpl::get_disturbance
const Scalar get_disturbance() const
Return the disturbance constant used in the numerical differentiation routine.
crocoddyl::DifferentialActionModelAbstractTpl::state_
boost::shared_ptr< StateAbstract > state_
Model of the state.
Definition: diff-action-base.hpp:349
crocoddyl::DifferentialActionDataAbstractTpl::Luu
MatrixXs Luu
Hessian of the cost w.r.t. the control .
Definition: diff-action-base.hpp:426
crocoddyl::DifferentialActionModelNumDiffTpl::createData
virtual boost::shared_ptr< DifferentialActionDataAbstract > createData()
Create the differential action data.
crocoddyl::DifferentialActionDataNumDiffTpl::xh_hess
Scalar xh_hess
Definition: diff-action.hpp:216
crocoddyl::DifferentialActionDataAbstractTpl::Gx
MatrixXs Gx
Definition: diff-action-base.hpp:428
crocoddyl::DifferentialActionDataNumDiffTpl::x_norm
Scalar x_norm
Norm of the state vector.
Definition: diff-action.hpp:211
crocoddyl::DifferentialActionDataAbstractTpl::Hx
MatrixXs Hx
Definition: diff-action-base.hpp:433
crocoddyl::DifferentialActionDataAbstractTpl::Lxx
MatrixXs Lxx
Hessian of the cost w.r.t. the state .
Definition: diff-action-base.hpp:423
crocoddyl::DifferentialActionDataNumDiffTpl::xh_jac
Scalar xh_jac
Disturbance value used for computing .
Definition: diff-action.hpp:213
crocoddyl::DifferentialActionDataAbstractTpl::cost
Scalar cost
cost value
Definition: diff-action-base.hpp:415
crocoddyl::DifferentialActionDataNumDiffTpl::DifferentialActionDataNumDiffTpl
DifferentialActionDataNumDiffTpl(Model< Scalar > *const model)
Construct a new ActionDataNumDiff object.
Definition: diff-action.hpp:186
crocoddyl::DifferentialActionDataAbstractTpl::Fu
MatrixXs Fu
Jacobian of the dynamics w.r.t. the control .
Definition: diff-action-base.hpp:419
crocoddyl::DifferentialActionModelAbstractTpl::u_lb_
VectorXs u_lb_
Lower control limits.
Definition: diff-action-base.hpp:353
crocoddyl::DifferentialActionModelAbstractTpl::u_ub_
VectorXs u_ub_
Upper control limits.
Definition: diff-action-base.hpp:354