codi.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2024 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 "codi/config.h"
#include "codi/expressions/activeType.hpp"
#include "codi/expressions/activeTypeStatelessTape.hpp"
#include "codi/expressions/activeTypeWrapper.hpp"
#include "codi/expressions/immutableActiveType.hpp"
#include "codi/expressions/real/allOperators.hpp"
#include "codi/expressions/referenceActiveType.hpp"
#include "codi/misc/enumBitset.hpp"
#include "codi/tapes/data/blockData.hpp"
#include "codi/tapes/data/chunkedData.hpp"
#include "codi/tapes/forwardEvaluation.hpp"
#include "codi/tapes/indices/linearIndexManager.hpp"
#include "codi/tapes/indices/multiUseIndexManager.hpp"
#include "codi/tapes/jacobianLinearTape.hpp"
#include "codi/tapes/jacobianReuseTape.hpp"
#include "codi/tapes/primalValueLinearTape.hpp"
#include "codi/tapes/primalValueReuseTape.hpp"
#include "codi/tapes/statementEvaluators/directStatementEvaluator.hpp"
#include "codi/tapes/statementEvaluators/innerStatementEvaluator.hpp"
#include "codi/tapes/statementEvaluators/reverseStatementEvaluator.hpp"
#include "codi/tapes/tagging/tagTapeForward.hpp"
#include "codi/tapes/tagging/tagTapeReverse.hpp"
#include "codi/tools/data/aggregatedTypeVectorAccessWrapper.hpp"
#include "codi/tools/data/direction.hpp"
#include "codi/tools/data/externalFunctionUserData.hpp"
#include "codi/tools/data/jacobian.hpp"
#include "codi/tools/derivativeAccess.hpp"
#include "codi/tools/helpers/customAdjointVectorHelper.hpp"
#include "codi/tools/helpers/externalFunctionHelper.hpp"
// #include "codi/tools/helpers/evaluationHelper.hpp" // Included at the end of this file.
#include "codi/tapes/io/readerWriterHelpers.hpp"
#include "codi/tools/helpers/linearSystem/linearSystemHandler.hpp"
#include "codi/tools/helpers/preaccumulationHelper.hpp"
#include "codi/tools/helpers/statementPushHelper.hpp"
#include "codi/tools/helpers/tapeHelper.hpp"
#include "codi/tools/lowlevelFunctions/lowLevelFunctionCreationUtilities.hpp"
#include "codi/traits/computationTraits.hpp"
#include "codi/traits/numericLimits.hpp"
#include "codi/traits/tapeTraits.hpp"
 
#if CODI_EnableMPI
  #include "codi/tools/mpi/codiMpiTypes.hpp"
#endif
 
#if CODI_EnableEigen
  #include "codi/tools/helpers/linearSystem/eigenLinearSystem.hpp"
  #include "codi/tools/lowlevelFunctions/linearAlgebra/matrixMatrixMultiplication.hpp"
#endif
 
#if CODI_EnableEnzyme
  #include "codi/tools/helpers/enzymeExternalFunctionHelper.hpp"
#endif
 
namespace codi {
 
#define CODI_MAJOR_VERSION 2
#define CODI_MINOR_VERSION 3
#define CODI_BUILD_VERSION 0
#define CODI_VERSION "2.3.0"
 
  template<typename Real, typename Gradient = Real>
  using RealForwardGen = ActiveType<ForwardEvaluation<Real, Gradient>>;
 
  using RealForward = RealForwardGen<double, double>;
 
  template<size_t dim>
  using RealForwardVec = RealForwardGen<double, Direction<double, dim>>;
 
  template<typename Real, typename Gradient = Real, typename Index = int>
  using RealReverseGen =
      ActiveType<JacobianLinearTape<JacobianTapeTypes<Real, Gradient, LinearIndexManager<Index>, DefaultChunkedData>>>;
 
  using RealReverse = RealReverseGen<double>;
 
  template<size_t dim>
  using RealReverseVec = RealReverseGen<double, Direction<double, dim>>;
 
  template<typename Real, typename Gradient = Real, typename Index = int>
  using RealReverseUncheckedGen =
      ActiveType<JacobianLinearTape<JacobianTapeTypes<Real, Gradient, LinearIndexManager<Index>, DefaultBlockData>>>;
 
  using RealReverseUnchecked = RealReverseUncheckedGen<double>;
 
  template<typename Real, typename Gradient = Real, typename IndexManager = MultiUseIndexManager<int>>
  using RealReverseIndexGen =
      ActiveType<JacobianReuseTape<JacobianTapeTypes<Real, Gradient, IndexManager, DefaultChunkedData>>>;
 
  using RealReverseIndex = RealReverseIndexGen<double>;
 
  template<size_t dim>
  using RealReverseIndexVec = RealReverseIndexGen<double, Direction<double, dim>>;
 
  template<typename Real, typename Gradient = Real, typename IndexManager = MultiUseIndexManager<int>>
  using RealReverseIndexUncheckedGen =
      ActiveType<JacobianReuseTape<JacobianTapeTypes<Real, Gradient, IndexManager, DefaultChunkedData>>>;
 
  using RealReverseIndexUnchecked = RealReverseIndexUncheckedGen<double>;
 
  template<typename Real, typename Gradient = Real, typename Index = int,
           template<typename> class StatementEvaluator = InnerStatementEvaluator>
  using RealReversePrimalGen = ActiveType<PrimalValueLinearTape<
      PrimalValueTapeTypes<Real, Gradient, LinearIndexManager<Index>, StatementEvaluator, DefaultChunkedData>>>;
 
  using RealReversePrimal = RealReversePrimalGen<double>;
 
  template<size_t dim>
  using RealReversePrimalVec = RealReversePrimalGen<double, Direction<double, dim>>;
 
  template<typename Real, typename Gradient = Real, typename Index = int,
           template<typename> class StatementEvaluator = InnerStatementEvaluator>
  using RealReversePrimalUncheckedGen = ActiveType<PrimalValueLinearTape<
      PrimalValueTapeTypes<Real, Gradient, LinearIndexManager<Index>, StatementEvaluator, DefaultChunkedData>>>;
 
  using RealReversePrimalUnchecked = RealReversePrimalUncheckedGen<double>;
 
  template<typename Real, typename Gradient = Real, typename IndexManager = MultiUseIndexManager<int>,
           template<typename> class StatementEvaluator = InnerStatementEvaluator>
  using RealReversePrimalIndexGen = ActiveType<
      PrimalValueReuseTape<PrimalValueTapeTypes<Real, Gradient, IndexManager, StatementEvaluator, DefaultChunkedData>>>;
 
  using RealReversePrimalIndex = RealReversePrimalIndexGen<double>;
 
  template<size_t dim>
  using RealReversePrimalIndexVec = RealReversePrimalIndexGen<double, Direction<double, dim>>;
 
  template<typename Real, typename Gradient = Real, typename IndexManager = MultiUseIndexManager<int>,
           template<typename> class StatementEvaluator = InnerStatementEvaluator>
  using RealReversePrimalIndexUncheckedGen = ActiveType<
      PrimalValueReuseTape<PrimalValueTapeTypes<Real, Gradient, IndexManager, StatementEvaluator, DefaultChunkedData>>>;
 
  using RealReversePrimalIndexUnchecked = RealReversePrimalIndexUncheckedGen<double>;
 
  using HessianComputationType = RealReversePrimalIndexGen<RealForwardVec<4>, Direction<RealForwardVec<4>, 4>>;
 
  using HessianComputationScalarType = RealReversePrimalIndexGen<RealForward>;
 
  using JacobianComputationType = RealReverseIndexVec<4>;
 
  using JacobianComputationScalarType = RealReverseIndex;
 
  using RealReverseTag = ActiveType<TagTapeReverse<double, int>>;
 
  using RealForwardTag = ActiveType<TagTapeForward<double, int>>;
}
 
#include "codi/tools/cuda/codiCUDA.hpp"
#include "codi/tools/helpers/evaluationHelper.hpp"
 
#if CODI_EnableOpenMP
  #include "codi/tools/parallel/openmp/codiOpenMP.hpp"
#endif
 
#if CODI_EnableOpDiLib
  #include "codi/tools/parallel/openmp/codiOpDiLibTool.hpp"
#endif