This is a simple implementation of InitialGuessBuilder that just has variables used to give the apriori, initial guess, and covariance. More...

#include <initial_guess_value.h>

Inheritance diagram for FullPhysics::InitialGuessValue:

Collaboration diagram for FullPhysics::InitialGuessValue:

Public Member Functions
virtual	~InitialGuessValue ()

const blitz::Array< double, 1 > &	apriori () const
	Apriori value. More...

void	apriori (const blitz::Array< double, 1 > &v)
	Set apriori value. More...

const blitz::Array< double, 2 > &	apriori_covariance () const
	Apriori covariance value. More...

void	apriori_covariance (const blitz::Array< double, 2 > &m)
	Set apriori covariance value. More...

void	apriori_covariance_subset (const blitz::Array< bool, 1 > &Flag, const blitz::Array< double, 2 > &V)
	Subset a value to include only those elements where Flag is true. More...

void	apriori_subset (const blitz::Array< bool, 1 > &Flag, const blitz::Array< double, 1 > &V)
	Subset a value to include only those elements where Flag is true. More...

virtual void	attach_notify (CompositeInitialGuess &Comp_ig)
	Called when we get attached to a CompositeInitialGuess. More...

virtual void	build_apriori (blitz::Array< double, 1 > &v, int index) const
	Called when we need this class to do its part in setting up the apriori state vector. More...

virtual void	build_apriori_covariance (blitz::Array< double, 2 > &m, int index) const
	Called when we need this class to do its part in setting up the covariance matrix for the a priori state vector. More...

virtual void	build_initial_value (blitz::Array< double, 1 > &v, int index) const
	Called when we need this class to do its part in setting up the initial state vector. More...

const blitz::Array< double, 1 > &	initial_guess () const
	First guess value. More...

void	initial_guess (const blitz::Array< double, 1 > &v)
	Set first guess value. More...

void	initial_guess_subset (const blitz::Array< bool, 1 > &Flag, const blitz::Array< double, 1 > &V)
	Subset a value to include only those elements where Flag is true. More...

virtual int	number_element () const
	Number of elements we will be adding to the state vector. More...

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

std::string	print_to_string () const
	Print to string. More...

Detailed Description

This is a simple implementation of InitialGuessBuilder that just has variables used to give the apriori, initial guess, and covariance.

Since the initial guess of often just the apriori, the initial guess is allowed to be left empty and we just use the apriori in that case.

Definition at line 14 of file initial_guess_value.h.

Constructor & Destructor Documentation

◆ ~InitialGuessValue()

virtual FullPhysics::InitialGuessValue::~InitialGuessValue ( )

inlinevirtual

Definition at line 16 of file initial_guess_value.h.

Member Function Documentation

◆ apriori() [1/2]

const blitz::Array<double, 1>& FullPhysics::InitialGuessValue::apriori ( ) const

inline

Apriori value.

Definition at line 28 of file initial_guess_value.h.

◆ apriori() [2/2]

void FullPhysics::InitialGuessValue::apriori ( const blitz::Array< double, 1 > & v )

inline

Set apriori value.

Definition at line 34 of file initial_guess_value.h.

◆ apriori_covariance() [1/2]

const blitz::Array<double, 2>& FullPhysics::InitialGuessValue::apriori_covariance ( ) const

inline

Apriori covariance value.

Definition at line 47 of file initial_guess_value.h.

◆ apriori_covariance() [2/2]

void FullPhysics::InitialGuessValue::apriori_covariance ( const blitz::Array< double, 2 > & m )

inline

Set apriori covariance value.

Definition at line 54 of file initial_guess_value.h.

◆ apriori_covariance_subset()

void InitialGuessValue::apriori_covariance_subset	(	const blitz::Array< bool, 1 > &	Flag,
		const blitz::Array< double, 2 > &	V
	)

Subset a value to include only those elements where Flag is true.

Definition at line 113 of file initial_guess_value.cc.

◆ apriori_subset()

void InitialGuessValue::apriori_subset	(	const blitz::Array< bool, 1 > &	Flag,
		const blitz::Array< double, 1 > &	V
	)

Subset a value to include only those elements where Flag is true.

Definition at line 71 of file initial_guess_value.cc.

◆ attach_notify()

virtual void FullPhysics::InitialGuessBuilder::attach_notify ( CompositeInitialGuess & Comp_ig )

inlinevirtualinherited

Called when we get attached to a CompositeInitialGuess.

The default is to do nothing, but derived classes can override this if desired.

Definition at line 28 of file composite_initial_guess.h.

◆ build_apriori()

void InitialGuessValue::build_apriori	(	blitz::Array< double, 1 > &	v,
		int	index
	)		const

virtual

Called when we need this class to do its part in setting up the apriori state vector.

Parameters

v	State vector that should be updated in place.
index	Since we are often adding to the end of the state vector, index is passed in. This is the sum of the number_elements() of all the InitialGuessBuilder that appear before this object in the list.

Implements FullPhysics::InitialGuessBuilder.

Definition at line 150 of file initial_guess_value.cc.

◆ build_apriori_covariance()

void InitialGuessValue::build_apriori_covariance	(	blitz::Array< double, 2 > &	m,
		int	index
	)		const

virtual

Called when we need this class to do its part in setting up the covariance matrix for the a priori state vector.

Parameters

m	State vector that should be updated in place.
index	Since we are often adding to the end of the state vector, index is passed in. This is the sum of the number_elements() of all the InitialGuessBuilder that appear before this object in the list.

Implements FullPhysics::InitialGuessBuilder.

Definition at line 158 of file initial_guess_value.cc.

◆ build_initial_value()

void InitialGuessValue::build_initial_value	(	blitz::Array< double, 1 > &	v,
		int	index
	)		const

virtual

Called when we need this class to do its part in setting up the initial state vector.

Parameters

v	State vector that should be updated in place.
index	Since we are often adding to the end of the state vector, index is passed in. This is the sum of the number_elements() of all the InitialGuessBuilder that appear before this object in the list.

Implements FullPhysics::InitialGuessBuilder.

Definition at line 136 of file initial_guess_value.cc.

◆ initial_guess() [1/2]

const blitz::Array<double, 1>& FullPhysics::InitialGuessValue::initial_guess ( ) const

inline

First guess value.

Definition at line 61 of file initial_guess_value.h.

◆ initial_guess() [2/2]

void FullPhysics::InitialGuessValue::initial_guess ( const blitz::Array< double, 1 > & v )

inline

Set first guess value.

Definition at line 73 of file initial_guess_value.h.

◆ initial_guess_subset()

void InitialGuessValue::initial_guess_subset	(	const blitz::Array< bool, 1 > &	Flag,
		const blitz::Array< double, 1 > &	V
	)

Subset a value to include only those elements where Flag is true.

Definition at line 92 of file initial_guess_value.cc.

◆ number_element()

virtual int FullPhysics::InitialGuessValue::number_element ( ) const

inlinevirtual

Number of elements we will be adding to the state vector.

0 is a legal value, if we are changing elements but not adding any.

Implements FullPhysics::InitialGuessBuilder.

Definition at line 17 of file initial_guess_value.h.

◆ print()

void InitialGuessValue::print ( std::ostream & Os ) const

virtual

Reimplemented from FullPhysics::InitialGuessBuilder.

Definition at line 175 of file initial_guess_value.cc.

◆ print_to_string()

std::string FullPhysics::Printable< InitialGuessBuilder >::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 files:

Implementation/initial_guess_value.h
Implementation/initial_guess_value.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~InitialGuessValue()

Member Function Documentation

◆ apriori() [1/2]

◆ apriori() [2/2]

◆ apriori_covariance() [1/2]

◆ apriori_covariance() [2/2]

◆ apriori_covariance_subset()

◆ apriori_subset()

◆ attach_notify()

◆ build_apriori()

◆ build_apriori_covariance()

◆ build_initial_value()

◆ initial_guess() [1/2]

◆ initial_guess() [2/2]

◆ initial_guess_subset()

◆ number_element()

◆ print()

◆ print_to_string()