ObjectiveNleInterface Class Referenceabstract

#include <ObjectiveNleInterface.h>

Inheritance diagram for ObjectiveNleInterface:

Public Member Functions

 ObjectiveNleInterface (void)
 
virtual void operator() (double *x, double *y, Jacobian *J)=0
 computes the objective function vector y at the point x and optionally the Jacobian J More...
 
virtual void scalex (double *x)=0
 transforms the vector of "real" variables x by applying the scaling More...
 
virtual void unscalex (double *x)=0
 transforms back the vector of scaled variables x by applying the unscaling More...
 
- Public Member Functions inherited from Diagnostic
 Diagnostic (void)
 
void setVerbosity (int verbosity)
 sets the verbosity level for this instance More...
 
int verbosity (void) const
 

Public Attributes

int verbosityLocal
 

Protected Member Functions

 ~ObjectiveNleInterface ()
 
- Protected Member Functions inherited from Diagnostic
virtual ~Diagnostic ()=default
 

Additional Inherited Members

- Protected Attributes inherited from Diagnostic
int verbosityInstance
 

Detailed Description

objective function for NLAE base abstract class from which all objective functions should be derived

Constructor & Destructor Documentation

◆ ~ObjectiveNleInterface()

ObjectiveNleInterface::~ObjectiveNleInterface ( )
inlineprotected

◆ ObjectiveNleInterface()

ObjectiveNleInterface::ObjectiveNleInterface ( void  )
inline

Member Function Documentation

◆ operator()()

virtual void ObjectiveNleInterface::operator() ( double *  x,
double *  y,
Jacobian J 
)
pure virtual

computes the objective function vector y at the point x and optionally the Jacobian J

Implemented in ObjectiveNleAdVertex, ObjectiveLoad, ObjectiveFlood, ObjectiveNleAd, and ObjectiveNleAuto.

◆ scalex()

virtual void ObjectiveNleInterface::scalex ( double *  x)
pure virtual

transforms the vector of "real" variables x by applying the scaling

Implemented in ObjectiveNleAuto, ObjectiveNleAd, ObjectiveLoad, and ObjectiveFlood.

◆ unscalex()

virtual void ObjectiveNleInterface::unscalex ( double *  x)
pure virtual

transforms back the vector of scaled variables x by applying the unscaling

Implemented in ObjectiveNleAd, ObjectiveNleAdVertex, ObjectiveNleAuto, ObjectiveLoad, and ObjectiveFlood.

Member Data Documentation

◆ verbosityLocal

int ObjectiveNleInterface::verbosityLocal

The documentation for this class was generated from the following file: