Gradient.hpp

Go to the documentation of this file.

// Copyright (c) Sleipnir contributors
 
#pragma once
 
#include <utility>
 
#include <Eigen/SparseCore>
 
#include "sleipnir/autodiff/Jacobian.hpp"
#include "sleipnir/autodiff/Profiler.hpp"
#include "sleipnir/autodiff/Variable.hpp"
#include "sleipnir/autodiff/VariableMatrix.hpp"
#include "sleipnir/util/SymbolExports.hpp"
 
namespace sleipnir {
 
class SLEIPNIR_DLLEXPORT Gradient {
 public:
  Gradient(Variable variable, Variable wrt) noexcept
      : Gradient{std::move(variable), VariableMatrix{wrt}} {}
 
  Gradient(Variable variable, const VariableMatrix& wrt) noexcept
      : m_jacobian{variable, wrt} {}
 
  VariableMatrix Get() const { return m_jacobian.Get().T(); }
 
  const Eigen::SparseVector<double>& Value() {
    m_g = m_jacobian.Value();
 
    return m_g;
  }
 
  Profiler& GetProfiler() { return m_jacobian.GetProfiler(); }
 
 private:
  Eigen::SparseVector<double> m_g;
 
  Jacobian m_jacobian;
};
 
}  // namespace sleipnir