ProteoWizard
Public Types | Public Member Functions | Static Public Member Functions | List of all members
pwiz::frequency::ParameterEstimator Class Referenceabstract

#include <ParameterEstimator.hpp>

Public Types

typedef ParametrizedFunction< std::complex< double > > Function
 
typedef data::SampleDatum< double, std::complex< double > > Datum
 
typedef std::vector< DatumData
 
typedef ublas::vector< double > Parameters
 

Public Member Functions

virtual ~ParameterEstimator ()
 
virtual const Parametersestimate () const =0
 
virtual void estimate (const Parameters &p)=0
 
virtual double error () const =0
 
virtual double iterate (std::ostream *log=0)=0
 

Static Public Member Functions

static std::auto_ptr< ParameterEstimatorcreate (const Function &function, const Data &data, const Parameters &initialEstimate)
 

Detailed Description

Definition at line 39 of file ParameterEstimator.hpp.

Member Typedef Documentation

§ Function

Definition at line 43 of file ParameterEstimator.hpp.

§ Datum

typedef data::SampleDatum<double, std::complex<double> > pwiz::frequency::ParameterEstimator::Datum

Definition at line 44 of file ParameterEstimator.hpp.

§ Data

Definition at line 45 of file ParameterEstimator.hpp.

§ Parameters

typedef ublas::vector<double> pwiz::frequency::ParameterEstimator::Parameters

Definition at line 46 of file ParameterEstimator.hpp.

Constructor & Destructor Documentation

§ ~ParameterEstimator()

virtual pwiz::frequency::ParameterEstimator::~ParameterEstimator ( )
inlinevirtual

Definition at line 52 of file ParameterEstimator.hpp.

References error(), estimate(), and iterate().

52 {}

Member Function Documentation

§ create()

static std::auto_ptr<ParameterEstimator> pwiz::frequency::ParameterEstimator::create ( const Function function,
const Data data,
const Parameters initialEstimate 
)
static

§ estimate() [1/2]

virtual const Parameters& pwiz::frequency::ParameterEstimator::estimate ( ) const
pure virtual

Referenced by ~ParameterEstimator().

§ estimate() [2/2]

virtual void pwiz::frequency::ParameterEstimator::estimate ( const Parameters p)
pure virtual

§ error()

virtual double pwiz::frequency::ParameterEstimator::error ( ) const
pure virtual

Referenced by ~ParameterEstimator().

§ iterate()

virtual double pwiz::frequency::ParameterEstimator::iterate ( std::ostream *  log = 0)
pure virtual

Referenced by ~ParameterEstimator().


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