/usr/include/adolc/interfaces.h is in libadolc-dev 2.6.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | /*----------------------------------------------------------------------------
ADOL-C -- Automatic Differentiation by Overloading in C++
File: interfaces.h
Revision: $Id: interfaces.h 731 2017-01-17 08:11:40Z kulshres $
Contents: Declaration of the standard interfaces to ADOL-C forward and
reverse calls (C++, C and Fortran callable C functions).
Functions prototyped here are defined in the files
uni5_for.mc for
zos_forward.c
fos_forward.c
hos_forward.c
fov_forward.c
hov_forward.c
hov_wk_forward.c
fo_rev.mc for
fos_reverse.c
fov_reverse.c
ho_rev.mc for
hos_reverse.c
hos_ov_reverse.c
hov_reverse.c
hos_ti_reverse.c
hov_ti_reverse.c
interfacesC.C
interfacesf.c
ADOL-C Abreviations :
zos : zero-order-scalar mode
fos : first-order-scalar mode
hos : higher-order-scalar mode
fov : first-order-vector mode
hov : higher-order-vector mode
wk : with keep
ov : over vector (forward)
ti : Taylor input
Copyright (c) Andrea Walther, Andreas Griewank, Andreas Kowarz,
Hristo Mitev, Sebastian Schlenkrich, Jean Utke, Olaf Vogel
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_INTERFACES_H)
#define ADOLC_INTERFACES_H 1
#include <adolc/internal/common.h>
#if defined(SPARSE)
#include <adolc/sparse/sparsedrivers.h>
#include <adolc/sparse/sparse_fo_rev.h>
#endif
/****************************************************************************/
/****************************************************************************/
/* Now the C++ THINGS */
#if defined(__cplusplus)
/****************************************************************************/
/* FORWARD MODE, overloaded calls */
/*--------------------------------------------------------------------------*/
/* General scalar call. For d=0 or d=1 done by specialized code */
/* */
/* forward(tag, m, n, d, keep, X[n][d+1], Y[m][d+1]) : hos || fos || zos */
ADOLC_DLL_EXPORT int forward(short, int, int, int, int, double**, double**);
/*--------------------------------------------------------------------------*/
/* Y can be one dimensional if m=1. d=0 or d=1 done by specialized code */
/* */
/* forward(tag, m, n, d, keep, X[n][d+1], Y[d+1]) : hos || fos || zos */
ADOLC_DLL_EXPORT int forward(short, int, int, int, int, double**, double*);
/*--------------------------------------------------------------------------*/
/* X and Y can be one dimensional if d = 0; done by specialized code */
/* */
/* forward(tag, m, n, d, keep, X[n], Y[m]) : zos */
ADOLC_DLL_EXPORT int forward(short, int, int, int, int, double*, double*);
/*--------------------------------------------------------------------------*/
/* X and Y can be one dimensional if d omitted; done by specialized code */
/* */
/* forward(tag, m, n, keep, X[n], Y[m]) : zos */
ADOLC_DLL_EXPORT int forward(short, int, int, int, double*, double*);
/*--------------------------------------------------------------------------*/
/* General vector call */
/* */
/* forward(tag, m, n, d, p, x[n], X[n][p][d], y[m], Y[m][p][d]) : hov */
ADOLC_DLL_EXPORT int forward(short, int, int, int, int, double*, double***,
double*, double***);
/*--------------------------------------------------------------------------*/
/* d = 1 may be omitted. General vector call, done by specialized code */
/* */
/* forward(tag, m, n, p, x[n], X[n][p], y[m], Y[m][p]) : fov */
ADOLC_DLL_EXPORT int forward(
short, int, int, int, double*, double**, double*, double**);
/****************************************************************************/
/* REVERSE MODE, overloaded calls */
/*--------------------------------------------------------------------------*/
/* General call */
/* */
/* reverse(tag, m, n, d, u[m], Z[n][d+1]) : hos */
ADOLC_DLL_EXPORT int reverse(short, int, int, int, double*, double**);
/*--------------------------------------------------------------------------*/
/* u can be a scalar if m=1 */
/* */
/* reverse(tag, m, n, d, u, Z[n][d+1]) : hos */
ADOLC_DLL_EXPORT int reverse(short, int, int, int, double, double**);
/*--------------------------------------------------------------------------*/
/* Z can be vector if d = 0; done by specialized code */
/* */
/* reverse(tag, m, n, d, u[m], Z[n]) : fos */
ADOLC_DLL_EXPORT int reverse(short, int, int, int, double*, double*);
/*--------------------------------------------------------------------------*/
/* u can be a scalar if m=1 and d=0; done by specialized code */
/* */
/* reverse(tag, m, n, d, u, Z[n]) : fos */
ADOLC_DLL_EXPORT int reverse(short, int, int, int, double, double*);
/*--------------------------------------------------------------------------*/
/* General vector call */
/* */
/* reverse(tag, m, n, d, q, U[q][m], Z[q][n][d+1], nz[q][n]) : hov */
ADOLC_DLL_EXPORT int reverse(
short, int, int, int, int, double**, double***, short** =0);
/*--------------------------------------------------------------------------*/
/* U can be a vector if m=1 */
/* */
/* reverse(tag, m, n, d, q, U[q], Z[q][n][d+1], nz[q][n]) : hov */
ADOLC_DLL_EXPORT int reverse(
short, int, int, int, int, double*, double***, short** = 0);
/*--------------------------------------------------------------------------*/
/* */
/* If d=0 then Z may be a matrix, no nz; done by specialized code */
/* */
/* reverse(tag, m, n, d, q, U[q][m], Z[q][n]) : fov */
ADOLC_DLL_EXPORT int reverse(short, int, int, int, int, double**, double**);
/*--------------------------------------------------------------------------*/
/* */
/* d=0 may be omitted, Z is a matrix, no nz; done by specialized code */
/* */
/* reverse(tag, m, n, q, U[q][m], Z[q][n]) : fov */
ADOLC_DLL_EXPORT int reverse(short, int, int, int, double**, double**);
/*--------------------------------------------------------------------------*/
/* */
/* If m=1 and d=0 then U can be vector and Z a matrix but no nz. */
/* Done by specialized code */
/* */
/* reverse(tag, m, n, d, q, U[q], Z[q][n]) : fov */
ADOLC_DLL_EXPORT int reverse(short, int, int, int, int, double*, double**);
/*--------------------------------------------------------------------------*/
/* */
/* If q and U are omitted they default to m and I so that as above */
/* */
/* reverse(tag, m, n, d, Z[q][n][d+1], nz[q][n]) : hov */
ADOLC_DLL_EXPORT int reverse(short, int, int, int, double***, short** =0);
#endif
/****************************************************************************/
/****************************************************************************/
/* Now the C THINGS */
BEGIN_C_DECLS
/****************************************************************************/
/* FORWARD MODE */
/*--------------------------------------------------------------------------*/
/* ZOS */
/* zos_forward(tag, m, n, keep, x[n], y[m]) */
/* (defined in uni5_for.mc) */
ADOLC_DLL_EXPORT int zos_forward(short,int,int,int,const double*,double*);
/* zos_forward_nk(tag, m, n, x[n], y[m]) */
/* (no keep, defined in uni5_for.c, but not supported in ADOL-C 1.8) */
ADOLC_DLL_EXPORT int zos_forward_nk(short,int,int,const double*,double*);
/* zos_forward_partx(tag, m, n, ndim[n], x[n][d], y[m]) */
/* (based on zos_forward) */
ADOLC_DLL_EXPORT int zos_forward_partx(short,int,int,int*,double**,double*);
/*--------------------------------------------------------------------------*/
/* FOS */
/* fos_forward(tag, m, n, keep, x[n], X[n], y[m], Y[m]) */
/* (defined in uni5_for.mc) */
ADOLC_DLL_EXPORT int fos_forward(
short,int,int,int,const double*,double*,double*,double*);
/* fos_forward_nk(tag,m,n,x[n],X[n],y[m],Y[m]) */
/* (no keep, defined in uni5_for.c, but not supported in ADOL-C 1.8) */
ADOLC_DLL_EXPORT int fos_forward_nk(
short,int,int,const double*,double*,double*,double*);
/* fos_forward_partx(tag, m, n, ndim[n], x[n][][2], y[m][2]) */
/* (based on fos_forward) */
ADOLC_DLL_EXPORT int fos_forward_partx(
short,int,int,int*,double***,double**);
/*--------------------------------------------------------------------------*/
/* HOS */
/* hos_forward(tag, m, n, d, keep, x[n], X[n][d], y[m], Y[m][d]) */
/* (defined in uni5_for.mc) */
ADOLC_DLL_EXPORT int hos_forward(
short,int,int,int,int,const double*,double**,double*,double**);
/* hos_forward_nk(tag, m, n, d, x[n], X[n][d], y[m], Y[m][d]) */
/* (no keep, defined in uni5_for.c, but not supported in ADOL-C 1.8) */
ADOLC_DLL_EXPORT int hos_forward_nk(
short,int,int,int,const double*,double**,double*,double**);
/* hos_forward_partx(tag, m, n, ndim[n], d, X[n][d+1], Y[m][d+1]) */
/* (defined in forward_partx.c) */
ADOLC_DLL_EXPORT int hos_forward_partx(
short,int,int,int*,int,double***,double**);
/* now pack the arrays into vectors for Fortran calling */
ADOLC_DLL_EXPORT fint hos_forward_(
fint*,fint*,fint*,fint*,fint*,fdouble*,fdouble*,fdouble*,fdouble*);
/*--------------------------------------------------------------------------*/
/* FOV */
/* fov_forward(tag, m, n, p, x[n], X[n][p], y[m], Y[m][p]) */
/* (defined in uni5_for.mc) */
ADOLC_DLL_EXPORT int fov_forward(
short, int,int,int,const double*,double**,double*,double**);
ADOLC_DLL_EXPORT int fov_offset_forward(
short, int,int,int,int,const double*,double**,double*,double**);
/* now pack the arrays into vectors for Fortran calling */
ADOLC_DLL_EXPORT fint fov_forward_(
fint*,fint*,fint*,fint*,fdouble*,fdouble*,fdouble*,fdouble*);
/* fov_forward_partx(tag, m, n, ndim[n], p, */
/* x[n][], X[n][][p],y[m], Y[m][p]) */
ADOLC_DLL_EXPORT int fov_forward_partx(
short, int, int, int*, int, double**, double***, double*, double**);
/*--------------------------------------------------------------------------*/
/* HOV */
/* hov_forward(tag, m, n, d, p, x[n], X[n][p][d], y[m], Y[m][p][d]) */
/* (defined in uni5_for.mc) */
ADOLC_DLL_EXPORT int hov_forward(
short,int,int,int,int,const double*,double***,double*,double***);
/* now pack the arrays into vectors for Fortran calling */
ADOLC_DLL_EXPORT fint hov_forward_(
fint*,fint*,fint*,fint*,fint*,fdouble*,fdouble*,fdouble*,fdouble*);
/* hov_forward_partx(tag, m, n, ndim[n], d, p, */
/* x[n][], X[n][][p][d], y[m], Y[m][p][d]) */
ADOLC_DLL_EXPORT int hov_forward_partx(
short, int, int, int*, int, int,
double**, double****, double*, double***);
/*--------------------------------------------------------------------------*/
/* HOV_WK */
/* hov_wk_forward(tag, m, n, d, p, keep, x[n], X[n][p][d], y[m], Y[m][p][d]) */
/* (defined in uni5_for.mc) */
ADOLC_DLL_EXPORT int hov_wk_forward(
short,int,int,int,int,int,const double*,double***,double*,double***);
/* now pack the arrays into vectors for Fortran calling */
ADOLC_DLL_EXPORT fint hov_wk_forward_(
fint*,fint*,fint*,fint*,fint*,fint*,fdouble*,fdouble*,fdouble*,fdouble*);
/****************************************************************************/
/* BIT PATTERN UTILITIES */
/*--------------------------------------------------------------------------*/
/* INT_FOR, SAFE */
/* int_forward_safe(tag, m, n, p, X[n][p], Y[m][p]) */
ADOLC_DLL_EXPORT int int_forward_safe
(short, int, int, int, unsigned long int**, unsigned long int**);
/*--------------------------------------------------------------------------*/
/* INT_FOR, TIGHT */
/* int_forward_tight(tag, m, n, p, x[n], X[n][p], y[m], Y[m][p]) */
ADOLC_DLL_EXPORT int int_forward_tight
(short, int, int, int, const double*, unsigned long int**, double*, unsigned long int**);
/****************************************************************************/
/* INDEX DOMAIN UTILITIES */
/*--------------------------------------------------------------------------*/
/* INDOPRO, SAFE */
/* indopro_forward_safe(tag, m, n, p, x[n], *Y[m]) */
ADOLC_DLL_EXPORT int indopro_forward_safe
(short, int, int, const double*, unsigned int**);
/*--------------------------------------------------------------------------*/
/* INDOPRO, TIGHT */
/* indopro_forward_tight(tag, m, n, x[n], *Y[m]) */
ADOLC_DLL_EXPORT int indopro_forward_tight
(short, int, int, const double*, unsigned int**);
/****************************************************************************/
/* NONLINEAR INDEX DOMAIN UTILITIES */
/*--------------------------------------------------------------------------*/
/* INDOPRO, SAFE */
/* nonl_ind_forward_safe(tag, m, n, p, x[n], *Y[m]) */
ADOLC_DLL_EXPORT int nonl_ind_forward_safe
(short, int, int, const double*, unsigned int**);
/*--------------------------------------------------------------------------*/
/* INDOPRO, TIGHT */
/* nonl_ind_forward_tight(tag, m, n, x[n], *Y[m]) */
ADOLC_DLL_EXPORT int nonl_ind_forward_tight
(short, int, int, const double*, unsigned int**);
/*--------------------------------------------------------------------------*/
/* INDOPRO, SAFE */
/* nonl_ind_old_forward_safe(tag, m, n, p, x[n], *Y[m]) */
ADOLC_DLL_EXPORT int nonl_ind_old_forward_safe
(short, int, int, const double*, unsigned int**);
/*--------------------------------------------------------------------------*/
/* INDOPRO, TIGHT */
/* nonl_ind_old_forward_tight(tag, m, n, x[n], *Y[m]) */
ADOLC_DLL_EXPORT int nonl_ind_old_forward_tight
(short, int, int, const double*, unsigned int**);
/****************************************************************************/
/* REVERSE MODE */
/*--------------------------------------------------------------------------*/
/* FOS */
/* fos_reverse(tag, m, n, u[m], z[n]) */
/* (defined in fo_rev.mc) */
ADOLC_DLL_EXPORT int fos_reverse(short,int,int,double*,double*);
/* now pack the arrays into vectors for Fortran calling */
ADOLC_DLL_EXPORT fint fos_reverse_(fint*,fint*,fint*,fdouble*,fdouble*);
/*--------------------------------------------------------------------------*/
/* HOS */
/* hos_reverse(tag, m, n, d, u[m], Z[n][d+1]) */
/* (defined in ho_rev.mc) */
ADOLC_DLL_EXPORT int hos_reverse(short,int,int,int,double*,double**);
/* now pack the arrays into vectors for Fortran calling */
ADOLC_DLL_EXPORT fint hos_reverse_(fint*,fint*,fint*,fint*,fdouble*,fdouble*);
/*--------------------------------------------------------------------------*/
/* HOS_TI */
/* hos_ti_reverse(tag, m, n, d, U[m][d+1], Z[n][d+1]) */
/* (defined in ho_rev.mc) */
ADOLC_DLL_EXPORT int hos_ti_reverse(short,int,int,int,double**,double**);
/* now pack the arrays into vectors for Fortran calling */
ADOLC_DLL_EXPORT fint hos_ti_reverse_(
fint*,fint*,fint*,fint*,fdouble*,fdouble*);
/*--------------------------------------------------------------------------*/
/* HOS_OV */
/* hos_ov_reverse(tag, m, n, d, u[m], Z[n][d+1]) */
/* (defined in ho_rev.mc) */
ADOLC_DLL_EXPORT int hos_ov_reverse(short,int,int,int,int,double**,double***);
/* now pack the arrays into vectors for Fortran calling */
ADOLC_DLL_EXPORT fint hos_ov_reverse_(
fint*,fint*,fint*,fint*,fint*,fdouble*,fdouble***);
/*--------------------------------------------------------------------------*/
/* FOV */
/* fov_reverse(tag, m, n, p, U[p][m], Z[p][n]) */
/* (defined in fo_rev.mc) */
ADOLC_DLL_EXPORT int fov_reverse(short,int,int,int,double**,double**);
/* now pack the arrays into vectors for Fortran calling */
ADOLC_DLL_EXPORT fint fov_reverse_(fint*,fint*,fint*,fint*,fdouble*,fdouble*);
/*--------------------------------------------------------------------------*/
/* HOV */
/* hov_reverse(tag, m, n, d, p, U[p][m], Z[p][n][d+1], nz[p][n]) */
/* (defined in ho_rev.mc) */
ADOLC_DLL_EXPORT int hov_reverse(
short,int,int,int,int,double**,double***,short**);
/* now pack the arrays into vectors for Fortran calling */
ADOLC_DLL_EXPORT fint hov_reverse_(
fint*,fint*,fint*,fint*,fint*,fdouble*,fdouble*);
/*--------------------------------------------------------------------------*/
/* HOV_TI */
/* hov_ti_reverse(tag, m, n, d, p, U[p][m][d+1], Z[p][n][d+1], nz[p][n]) */
/* (defined in ho_rev.mc) */
ADOLC_DLL_EXPORT int hov_ti_reverse(
short,int,int,int,int,double***,double***,short**);
/* now pack the arrays into vectors for Fortran calling */
ADOLC_DLL_EXPORT fint hov_ti_reverse_(
fint*,fint*,fint*,fint*,fint*,fdouble*,fdouble*);
/****************************************************************************/
/* BIT PATTERN UTILITIES */
/*--------------------------------------------------------------------------*/
/* INT_REV, TIGHT */
/* int_reverse_tight(tag, m, n, q, U[q][m], Z[q][n]) */
ADOLC_DLL_EXPORT int int_reverse_tight
(short, int, int, int, unsigned long int**, unsigned long int**);
/*--------------------------------------------------------------------------*/
/* INT_REV, SAFE */
/* int_reverse_safe(tag, m, n, q, U[q][m], Z[q][n]) */
ADOLC_DLL_EXPORT int int_reverse_safe
(short, int, int, int, unsigned long int**, unsigned long int**);
/*--------------------------------------------------------------------------*/
ADOLC_DLL_EXPORT int get_num_switches(short);
ADOLC_DLL_EXPORT int zos_pl_forward(short,int,int,int,const double*,double*,double*);
ADOLC_DLL_EXPORT short firstsign(int, double*, double*);
ADOLC_DLL_EXPORT short ext_firstsign(double,double,int,double*,double*);
ADOLC_DLL_EXPORT short ext_firstsign2(double,int,double*,double*);
ADOLC_DLL_EXPORT int fos_pl_forward(short,int,int,const double*,double*,double*,double*,double*,double*);
ADOLC_DLL_EXPORT int fov_pl_forward(short,int,int,int,const double*,double**,double*,double**,double*,double**,short*);
ADOLC_DLL_EXPORT int fos_pl_sig_forward(short,int,int,const double*,double*,int,short*,short*,double*,double*,double*,double*,short*);
ADOLC_DLL_EXPORT int fov_pl_sig_forward(short,int,int,int,const double*,double**,int,short*,short*,double*,double**,double*,double**,short*);
ADOLC_DLL_EXPORT int indopro_forward_absnormal(short,int,int,int,const double*,unsigned int**);
/*--------------------------------------------------------------------------*/
ADOLC_DLL_EXPORT int fos_pl_reverse(short,int,int,int,int,double*);
ADOLC_DLL_EXPORT int fos_pl_sig_reverse(short,int,int,int,short*,double*,double*);
END_C_DECLS
#endif
|