tape_interface.h

Go to the documentation of this file.

#ifndef ADOLC_TAPE_INTERFACE_H
#define ADOLC_TAPE_INTERFACE_H
 
#include <adolc/adolcerror.h>
#include <adolc/adolcexport.h>
#include <adolc/valuetape/valuetape.h>
#include <cassert>
#include <cstddef>
#include <vector>
 
ADOLC_API int trace_on(short tapeId, int keepTaylors = 0);
 
ADOLC_API int trace_on(short tapeId, int keepTaylors, size_t obs, size_t lbs,
                       size_t vbs, size_t tbs, int skipFileCleanup);
 
ADOLC_API void trace_off(int flag = 0);
 
ADOLC_API void cachedTraceTags(std::vector<short> &result);
 
ADOLC_API inline void nestedReverseEval(short tapeId, bool flag) {
  findTape(tapeId).nestedReverseEval(flag);
}
 
ADOLC_API inline bool nestedReverseEval(short tapeId) {
  return findTape(tapeId).nestedReverseEval();
}
 
ADOLC_API inline std::array<size_t, TapeInfos::STAT_SIZE>
tapestats(short tapeId) {
  ValueTape &tape = findTape(tapeId);
  std::array<size_t, TapeInfos::STAT_SIZE> stats;
  tape.tapestats(stats.data());
  return stats;
}
 
ADOLC_API void printTapeStats(short tapeId);
 
ADOLC_API inline size_t get_num_param(short tapeId) {
  return findTape(tapeId).get_num_param();
}
 
ADOLC_API inline size_t get_num_switches(short tapeId) {
  const auto &tape = findTape(tapeId);
  if (!tape.tapestats(TapeInfos::NO_MIN_MAX))
    ADOLCError::fail(ADOLCError::ErrorType::NO_MINMAX, CURRENT_LOCATION,
                     ADOLCError::FailInfo{.info1 = tapeId});
  return tape.tapestats(TapeInfos::NUM_SWITCHES);
}
 
#ifdef ADOLC_SPARSE
namespace ADOLC::Sparse {
ADOLC_API inline void setTapeInfoJacSparse(short tapeId,
                                           SparseJacInfos &&sJInfos) {
  findTape(tapeId).setTapeInfoJacSparse(std::move(sJInfos));
}
 
ADOLC_API inline void setTapeInfoHessSparse(short tapeId,
                                            SparseHessInfos &&sHInfos) {
  findTape(tapeId).setTapeInfoHessSparse(std::move(sHInfos));
}
 
ADOLC_API inline void setHP(short tapeId, int indep,
                            std::vector<uint *> &&HPIn) {
  SparseHessInfos sHinfos;
  sHinfos.setHP(indep, std::move(HPIn));
  findTape(tapeId).setTapeInfoHessSparse(std::move(sHinfos));
}
 
ADOLC_API inline std::vector<uint *> getHP(short tapeId) {
  return findTape(tapeId).sHInfos().getHP();
}
 
} // namespace ADOLC::Sparse
#endif // ADOLC_SPARSE
 
#endif // ADOLC_TAPE_INTERFACE_H