task-first-order.hpp

// BSD 3-Clause License
//
// Copyright (C) 2026, Heriot-Watt University
// Copyright note valid unless otherwise stated in individual files.
// All rights reserved.

#ifndef CROCODDYL_CORE_RESIDUALS_TASK_FIRST_ORDER_HPP_
#define CROCODDYL_CORE_RESIDUALS_TASK_FIRST_ORDER_HPP_

#include "crocoddyl/core/fwd.hpp"
#include "crocoddyl/core/guidance-base.hpp"
#include "crocoddyl/core/residual-base.hpp"
#include "crocoddyl/core/task-base.hpp"

namespace crocoddyl {

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

 typedef _Scalar Scalar;
 typedef MathBaseTpl<Scalar> MathBase;
 typedef ResidualModelAbstractTpl<Scalar> Base;
 typedef ResidualDataTaskFirstOrderTpl<Scalar> Data;
 typedef ResidualDataAbstractTpl<Scalar> ResidualDataAbstract;
 typedef DataCollectorAbstractTpl<Scalar> DataCollectorAbstract;
 typedef GuidanceModelAbstractTpl<Scalar> GuidanceModelAbstract;
 typedef TaskModelAbstractTpl<Scalar> TaskModelAbstract;
 typedef typename MathBase::VectorXs VectorXs;

 ResidualModelTaskFirstOrderTpl(
 std::shared_ptr<TaskModelAbstract> task,
 std::shared_ptr<GuidanceModelAbstract> guidance);
 virtual ~ResidualModelTaskFirstOrderTpl() = 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>
 ResidualModelTaskFirstOrderTpl<NewScalar> cast() const;

 const std::shared_ptr<TaskModelAbstract>& get_task() const;
 const std::shared_ptr<GuidanceModelAbstract>& get_guidance() const;
 void set_guidance(std::shared_ptr<GuidanceModelAbstract> guidance);

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

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

 void checkDimensions() const;

 std::shared_ptr<TaskModelAbstract> task_;
 std::shared_ptr<GuidanceModelAbstract> guidance_;
};

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

 typedef _Scalar Scalar;
 typedef MathBaseTpl<Scalar> MathBase;
 typedef ResidualDataAbstractTpl<Scalar> Base;
 typedef DataCollectorAbstractTpl<Scalar> DataCollectorAbstract;
 typedef GuidanceDataAbstractTpl<Scalar> GuidanceDataAbstract;
 typedef TaskDataAbstractTpl<Scalar> TaskDataAbstract;
 typedef typename MathBase::VectorXs VectorXs;
 typedef typename MathBase::MatrixXs MatrixXs;

 template <template <typename Scalar> class Model>
 ResidualDataTaskFirstOrderTpl(Model<Scalar>* const model,
 DataCollectorAbstract* const data)
 : Base(model, data),
 task(model->get_task()->createData(data)),
 guidance(model->get_guidance()->createData()) {
 task->compute_acceleration = false;
 }

 virtual ~ResidualDataTaskFirstOrderTpl() = default;

 std::shared_ptr<TaskDataAbstract> task;
 std::shared_ptr<GuidanceDataAbstract> guidance;

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

} // namespace crocoddyl

/* --- Details -------------------------------------------------------------- */
#include "crocoddyl/core/residuals/task-first-order.hxx"

#endif // CROCODDYL_CORE_RESIDUALS_TASK_FIRST_ORDER_HPP_