reverseTapeInterface.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2024 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
 * Homepage: http://www.scicomp.uni-kl.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://www.scicomp.uni-kl.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 <iostream>
 
#include "../../config.h"
#include "../../expressions/logic/traversalLogic.hpp"
#include "../../misc/macros.hpp"
#include "../../traits/expressionTraits.hpp"
#include "../../traits/realTraits.hpp"
#include "../misc/tapeParameters.hpp"
#include "../misc/tapeValues.hpp"
#include "gradientAccessTapeInterface.hpp"
#include "internalStatementRecordingTapeInterface.hpp"
 
namespace codi {
 
  template<typename T_Real, typename T_Gradient, typename T_Tape, typename T_Impl>
  struct LhsExpressionInterface;
 
  template<typename T_Real, typename T_Gradient, typename T_Identifier>
  struct ReverseTapeInterface : public virtual InternalStatementRecordingTapeInterface<T_Identifier>,
                                public virtual GradientAccessTapeInterface<T_Gradient, T_Identifier> {
    public:
      using Real = CODI_DD(T_Real, double);           
      using Gradient = CODI_DD(T_Gradient, double);   
      using Identifier = CODI_DD(T_Identifier, int);  
 
      using PassiveReal = RealTraits::PassiveReal<Real>;  
 
      /*******************************************************************************/
 
      template<typename Lhs, typename Tape>
      void registerInput(LhsExpressionInterface<Real, Gradient, Tape, Lhs>& value);
      template<typename Lhs, typename Tape>
      void registerOutput(LhsExpressionInterface<Real, Gradient, Tape, Lhs>& value);
 
      void setActive();       
      void setPassive();      
      bool isActive() const;  
 
      /*******************************************************************************/
 
      void evaluate(AdjointsManagement adjointsManagement = AdjointsManagement::Automatic);
 
      /*******************************************************************************/
 
      void clearAdjoints(AdjointsManagement adjointsManagement = AdjointsManagement::Automatic);
 
      void reset(bool resetAdjoints = true, AdjointsManagement adjointsManagement = AdjointsManagement::Automatic);
 
      /*******************************************************************************/
 
      template<typename Stream = std::ostream>
      void printStatistics(Stream& out = std::cout) const;
      template<typename Stream = std::ostream>
      void printTableHeader(Stream& out = std::cout) const;
      template<typename Stream = std::ostream>
      void printTableRow(Stream& out = std::cout) const;
      TapeValues getTapeValues() const;
  };
}