Crocoddyl
shooting.hpp
1 // BSD 3-Clause License
3 //
4 // Copyright (C) 2019-2021, LAAS-CNRS, University of Edinburgh, University of
5 // Oxford Copyright note valid unless otherwise stated in individual files. All
6 // rights reserved.
8 
9 #ifndef CROCODDYL_CORE_OPTCTRL_SHOOTING_HPP_
10 #define CROCODDYL_CORE_OPTCTRL_SHOOTING_HPP_
11 
12 #include <stdexcept>
13 #include <vector>
14 
15 #include "crocoddyl/core/action-base.hpp"
16 #include "crocoddyl/core/fwd.hpp"
17 #include "crocoddyl/core/utils/deprecate.hpp"
18 #include "crocoddyl/core/utils/exception.hpp"
19 
20 namespace crocoddyl {
21 
34 template <typename _Scalar>
36  public:
37  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
38 
39  typedef _Scalar Scalar;
43  typedef typename MathBase::VectorXs VectorXs;
44 
53  const VectorXs& x0,
54  const std::vector<std::shared_ptr<ActionModelAbstract> >& running_models,
55  std::shared_ptr<ActionModelAbstract> terminal_model);
56 
67  const VectorXs& x0,
68  const std::vector<std::shared_ptr<ActionModelAbstract> >& running_models,
69  std::shared_ptr<ActionModelAbstract> terminal_model,
70  const std::vector<std::shared_ptr<ActionDataAbstract> >& running_datas,
71  std::shared_ptr<ActionDataAbstract> terminal_data);
77 
91  Scalar calc(const std::vector<VectorXs>& xs, const std::vector<VectorXs>& us);
92 
109  Scalar calcDiff(const std::vector<VectorXs>& xs,
110  const std::vector<VectorXs>& us);
111 
120  void rollout(const std::vector<VectorXs>& us, std::vector<VectorXs>& xs);
121 
130  std::vector<VectorXs> rollout_us(const std::vector<VectorXs>& us);
131 
140  void quasiStatic(std::vector<VectorXs>& us, const std::vector<VectorXs>& xs);
141 
150  std::vector<VectorXs> quasiStatic_xs(const std::vector<VectorXs>& xs);
151 
161  void circularAppend(std::shared_ptr<ActionModelAbstract> model,
162  std::shared_ptr<ActionDataAbstract> data);
163 
173  void circularAppend(std::shared_ptr<ActionModelAbstract> model);
174 
182  void updateNode(const std::size_t i,
183  std::shared_ptr<ActionModelAbstract> model,
184  std::shared_ptr<ActionDataAbstract> data);
185 
192  void updateModel(const std::size_t i,
193  std::shared_ptr<ActionModelAbstract> model);
194 
198  std::size_t get_T() const;
199 
203  const VectorXs& get_x0() const;
204 
208  const std::vector<std::shared_ptr<ActionModelAbstract> >& get_runningModels()
209  const;
210 
214  const std::shared_ptr<ActionModelAbstract>& get_terminalModel() const;
215 
219  const std::vector<std::shared_ptr<ActionDataAbstract> >& get_runningDatas()
220  const;
221 
225  const std::shared_ptr<ActionDataAbstract>& get_terminalData() const;
226 
230  void set_x0(const VectorXs& x0_in);
231 
236  const std::vector<std::shared_ptr<ActionModelAbstract> >& models);
237 
241  void set_terminalModel(std::shared_ptr<ActionModelAbstract> model);
242 
249  void set_nthreads(const int nthreads);
250 
254  std::size_t get_nx() const;
255 
259  std::size_t get_ndx() const;
260 
264  DEPRECATED("Compute yourself the maximum dimension of the control vector",
265  std::size_t get_nu_max() const;)
266 
270  std::size_t get_nthreads() const;
271 
276  bool is_updated();
277 
281  template <class Scalar>
282  friend std::ostream& operator<<(std::ostream& os,
283  const ShootingProblemTpl<Scalar>& problem);
284 
285  protected:
286  Scalar cost_;
287  std::size_t T_;
288  VectorXs x0_;
289  std::shared_ptr<ActionModelAbstract>
291  std::shared_ptr<ActionDataAbstract> terminal_data_;
292  std::vector<std::shared_ptr<ActionModelAbstract> >
294  std::vector<std::shared_ptr<ActionDataAbstract> >
296  std::size_t nx_;
297  std::size_t ndx_;
298  std::size_t nu_max_;
299  std::size_t nthreads_;
301  bool is_updated_;
302 
303  private:
304  void allocateData();
305 };
306 
307 } // namespace crocoddyl
308 
309 /* --- Details -------------------------------------------------------------- */
310 /* --- Details -------------------------------------------------------------- */
311 /* --- Details -------------------------------------------------------------- */
312 #include "crocoddyl/core/optctrl/shooting.hxx"
313 
314 #endif // CROCODDYL_CORE_OPTCTRL_SHOOTING_HPP_
Abstract class for action model.
Definition: action-base.hpp:95
This class encapsulates a shooting problem.
Definition: shooting.hpp:35
void circularAppend(std::shared_ptr< ActionModelAbstract > model, std::shared_ptr< ActionDataAbstract > data)
Circular append of the model and data onto the end running node.
void set_terminalModel(std::shared_ptr< ActionModelAbstract > model)
Modify the terminal model and allocate new data.
std::vector< VectorXs > quasiStatic_xs(const std::vector< VectorXs > &xs)
Compute the quasic static commands given a state trajectory.
Scalar calcDiff(const std::vector< VectorXs > &xs, const std::vector< VectorXs > &us)
Compute the derivatives of the cost and dynamics.
void quasiStatic(std::vector< VectorXs > &us, const std::vector< VectorXs > &xs)
Compute the quasic static commands given a state trajectory.
void updateNode(const std::size_t i, std::shared_ptr< ActionModelAbstract > model, std::shared_ptr< ActionDataAbstract > data)
Update the model and data for a specific node.
std::shared_ptr< ActionModelAbstract > terminal_model_
Terminal action model.
Definition: shooting.hpp:290
void rollout(const std::vector< VectorXs > &us, std::vector< VectorXs > &xs)
Integrate the dynamics given a control sequence.
std::vector< VectorXs > rollout_us(const std::vector< VectorXs > &us)
Integrate the dynamics given a control sequence.
const std::vector< std::shared_ptr< ActionModelAbstract > > & get_runningModels() const
Return the running models.
std::size_t get_ndx() const
Return the dimension of the tangent space of the state manifold.
void updateModel(const std::size_t i, std::shared_ptr< ActionModelAbstract > model)
Update a model and allocated new data for a specific node.
void set_runningModels(const std::vector< std::shared_ptr< ActionModelAbstract > > &models)
Modify the running models and allocate new data.
std::size_t nx_
State dimension.
Definition: shooting.hpp:296
Scalar calc(const std::vector< VectorXs > &xs, const std::vector< VectorXs > &us)
Compute the cost and the next states.
ShootingProblemTpl(const ShootingProblemTpl< Scalar > &problem)
Initialize the shooting problem.
std::size_t T_
number of running nodes
Definition: shooting.hpp:287
void circularAppend(std::shared_ptr< ActionModelAbstract > model)
Circular append of the model and data onto the end running node.
const std::shared_ptr< ActionModelAbstract > & get_terminalModel() const
Return the terminal model.
friend std::ostream & operator<<(std::ostream &os, const ShootingProblemTpl< Scalar > &problem)
Print information on the 'ShootingProblem'.
void set_x0(const VectorXs &x0_in)
Modify the initial state.
std::vector< std::shared_ptr< ActionModelAbstract > > running_models_
Running action model.
Definition: shooting.hpp:293
Scalar cost_
Total cost.
Definition: shooting.hpp:286
const std::vector< std::shared_ptr< ActionDataAbstract > > & get_runningDatas() const
Return the running datas.
std::vector< std::shared_ptr< ActionDataAbstract > > running_datas_
Running action data.
Definition: shooting.hpp:295
void set_nthreads(const int nthreads)
Modify the number of threads using with multithreading support.
std::size_t get_T() const
Return the number of running nodes.
DEPRECATED("Compute yourself the maximum dimension of the control vector", std::size_t get_nu_max() const ;) std bool is_updated()
Return the maximum dimension of the control vector.
ShootingProblemTpl(const VectorXs &x0, const std::vector< std::shared_ptr< ActionModelAbstract > > &running_models, std::shared_ptr< ActionModelAbstract > terminal_model)
Initialize the shooting problem and allocate its data.
ShootingProblemTpl(const VectorXs &x0, const std::vector< std::shared_ptr< ActionModelAbstract > > &running_models, std::shared_ptr< ActionModelAbstract > terminal_model, const std::vector< std::shared_ptr< ActionDataAbstract > > &running_datas, std::shared_ptr< ActionDataAbstract > terminal_data)
Initialize the shooting problem (models and datas)
const std::shared_ptr< ActionDataAbstract > & get_terminalData() const
Return the terminal data.
std::shared_ptr< ActionDataAbstract > terminal_data_
Terminal action data.
Definition: shooting.hpp:291
std::size_t get_nx() const
Return the dimension of the state tuple.
VectorXs x0_
Initial state.
Definition: shooting.hpp:288
std::size_t nu_max_
Maximum control dimension.
Definition: shooting.hpp:298
const VectorXs & get_x0() const
Return the initial state.
std::size_t ndx_
State rate dimension.
Definition: shooting.hpp:297