ObjectiveFlood Class Reference

#include <HtuNtu.h>

Inheritance diagram for ObjectiveFlood:

Public Member Functions

 ObjectiveFlood (HtuNtu *hn)
 
void operator() (double *, double *, Jacobian *) override
 computes the objective function vector y at the point x and optionally the Jacobian J More...
 
void scalex (double *x) override
 transforms the vector of "real" variables x by applying the scaling More...
 
void unscalex (double *x) override
 transforms back the vector of scaled variables x by applying the unscaling More...
 
double delta (void) const
 
- Public Member Functions inherited from ObjectiveNleInterface
 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
 

Additional Inherited Members

- Public Attributes inherited from ObjectiveNleInterface
int verbosityLocal
 
- Protected Member Functions inherited from ObjectiveNleInterface
 ~ObjectiveNleInterface ()
 
- Protected Member Functions inherited from Diagnostic
virtual ~Diagnostic ()=default
 
- Protected Attributes inherited from Diagnostic
int verbosityInstance
 

Detailed Description

objective function to determine the flood limits

See also
HtuNtu

#include <libpf/units/HtuNtu.h>

Remarks
Warning
Thread safe:
Extendable:
Platform dependencies:

Constructor & Destructor Documentation

◆ ObjectiveFlood()

ObjectiveFlood::ObjectiveFlood ( HtuNtu hn)
explicit

Member Function Documentation

◆ delta()

double ObjectiveFlood::delta ( void  ) const
inline

◆ operator()()

void ObjectiveFlood::operator() ( double *  x,
double *  y,
Jacobian J 
)
overridevirtual

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

Implements ObjectiveNleInterface.

◆ scalex()

void ObjectiveFlood::scalex ( double *  x)
overridevirtual

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

Implements ObjectiveNleInterface.

◆ unscalex()

void ObjectiveFlood::unscalex ( double *  x)
overridevirtual

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

Implements ObjectiveNleInterface.


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