GPLIB++
Public Member Functions | List of all members
gplib::PlottableObjective Class Reference

This only adds a few plotting functions to GeneralObjective to define a common interface. More...

#include <PlottableObjective.h>

Inheritance diagram for gplib::PlottableObjective:
Inheritance graph
[legend]

Public Member Functions

virtual void WriteModel (const std::string &filename)
 write the current model to a file More...
 
virtual void WritePlot (const std::string &filename)
 write the current model for plotting to a file More...
 
virtual void WriteData (const std::string &filename)
 Write current data to a file. More...
 
 PlottableObjective ()
 
 PlottableObjective (const PlottableObjective &Old)
 
PlottableObjective & operator= (const PlottableObjective &source)
 
virtual ~PlottableObjective ()
 
- Public Member Functions inherited from gplib::GeneralObjective
void SetFitExponent (const int x)
 Set the Fit exponent. More...
 
int GetFitExponent ()
 Get the Fit exponent. More...
 
double GetRMS ()
 Get the current RMS. More...
 
const std::string & GetParallelID ()
 Derived classes need to read the ParallelId for their forward calculations. More...
 
void SetParallelID (const std::string &s)
 We need to set the parallel ID outside the Objective function object. More...
 
const tmisfit & GetMisfit ()
 Return the misfit vector. More...
 
const tdata & GetSynthData ()
 Return the current synthetic data. More...
 
virtual GeneralObjective * clone () const =0
 We need clone and create for building an array of derived objects, see FAQ lite 20.8, the return type depends on the derived class. More...
 
virtual void PreParallel (const ttranscribed &member)
 Some operations cannot be done in parallel, these are done before. More...
 
virtual double PostParallel (const ttranscribed &member)=0
 Some operations cannot be done in parallel, these are done after, returns the misfit value. More...
 
virtual void SafeParallel (const ttranscribed &member)
 The core performance calculation, has to be safe to be done in parallel. More...
 
double CalcPerformance (const ttranscribed &member)
 For serial execution CalcPerformance calls the three Parallel functions for more convenient use. More...
 
 GeneralObjective ()
 
 GeneralObjective (const GeneralObjective &Old)
 
GeneralObjective & operator= (const GeneralObjective &source)
 
virtual ~GeneralObjective ()
 

Additional Inherited Members

- Protected Member Functions inherited from gplib::GeneralObjective
double CalcMisfit (const double measured, const double predicted, const double measerror, const double errorlevel, const int index)
 
void SetRMS (const double x)
 
tmisfit & SetMisfit ()
 Only derived classes can write access the Misfit. More...
 
void SetMisfit (const tmisfit &LocalMisfit)
 
tdata & SetSynthData ()
 Only derived classes can write access the Synthetic data. More...
 
void SetSynthData (const tdata &LocalSynthData)
 

Detailed Description

This only adds a few plotting functions to GeneralObjective to define a common interface.

Definition at line 10 of file PlottableObjective.h.

Constructor & Destructor Documentation

gplib::PlottableObjective::PlottableObjective ( )

Definition at line 4 of file PlottableObjective.cpp.

gplib::PlottableObjective::PlottableObjective ( const PlottableObjective &  Old)
inline

Definition at line 26 of file PlottableObjective.h.

gplib::PlottableObjective::~PlottableObjective ( )
virtual

Definition at line 8 of file PlottableObjective.cpp.

Member Function Documentation

PlottableObjective & gplib::PlottableObjective::operator= ( const PlottableObjective &  source)
virtual void gplib::PlottableObjective::WriteData ( const std::string &  filename)
inlinevirtual
virtual void gplib::PlottableObjective::WriteModel ( const std::string &  filename)
inlinevirtual
virtual void gplib::PlottableObjective::WritePlot ( const std::string &  filename)
inlinevirtual

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