psdrivers.h

Go to the documentation of this file.

/*----------------------------------------------------------------------------
 ADOL-C -- Automatic Differentiation by Overloading in C++
 File:     drivers/psdrivers.h
 Revision: $Id$
 Contents: Easy to use drivers for piecewise smooth functions
           (with C and C++ callable interfaces including Fortran
           callable versions).
 
 Copyright (c) Andrea Walther, Sabrina Fiege
 
 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_DRIVERS_PSDRIVERS_H)
#define ADOLC_DRIVERS_PSDRIVERS_H 1
 
#include <adolc/adolcexport.h>
#include <adolc/drivers/absnormalform.h>
#include <adolc/interfaces.h>
#include <adolc/internal/common.h>
#include <span>
 
namespace ADOLC {
enum class UpdateConsts {
  True,
  False,
};
 
template <UpdateConsts uc = UpdateConsts::True>
ADOLC_API int abs_normal(short tapeId, std::span<const double> x,
                         AbsNormalForm &anf);
 
template <>
ADOLC_API int abs_normal<UpdateConsts::True>(short tapeId,
                                             std::span<const double> x,
                                             AbsNormalForm &anf);
template <>
ADOLC_API int abs_normal<UpdateConsts::False>(short tapeId,
                                              std::span<const double> x,
                                              AbsNormalForm &anf);
 
} // namespace ADOLC
BEGIN_C_DECLS
 
/****************************************************************************/
/*                                                 DRIVERS FOR PS FUNCTIONS */
 
/*--------------------------------------------------------------------------*/
/*                                             directional_active_gradient_ */
/*                                                                          */
ADOLC_API fint directional_active_gradient_(fint, fint, double *, double *,
                                            double *, double **, short *);
/*--------------------------------------------------------------------------*/
/*                                              directional_active_gradient */
/*                                                                          */
ADOLC_API int
directional_active_gradient(short tag,       /* trace identifier */
                            int n,           /* number of independents */
                            const double *x, /* value of independents */
                            const double *d, /* direction */
                            double *g,       /* directional active gradient */
                            short *sigma_g   /* sigma of g */
);
 
/*--------------------------------------------------------------------------*/
/*                                                          abs-normal form */
ADOLC_API fint abs_normal_(fint *ftag, fint *fdepen, fint *findep, fint *fswchk,
                           fdouble *fx, fdouble *fy, fdouble *fz, fdouble *fcz,
                           fdouble *fcy, fdouble *fJ, fdouble *fY, fdouble *fZ,
                           fdouble *fL);
ADOLC_API int abs_normal(short tag, int m, int n, int swchk, const double *x,
                         double *y, double *z, double **Y, double **J,
                         double **Z, double **L);
 
END_C_DECLS
 
/****************************************************************************/
 
#endif