gradient.hpp

// Copyright (c) Sleipnir contributors
 
#pragma once
 
#include <utility>
 
#include <Eigen/SparseCore>
 
#include "sleipnir/autodiff/jacobian.hpp"
#include "sleipnir/autodiff/variable.hpp"
#include "sleipnir/autodiff/variable_matrix.hpp"
#include "sleipnir/util/concepts.hpp"
#include "sleipnir/util/small_vector.hpp"
#include "sleipnir/util/solve_profiler.hpp"
#include "sleipnir/util/symbol_exports.hpp"
 
namespace slp {
 
class SLEIPNIR_DLLEXPORT Gradient {
 public:
  Gradient(Variable variable, Variable wrt) noexcept
      : m_jacobian{std::move(variable), std::move(wrt)} {}
 
  Gradient(Variable variable, SleipnirMatrixLike auto wrt) noexcept
      : m_jacobian{VariableMatrix{std::move(variable)}, std::move(wrt)} {}
 
  VariableMatrix get() const { return m_jacobian.get().T(); }
 
  const Eigen::SparseVector<double>& value() {
    m_g = m_jacobian.value();
 
    return m_g;
  }
 
  const small_vector<SolveProfiler>& get_profilers() const {
    return m_jacobian.get_profilers();
  }
 
 private:
  Eigen::SparseVector<double> m_g;
 
  Jacobian m_jacobian;
};
 
}  // namespace slp