jacobian.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2025 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
 * Homepage: http://scicomp.rptu.de
 * Contact:  Prof. Nicolas R. Gauger (codi@scicomp.uni-kl.de)
 *
 * Lead developers: Max Sagebaum, Johannes Blühdorn (SciComp, University of Kaiserslautern-Landau)
 *
 * This file is part of CoDiPack (http://scicomp.rptu.de/software/codi).
 *
 * CoDiPack is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * CoDiPack is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU General Public License for more details.
 * You should have received a copy of the GNU
 * General Public License along with CoDiPack.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * For other licensing options please contact us.
 *
 * Authors:
 *  - SciComp, University of Kaiserslautern-Landau:
 *    - Max Sagebaum
 *    - Johannes Blühdorn
 *    - Former members:
 *      - Tim Albring
 */
#pragma once
 
#include <vector>
 
#include "../../config.h"
#include "../../misc/constructVector.hpp"
#include "../../misc/macros.hpp"
#include "../../traits/realTraits.hpp"
#include "delayAccessor.hpp"
#include "dummy.hpp"
#include "jacobianInterface.hpp"
#include "staticDummy.hpp"

namespace codi {

  template<typename T_T, typename T_Store = std::vector<T_T>>
  struct Jacobian : public JacobianInterface<T_T> {
    public:
 
      using T = CODI_DD(T_T, double);                       
      using Store = CODI_DD(T_Store, std::vector<double>);  
 
    protected:
      Store values;  
 
      size_t m;  
      size_t n;  
 
    public:

      explicit Jacobian(size_t const m, size_t const n) : values(constructVector<Store>(n * m)), m(m), n(n) {}

      CODI_INLINE size_t getM() const {
        return m;
      }

      CODI_INLINE size_t getN() const {
        return n;
      }

      CODI_INLINE T operator()(size_t const i, size_t const j) const {
        return values[computeIndex(i, j)];
      }

      CODI_INLINE T& operator()(size_t const i, size_t const j) {
        return values[computeIndex(i, j)];
      }

      CODI_INLINE void resize(size_t const m, size_t const n) {
        this->m = m;
        this->n = n;
 
        values.resize(m * n);
      }

      CODI_INLINE size_t size() const {
        return m * n;
      }
 
    protected:

      CODI_INLINE size_t computeIndex(size_t const i, size_t const j) const {
        return i * n + j;
      }
  };

  template<typename T_T, typename T_Store = std::vector<T_T>>
  struct JacobianCountNonZerosRow : public Jacobian<T_T, T_Store> {
    public:
 
      using Base = Jacobian<T_T, T_Store>;  
 
      using T = typename Base::T;          
      using Store = typename Base::Store;  
 
      using DelayAcc = JacobianDelayAccessor<JacobianCountNonZerosRow>;  
 
    private:
 
      std::vector<int> nonZerosRowVector;  
 
    public:

      explicit JacobianCountNonZerosRow(size_t m, size_t n) : Base(m, n), nonZerosRowVector(m) {}

      CODI_INLINE T operator()(size_t const i, size_t const j) const {
        return Base::operator()(i, j);
      }

      CODI_INLINE DelayAcc operator()(size_t const i, size_t const j) {
        return DelayAcc(i, j, *this);
      }

      CODI_INLINE void resize(size_t const m, size_t const n) {
        Base::resize(m, n);
        nonZerosRowVector.resize(m);
      }

      CODI_INLINE int& nonZerosRow(size_t const i) {
        return nonZerosRowVector[i];
      }

      CODI_INLINE void setLogic(size_t const i, size_t const j, T const& v) {
        if (T() != v) {
          nonZerosRowVector[i] += 1;
        }
        Base::operator()(i, j) = v;
      }
  };

  template<typename T_Nested>
  struct JacobianConvertWrapper {
    public:
      using Nested = CODI_DD(T_Nested, JacobianInterface<double>);     
      using T = typename Nested::T;                                    
      using DelayAcc = JacobianDelayAccessor<JacobianConvertWrapper>;  
 
    private:
      Nested& nested;
 
    public:

      explicit JacobianConvertWrapper(Nested& nested) : nested(nested) {}

      CODI_INLINE T operator()(size_t const i, size_t const j) const {
        return nested(i, j);
      }

      CODI_INLINE DelayAcc operator()(size_t const i, size_t const j) {
        return DelayAcc(i, j, *this);
      }

      template<typename SetT>
      CODI_INLINE void setLogic(size_t const i, size_t const j, SetT const& v) {
        nested(i, j) = RealTraits::getPassiveValue<SetT>(v);
      }
  };

  struct DummyJacobian : public JacobianInterface<DummyValue> {
    public:

      size_t getM() const {
        return 0;
      }

      size_t getN() const {
        return 0;
      }

      CODI_INLINE DummyValue operator()(size_t const i, size_t const j) const {
        CODI_UNUSED(i, j);
 
        return DummyValue();
      }

      CODI_INLINE_NO_FA DummyValue& operator()(size_t const i, size_t const j) {
        CODI_UNUSED(i, j);
 
        return StaticDummy<DummyValue>::dummy;
      }

      void resize(size_t const m, size_t const n) {
        CODI_UNUSED(m, n);
      }

      size_t size() const {
        return 0;
      }
  };
}