framework/a00932_source.html

 #ifndef COST_FUNCTION_H
 #define COST_FUNCTION_H
 #include "printable.h"
 #include <blitz/array.h>

 namespace FullPhysics {
 /****************************************************************/
 class CostFunction : public Printable<CostFunction> {
 public:
   virtual ~CostFunction() {}

 //-----------------------------------------------------------------------
 //-----------------------------------------------------------------------

   virtual void cost_function(const blitz::Array<double, 1>& X,
                         blitz::Array<double, 1>& Residual,
                         blitz::Array<double, 1>& Se,
                         blitz::Array<double, 2>& Jacobian) const = 0;

 //-----------------------------------------------------------------------
 //-----------------------------------------------------------------------

   virtual void print(std::ostream& Os) const {Os << "CostFunction";}
 };
 }
 #endif
FullPhysics::CostFunction::~CostFunction
virtual ~CostFunction()
Definition: cost_function.h:12

printable.h

FullPhysics::Printable
This is a Mixin for classes that can be printed.
Definition: printable.h:24

FullPhysics::CostFunction::print
virtual void print(std::ostream &Os) const
Print description of object.
Definition: cost_function.h:37

FullPhysics::CostFunction
This class calculates a cost function, along with a jacobian.
Definition: cost_function.h:10

FullPhysics
Contains classes to abstract away details in various Spurr Radiative Transfer software.
Definition: doxygen_python.h:1

FullPhysics::CostFunction::cost_function
virtual void cost_function(const blitz::Array< double, 1 > &X, blitz::Array< double, 1 > &Residual, blitz::Array< double, 1 > &Se, blitz::Array< double, 2 > &Jacobian) const =0
For the given value of X, calculate the residuals and jacobians.