primalEvaluationTapeInterface.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 "../../config.h"
#include "../../misc/macros.hpp"
#include "../data/position.hpp"
#include "positionalEvaluationTapeInterface.hpp"
 
namespace codi {
 
  template<typename T_Real, typename T_Identifier, typename T_Position>
  struct PrimalEvaluationTapeInterface : public virtual PositionalEvaluationTapeInterface<T_Position> {
    public:
 
      using Real = CODI_DD(T_Real, double);                 
      using Identifier = CODI_DD(T_Identifier, int);        
      using Position = CODI_DD(T_Position, EmptyPosition);  
 
      /*******************************************************************************/
 
      static bool constexpr HasPrimalValues = CODI_UNDEFINED_VALUE;  
      static bool constexpr RequiresPrimalRestore =
          CODI_UNDEFINED_VALUE;  
 
      void evaluatePrimal(Position const& start, Position const& end);
 
      void evaluatePrimal();
 
      void setPrimal(Identifier const& identifier, Real const& gradient);  
      Real const& getPrimal(Identifier const& identifier) const;           
 
      Real& primal(Identifier const& identifier);              
      Real const& primal(Identifier const& identifier) const;  
 
      void revertPrimals(Position const& pos);
  };
}