externfcts2.h

Go to the documentation of this file.

/*----------------------------------------------------------------------------
 ADOL-C -- Automatic Differentiation by Overloading in C++
 File:     externfcts.h
 Revision: $Id$
 Contents: public functions and data types for extern (differentiated)
           functions.
 
 Copyright (c) Kshitij Kulshreshtha
 
 This file is part of ADOL-C. This software is provided as open source.
 Any use, reproduction, or distribution of the software constitutes
 recipient's acceptance of the terms of the accompanying license file.
 
----------------------------------------------------------------------------*/
 
#if !defined(ADOLC_EXTERNFCTS2_H)
#define ADOLC_EXTERNFCTS2_H 1
 
#include <adolc/adolcexport.h>
#include <adolc/internal/common.h>
 
using ADOLC_ext_fct_v2 = int(short tapeId, size_t iArrLen, size_t *iArr,
                             size_t nin, size_t nout, size_t *insz, double **x,
                             size_t *outsz, double **y, void *ctx);
using ADOLC_ext_fct_v2_fos_forward = int(short tapeId, size_t iArrLen,
                                         size_t *iArr, size_t nin, size_t nout,
                                         size_t *insz, double **x, double **xp,
                                         size_t *outsz, double **y, double **yp,
                                         void *ctx);
using ADOLC_ext_fct_v2_fov_forward = int(short tapeId, size_t iArrLen,
                                         size_t *iArr, size_t nin, size_t nout,
                                         size_t *insz, double **x, size_t ndir,
                                         double ***Xp, size_t *outsz,
                                         double **y, double ***Yp, void *ctx);
using ADOLC_ext_fct_v2_fos_reverse = int(short tapeId, size_t iArrLen,
                                         size_t *iArr, size_t nout, size_t nin,
                                         size_t *outsz, double **up,
                                         size_t *insz, double **zp, double **x,
                                         double **y, void *ctx);
using ADOLC_ext_fct_v2_fov_reverse = int(short tapeId, size_t iArrLen,
                                         size_t *iArr, size_t nout, size_t nin,
                                         size_t *outsz, size_t dir,
                                         double ***Up, size_t *insz,
                                         double ***Zp, double **x, double **y,
                                         void *ctx);
 
/* The following two aren't implemented */
using ADOLC_ext_fct_v2_hos_forward = int(short tapeId, size_t iArrLen,
                                         size_t *iArr, size_t nin, size_t nout,
                                         size_t *insz, double **x,
                                         size_t degree, double ***Xp,
                                         size_t *outsz, double **y,
                                         double ***Yp, void *ctx);
using ADOLC_ext_fct_v2_hov_forward = int(short tapeId, size_t iArrLen,
                                         size_t *iArr, size_t nin, size_t nout,
                                         size_t *insz, double **x,
                                         size_t degree, size_t ndir,
                                         double ****Xp, size_t *outsz,
                                         double **y, double ****Yp, void *ctx);
 
struct ADOLC_API ext_diff_fct_v2 {
  // This is the id of the outer tape that calls the external differentiated
  // function later
  short tapeId{0};
 
  // tape that stores the external differentiated function.
  short extTapeId{0};
  ADOLC_ext_fct_v2 *function{nullptr};
  locint index{0};
 
  ADOLC_ext_fct_v2 *zos_forward{nullptr};
 
  ADOLC_ext_fct_v2_fos_forward *fos_forward{nullptr};
 
  ADOLC_ext_fct_v2_fov_forward *fov_forward{nullptr};
 
  ADOLC_ext_fct_v2_fos_reverse *fos_reverse{nullptr};
 
  ADOLC_ext_fct_v2_fov_reverse *fov_reverse{nullptr};
 
  double **x{nullptr};
 
  double **xp{nullptr};
 
  double ***Xp{nullptr};
 
  double **y{nullptr};
 
  double **yp{nullptr};
 
  double ***Yp{nullptr};
 
  double **up{nullptr};
 
  double ***Up{nullptr};
 
  double **zp{nullptr};
 
  double ***Zp{nullptr};
 
  size_t max_nin{0}, max_nout{0}, max_insz{0}, max_outsz{0};
 
  int p{0};
 
  int q{0};
  char nestedAdolc{0};
 
  char dp_x_changes{1};
 
  char dp_y_priorRequired{1};
  void *context{nullptr};
  char *allmem{nullptr};
  void *obj{nullptr};
  char user_allocated_mem{0};
};
 
ADOLC_API ext_diff_fct_v2 *reg_ext_fct(short tapeId, short extTapeId,
                                       ADOLC_ext_fct_v2 ext_fct);
ADOLC_API ext_diff_fct_v2 *get_ext_diff_fct_v2(short tapeId, size_t index);
ADOLC_API int call_ext_fct(ext_diff_fct_v2 *edfct, size_t iArrLen, size_t *iArr,
                           size_t nin, size_t out, size_t *insz, adouble **x,
                           size_t *outsz, adouble **y);
 
ADOLC_API void edf_zero(ext_diff_fct_v2 *edfct);
 
ADOLC_API inline void edf_set_opaque_context(ext_diff_fct_v2 *edfct,
                                             void *ctx) {
  edfct->context = ctx;
}
 
#endif