FullPhysics::InitialGuess Class Reference

This gets the initial guess and the apriori state vector values. More...

#include <initial_guess.h>

Inheritance diagram for FullPhysics::InitialGuess:

Collaboration diagram for FullPhysics::InitialGuess:

Public Member Functions
virtual	~InitialGuess ()
virtual blitz::Array< double, 1 >	apriori () const =0
	Return the apriori state vector to use. More...
virtual blitz::Array< double, 2 >	apriori_covariance () const =0
	Return the apriori state vector covariance to use. More...
virtual blitz::Array< double, 1 >	initial_guess () const =0
	Return the initial state vector to use. More...
virtual void	print (std::ostream &Os) const
	Print description of object. More...
std::string	print_to_string () const
	Print to string. More...

Detailed Description

This gets the initial guess and the apriori state vector values.

Often but not always the initial guess to use is the same as the a priori.

Definition at line 12 of file initial_guess.h.

Constructor & Destructor Documentation

~InitialGuess()

virtual FullPhysics::InitialGuess::~InitialGuess ( )

inlinevirtual

Definition at line 14 of file initial_guess.h.

Member Function Documentation

apriori()

virtual blitz::Array<double, 1> FullPhysics::InitialGuess::apriori ( ) const

pure virtual

Return the apriori state vector to use.

Implemented in FullPhysics::CompositeInitialGuess.

apriori_covariance()

virtual blitz::Array<double, 2> FullPhysics::InitialGuess::apriori_covariance ( ) const

pure virtual

Return the apriori state vector covariance to use.

Implemented in FullPhysics::CompositeInitialGuess.

initial_guess()

virtual blitz::Array<double, 1> FullPhysics::InitialGuess::initial_guess ( ) const

pure virtual

Return the initial state vector to use.

Implemented in FullPhysics::CompositeInitialGuess.

print()

virtual void FullPhysics::InitialGuess::print ( std::ostream &  Os ) const

inlinevirtual

Print description of object.

Reimplemented in FullPhysics::CompositeInitialGuess.

Definition at line 38 of file initial_guess.h.

print_to_string()

std::string FullPhysics::Printable< InitialGuess >::print_to_string ( ) const

inlineinherited

Print to string.

This is primarily useful for SWIG wrappers to this class, e.g. a to_s method in ruby.

Definition at line 31 of file printable.h.

---

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

• Interface/initial_guess.h