typeDefinitions.h

Go to the documentation of this file.

/*
 * MeDiPack, a Message Differentiation Package
 *
 * Copyright (C) 2015-2026 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 (SciComp, University of Kaiserslautern-Landau)
 *
 * This file is part of MeDiPack (http://scicomp.rptu.de/software/medi).
 *
 * MeDiPack is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 *
 * MeDiPack 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 Lesser General Public License for more details.
 * You should have received a copy of the GNU
 * Lesser General Public License along with MeDiPack.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Authors: Max Sagebaum, Tim Albring (SciComp, University of Kaiserslautern-Landau)
 */
 
#pragma once
 
#include "adjointInterface.hpp"
#include "debugInformation.hpp"

namespace medi {
 
  enum class ManualDeleteType {
    Normal,
    Async,
    Wait
  };
 
  using CallbackFunc = void (*)(void* id, void* userData);
 
  struct HandleBase;
  typedef void (*ReverseFunction)(HandleBase* h, AdjointInterface* a);
  typedef void (*ForwardFunction)(HandleBase* h, AdjointInterface* a);
  typedef void (*PrimalFunction)(HandleBase* h, AdjointInterface* a);
  typedef void (*IterateIdsFunction)(HandleBase* h, CallbackFunc func, void* userData);
  typedef int (*ContinueFunction)(HandleBase* h);
  typedef void (*PreAdjointOperation)(void* adjoints, void* primals, int count, int dim);
  typedef void (*PostAdjointOperation)(void* adjoints, void* primals, void* rootPrimals, int count, int dim);
  typedef void (*CustomFunction)(void* data);
 
  struct HandleBase {
#if MEDI_DebugInformation
    std::string debugInformation;
#endif
 
    ReverseFunction funcReverse;
    ForwardFunction funcForward;
    PrimalFunction funcPrimal;
    ManualDeleteType deleteType;
    IterateIdsFunction funcIterateInputIds;
    IterateIdsFunction funcIterateOutputIds;
 
    HandleBase() :
#if MEDI_DebugInformation
      debugInformation(getDebugInformation()),
#endif
      funcReverse(NULL),
      funcForward(NULL),
      funcPrimal(NULL),
      deleteType(ManualDeleteType::Normal),
      funcIterateInputIds(NULL),
      funcIterateOutputIds(NULL)
    {}
 
 
    virtual ~HandleBase() {}
  };
 
  // structures for the passive types
 
  template <typename T>
  struct PairWithInt {
      T a;
      int b;
  };
 
  typedef PairWithInt<float> FloatIntPair;
  typedef PairWithInt<double> DoubleIntPair;
  typedef PairWithInt<long> LongIntPair;
  typedef PairWithInt<int> IntIntPair;
  typedef PairWithInt<short> ShortIntPair;
  typedef PairWithInt<long double> LongDoubleIntPair;
 
}