frame-translation.hpp

// BSD 3-Clause License
//
// Copyright (C) 2021-2025, LAAS-CNRS, University of Edinburgh,
// Heriot-Watt University
// Copyright note valid unless otherwise stated in individual files.
// All rights reserved.

#ifndef CROCODDYL_MULTIBODY_RESIDUALS_FRAME_TRANSLATION_HPP_
#define CROCODDYL_MULTIBODY_RESIDUALS_FRAME_TRANSLATION_HPP_

#include "crocoddyl/core/residual-base.hpp"
#include "crocoddyl/multibody/data/multibody.hpp"
#include "crocoddyl/multibody/fwd.hpp"
#include "crocoddyl/multibody/states/multibody.hpp"

namespace crocoddyl {

template <typename _Scalar>
class ResidualModelFrameTranslationTpl
 : public ResidualModelAbstractTpl<_Scalar> {
 public:
 EIGEN_MAKE_ALIGNED_OPERATOR_NEW
 CROCODDYL_DERIVED_CAST(ResidualModelBase, ResidualModelFrameTranslationTpl)

 typedef _Scalar Scalar;
 typedef MathBaseTpl<Scalar> MathBase;
 typedef ResidualModelAbstractTpl<Scalar> Base;
 typedef ResidualDataFrameTranslationTpl<Scalar> Data;
 typedef StateMultibodyTpl<Scalar> StateMultibody;
 typedef ResidualDataAbstractTpl<Scalar> ResidualDataAbstract;
 typedef DataCollectorAbstractTpl<Scalar> DataCollectorAbstract;
 typedef typename MathBase::VectorXs VectorXs;
 typedef typename MathBase::Vector3s Vector3s;

 ResidualModelFrameTranslationTpl(std::shared_ptr<StateMultibody> state,
 const pinocchio::FrameIndex id,
 const Vector3s& xref, const std::size_t nu);

 ResidualModelFrameTranslationTpl(std::shared_ptr<StateMultibody> state,
 const pinocchio::FrameIndex id,
 const Vector3s& xref);
 virtual ~ResidualModelFrameTranslationTpl() = default;

 virtual void calc(const std::shared_ptr<ResidualDataAbstract>& data,
 const Eigen::Ref<const VectorXs>& x,
 const Eigen::Ref<const VectorXs>& u) override;

 virtual void calcDiff(const std::shared_ptr<ResidualDataAbstract>& data,
 const Eigen::Ref<const VectorXs>& x,
 const Eigen::Ref<const VectorXs>& u) override;

 virtual std::shared_ptr<ResidualDataAbstract> createData(
 DataCollectorAbstract* const data) override;

 template <typename NewScalar>
 ResidualModelFrameTranslationTpl<NewScalar> cast() const;

 pinocchio::FrameIndex get_id() const;

 const Vector3s& get_reference() const;

 void set_id(const pinocchio::FrameIndex id);

 void set_reference(const Vector3s& reference);

 virtual void print(std::ostream& os) const override;

 protected:
 using Base::nu_;
 using Base::state_;
 using Base::u_dependent_;
 using Base::v_dependent_;

 private:
 pinocchio::FrameIndex id_;
 Vector3s xref_;
 std::shared_ptr<typename StateMultibody::PinocchioModel>
 pin_model_;
};

template <typename _Scalar>
struct ResidualDataFrameTranslationTpl
 : public ResidualDataAbstractTpl<_Scalar> {
 EIGEN_MAKE_ALIGNED_OPERATOR_NEW

 typedef _Scalar Scalar;
 typedef MathBaseTpl<Scalar> MathBase;
 typedef ResidualDataAbstractTpl<Scalar> Base;
 typedef DataCollectorAbstractTpl<Scalar> DataCollectorAbstract;
 typedef typename MathBase::Matrix6xs Matrix6xs;

 template <template <typename Scalar> class Model>
 ResidualDataFrameTranslationTpl(Model<Scalar>* const model,
 DataCollectorAbstract* const data)
 : Base(model, data), fJf(6, model->get_state()->get_nv()) {
 fJf.setZero();
 // Check that proper shared data has been passed
 DataCollectorMultibodyTpl<Scalar>* d =
 dynamic_cast<DataCollectorMultibodyTpl<Scalar>*>(shared);
 if (d == NULL) {
 throw_pretty(
 "Invalid argument: the shared data should be derived from "
 "DataCollectorMultibody");
 }

 // Avoids data casting at runtime
 pinocchio = d->pinocchio;
 }
 virtual ~ResidualDataFrameTranslationTpl() = default;

 pinocchio::DataTpl<Scalar>* pinocchio;
 Matrix6xs fJf;

 using Base::r;
 using Base::Ru;
 using Base::Rx;
 using Base::shared;
};

} // namespace crocoddyl

/* --- Details -------------------------------------------------------------- */
/* --- Details -------------------------------------------------------------- */
/* --- Details -------------------------------------------------------------- */
#include "crocoddyl/multibody/residuals/frame-translation.hxx"

CROCODDYL_DECLARE_EXTERN_TEMPLATE_CLASS(
 crocoddyl::ResidualModelFrameTranslationTpl)
CROCODDYL_DECLARE_EXTERN_TEMPLATE_STRUCT(
 crocoddyl::ResidualDataFrameTranslationTpl)

#endif // CROCODDYL_MULTIBODY_RESIDUALS_FRAME_TRANSLATION_HPP_