cost_func.h

Go to the documentation of this file.

#ifndef COST_FUNC_H
#define COST_FUNC_H
#include <problem_state.h>

namespace FullPhysics {

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

class CostFunc : 
    virtual public ProblemState {

public:


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

  enum message_t {
    NONE,     
    SOLVED,   
    ERROR    
  };


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

  CostFunc()
    : c_count(0), mssg(NONE)
  {}


  virtual ~CostFunc() {}


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

  virtual double cost() = 0;


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

  virtual double cost_x(const blitz::Array<double, 1>& x)
  { parameters(x); return cost(); }


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

  virtual int num_cost_evaluations() const
  { return c_count; }


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

  virtual void zero_num_evaluations()
  { c_count = 0; }


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

  virtual message_t message() const
  { return mssg; }


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

  virtual const char * const message_str() const;


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

  virtual void print(std::ostream& Os) const 
  { Os << "CostFunc"; }


protected:


  message_t mssg;

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

  virtual void increment_num_cost_evaluations()
  { c_count++; }


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

  virtual void set_num_cost_evaluations(int count)
  { c_count = count; }


private:

  int c_count;

};
}
#endif