actuation-base.hpp

// BSD 3-Clause License
//
// Copyright (C) 2019-2025, LAAS-CNRS, University of Edinburgh,
//                          Heriot-Watt University
// Copyright note valid unless otherwise stated in individual files.
// All rights reserved.
 
#ifndef CROCODDYL_CORE_ACTUATION_BASE_HPP_
#define CROCODDYL_CORE_ACTUATION_BASE_HPP_
 
#include "crocoddyl/core/fwd.hpp"
#include "crocoddyl/core/state-base.hpp"
 
namespace crocoddyl {
 
class ActuationModelBase {
 public:
  virtual ~ActuationModelBase() = default;
 
  CROCODDYL_BASE_CAST(ActuationModelBase, ActuationModelAbstractTpl)
};
 
template <typename _Scalar>
class ActuationModelAbstractTpl : public ActuationModelBase {
 public:
  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
 
  typedef _Scalar Scalar;
  typedef MathBaseTpl<Scalar> MathBase;
  typedef StateAbstractTpl<Scalar> StateAbstract;
  typedef ActuationDataAbstractTpl<Scalar> ActuationDataAbstract;
  typedef typename MathBase::VectorXs VectorXs;
  typedef typename MathBase::MatrixXs MatrixXs;
 
  ActuationModelAbstractTpl(std::shared_ptr<StateAbstract> state,
                            const std::size_t nu);
  virtual ~ActuationModelAbstractTpl() = default;
 
  virtual void calc(const std::shared_ptr<ActuationDataAbstract>& data,
                    const Eigen::Ref<const VectorXs>& x,
                    const Eigen::Ref<const VectorXs>& u) = 0;
 
  void calc(const std::shared_ptr<ActuationDataAbstract>& data,
            const Eigen::Ref<const VectorXs>& x);
 
  virtual void calcDiff(const std::shared_ptr<ActuationDataAbstract>& data,
                        const Eigen::Ref<const VectorXs>& x,
                        const Eigen::Ref<const VectorXs>& u) = 0;
 
  void calcDiff(const std::shared_ptr<ActuationDataAbstract>& data,
                const Eigen::Ref<const VectorXs>& x);
 
  virtual void commands(const std::shared_ptr<ActuationDataAbstract>& data,
                        const Eigen::Ref<const VectorXs>& x,
                        const Eigen::Ref<const VectorXs>& tau) = 0;
 
  virtual void torqueTransform(
      const std::shared_ptr<ActuationDataAbstract>& data,
      const Eigen::Ref<const VectorXs>& x, const Eigen::Ref<const VectorXs>& u);
  virtual std::shared_ptr<ActuationDataAbstract> createData();
 
  std::size_t get_nu() const;
 
  const std::shared_ptr<StateAbstract>& get_state() const;
 
  template <class Scalar>
  friend std::ostream& operator<<(
      std::ostream& os, const ActuationModelAbstractTpl<Scalar>& model);
 
  virtual void print(std::ostream& os) const;
 
 protected:
  std::size_t nu_;                        
  std::shared_ptr<StateAbstract> state_;  
  ActuationModelAbstractTpl() : nu_(0), state_(nullptr) {};
};
 
template <typename _Scalar>
struct ActuationDataAbstractTpl {
  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
 
  typedef _Scalar Scalar;
  typedef MathBaseTpl<Scalar> MathBase;
  typedef typename MathBase::VectorXs VectorXs;
  typedef typename MathBase::MatrixXs MatrixXs;
 
  template <template <typename Scalar> class Model>
  explicit ActuationDataAbstractTpl(Model<Scalar>* const model)
      : tau(model->get_state()->get_nv()),
        u(model->get_nu()),
        dtau_dx(model->get_state()->get_nv(), model->get_state()->get_ndx()),
        dtau_du(model->get_state()->get_nv(), model->get_nu()),
        Mtau(model->get_nu(), model->get_state()->get_nv()),
        tau_set(model->get_state()->get_nv(), true) {
    tau.setZero();
    u.setZero();
    dtau_dx.setZero();
    dtau_du.setZero();
    Mtau.setZero();
  }
  virtual ~ActuationDataAbstractTpl() = default;
 
  VectorXs tau;      
  VectorXs u;        
  MatrixXs dtau_dx;  
  MatrixXs dtau_du;  
  MatrixXs Mtau;  
  std::vector<bool> tau_set;  
};
 
}  // namespace crocoddyl
 
/* --- Details -------------------------------------------------------------- */
/* --- Details -------------------------------------------------------------- */
/* --- Details -------------------------------------------------------------- */
#include "crocoddyl/core/actuation-base.hxx"
 
CROCODDYL_DECLARE_EXTERN_TEMPLATE_CLASS(crocoddyl::ActuationModelAbstractTpl)
CROCODDYL_DECLARE_EXTERN_TEMPLATE_STRUCT(crocoddyl::ActuationDataAbstractTpl)
 
#endif  // CROCODDYL_CORE_ACTUATION_BASE_HPP_