linearSystemSpecializationDetection.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 <vector>
 
#include "../../../config.h"
#include "../../../expressions/lhsExpressionInterface.hpp"
#include "../../../misc/exceptions.hpp"
#include "../../../traits/tapeTraits.hpp"
#include "../../data/direction.hpp"
#include "linearSystemFlags.hpp"
#include "linearSystemInterface.hpp"
 
namespace codi {
 
  template<typename T_LinearSystem>
  struct LinearSystemSpecializationDetection {
      using LinearSystem =
          CODI_DD(T_LinearSystem,
                  CODI_T(LinearSystemInterface<LinearSystemInterfaceTypes>));  
 
      using Type = CODI_DD(typename LinearSystem::Type,
                           CODI_DEFAULT_LHS_EXPRESSION);  
 
      using Matrix = typename LinearSystem::Matrix;                      
      using MatrixReal = typename LinearSystem::MatrixReal;              
      using MatrixIdentifier = typename LinearSystem::MatrixIdentifier;  
      using Vector = typename LinearSystem::Vector;                      
      using VectorReal = typename LinearSystem::VectorReal;              
      using VectorIdentifier = typename LinearSystem::VectorIdentifier;  
 
    private:
 
      using Real = typename Type::Real;
      using Identifier = typename Type::Identifier;
 
      using Interface = LinearSystemInterface<typename LinearSystem::InterfaceTypes>;
 
      static void dyadicProxy(Identifier&, Real&, Real&) {}
 
    public:
 
      // gcc issues false warning for comparison with NULL.
#ifdef __GNUC__
  #pragma GCC diagnostic push
  #pragma GCC diagnostic ignored "-Waddress"
#endif
 
      CODI_INLINE static bool IsDyadicImplemented() {
        return static_cast<void (Interface::*)(decltype(dyadicProxy), MatrixIdentifier*, VectorReal*, VectorReal*)>(
                   &LinearSystem::iterateDyadic) !=
               static_cast<void (Interface::*)(decltype(dyadicProxy), MatrixIdentifier*, VectorReal*, VectorReal*)>(
                   &Interface::iterateDyadic);
      }
 
      CODI_INLINE static bool IsTransposeImplemented() {
        return &LinearSystem::transposeMatrix != &Interface::transposeMatrix;
      }
 
      CODI_INLINE static bool IsSubtractMultiplyImplemented() {
        return &LinearSystem::subtractMultiply != &Interface::subtractMultiply;
      }
 
      CODI_INLINE static bool IsSolvePrimalImplemented() {
        return &LinearSystem::solveSystemPrimal != &Interface::solveSystemPrimal;
      }
 
#ifdef __GNUC__
  #pragma GCC diagnostic pop
#endif
 
      CODI_INLINE static bool SupportsReverseMode() {
        return IsDyadicImplemented() && IsTransposeImplemented();
      }
 
      CODI_INLINE static bool SupportsForwardMode() {
        return IsSubtractMultiplyImplemented();
      }
  };
}