The state for a problem that only its cost function is implemented. More...

#include <cost_func_state.h>

Inheritance diagram for FullPhysics::CostFuncState:

Collaboration diagram for FullPhysics::CostFuncState:

Public Member Functions
	CostFuncState ()
	Default constructor. More...

	CostFuncState (const CostFuncState &s)
	Copy constructor. More...

virtual	~CostFuncState ()

virtual void	assert_parameter_correct (const blitz::Array< double, 1 > &x) const
	Checks that the new input parameters are correct. More...

virtual void	assert_parameter_set_correctly () const
	Checks that the parameters are set correctly. More...

virtual void	clear ()
	Deletes data contents. More...

virtual int	expected_parameter_size () const
	Returns the expected size of the parameters. More...

virtual int	parameter_size () const
	Returns the size of the parameters. More...

virtual void	parameters (const blitz::Array< double, 1 > &x)
	Sets the problem at a new point in the parameter space. More...

virtual blitz::Array< double, 1 >	parameters () const
	Returns the current parameters. More...

virtual bool	parameters_different (const blitz::Array< double, 1 > &x) const
	Checks whether or not new input parameters are different from the current ones. More...

virtual void	print (std::ostream &Os) const
	Prints description of object. More...

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

virtual void	set (const CostFuncState &s)
	Makes self a copy of the input state. More...

virtual void	set (const ProblemState &s)
	Makes self a copy of the input state. More...

Protected Attributes
blitz::Array< double, 1 >	C
	A cost function is a scalar function; therefore, its value at a point is also a scalar. More...

blitz::Array< double, 1 >	X

Detailed Description

The state for a problem that only its cost function is implemented.

CostFuncState is used for the problems that only their cost functions are implemented. With this class one can store the current point in the parameter space (the state) and the value of the cost function at that point.

Definition at line 17 of file cost_func_state.h.

Constructor & Destructor Documentation

◆ CostFuncState() [1/2]

FullPhysics::CostFuncState::CostFuncState ( )

inline

Default constructor.

Definition at line 27 of file cost_func_state.h.

◆ CostFuncState() [2/2]

FullPhysics::CostFuncState::CostFuncState ( const CostFuncState & s )

inline

Copy constructor.

Parameters

[in] s another CostFuncState

Definition at line 37 of file cost_func_state.h.

◆ ~CostFuncState()

virtual FullPhysics::CostFuncState::~CostFuncState ( )

inlinevirtual

Definition at line 41 of file cost_func_state.h.

Member Function Documentation

◆ assert_parameter_correct()

void ProblemState::assert_parameter_correct ( const blitz::Array< double, 1 > & x ) const

virtualinherited

Checks that the new input parameters are correct.

This method checks to see whether or not the new input parameters are correct. If the parameters are not correct then it throws an exception.

Definition at line 44 of file problem_state.cc.

◆ assert_parameter_set_correctly()

virtual void FullPhysics::ProblemState::assert_parameter_set_correctly ( ) const

inlinevirtualinherited

Checks that the parameters are set correctly.

This method checks to see whether or not the parameters are set correctly. If the parameters are not set correctly then it throws an exception.

Definition at line 197 of file problem_state.h.

◆ clear()

virtual void FullPhysics::CostFuncState::clear ( )

inlinevirtual

Deletes data contents.

This method deletes state. If needed, it must be reimplemented by other classes derived from this class to delete other saved components associated with the state as well.

Reimplemented from FullPhysics::ProblemState.

Reimplemented in FullPhysics::CostFuncDiffState.

Definition at line 65 of file cost_func_state.h.

◆ expected_parameter_size()

virtual int FullPhysics::ProblemState::expected_parameter_size ( ) const

inlinevirtualinherited

Returns the expected size of the parameters.

This method must be reimplemented by the problem class the inherits ProblemState. It is only in the context of an optimization problem that one knows what the size of the parameters (number of the dimensions of the parameter space) is.

This method is intentionally implemented here instead of being left as a pure virtual method. The intention is that the user to be able to create an object of this class or its derived classes for the purpose of preserving an older state of a problem if needed.

Returns: Expected size of parameters

Definition at line 185 of file problem_state.h.

◆ parameter_size()

virtual int FullPhysics::ProblemState::parameter_size ( ) const

inlinevirtualinherited

Returns the size of the parameters.

Returns: Size of parameters

Definition at line 163 of file problem_state.h.

◆ parameters() [1/2]

void ProblemState::parameters ( const blitz::Array< double, 1 > & x )

virtualinherited

Sets the problem at a new point in the parameter space.

The method calls parameters_different() to determine whether or not the new parameters are different:

If different, then it deletes the object state (see clear()), and the input x becomes the current state.
If not different, then the input parameters are ignored.

Parameters

[in] x New set of parameters

Reimplemented in FullPhysics::NLLSProblemScaled, FullPhysics::NLLSMaxAPosteriori, FullPhysics::NLLSMaxLikelihood, and FullPhysics::ModelMeasureStandard.

Definition at line 36 of file problem_state.cc.

◆ parameters() [2/2]

virtual blitz::Array<double, 1> FullPhysics::ProblemState::parameters ( ) const

inlinevirtualinherited

Returns the current parameters.

Returns: Current parameter

Reimplemented in FullPhysics::NLLSProblemScaled, FullPhysics::NLLSMaxAPosteriori, FullPhysics::NLLSMaxLikelihood, and FullPhysics::ModelMeasureStandard.

Definition at line 153 of file problem_state.h.

◆ parameters_different()

bool ProblemState::parameters_different ( const blitz::Array< double, 1 > & x ) const

virtualinherited

Checks whether or not new input parameters are different from the current ones.

The methods checks to see whether or not the new input parameters (point in the parameter space) are different from the parameters maintained by the object for which the method is called.

If the size of the input parameters is not equal to the expected size of the parameters (check comments on expected_parameter_size), then the method will throw an exception.

If the object for which the method is called has currently no parameters set, then the method returns true. Otherwise, the method uses some algorithm to figure out when the difference is "big enough" to be considered different. If the method determines that the new input parameters are different from the current parameters, then it returns true, otherwise, it returns false.

Parameters

[in] x New set of parameters

Definition at line 9 of file problem_state.cc.

◆ print()

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

inlinevirtual

Prints description of object.

Reimplemented from FullPhysics::ProblemState.

Reimplemented in FullPhysics::CostFuncDiffState.

Definition at line 73 of file cost_func_state.h.

◆ print_to_string()

std::string FullPhysics::Printable< ProblemState >::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.

◆ set() [1/2]

void CostFuncState::set ( const CostFuncState & s )

virtual

Makes self a copy of the input state.

This method makes the object, for which it is called, a copy of the input state.

Parameters

[in] s another CostFuncState

Definition at line 7 of file cost_func_state.cc.

◆ set() [2/2]

virtual void FullPhysics::ProblemState::set ( const ProblemState & s )

inlinevirtualinherited

Makes self a copy of the input state.

This method makes the object, for which it is called, a copy of the input state.

Parameters

[in] s another ProblemState

Definition at line 88 of file problem_state.h.

Member Data Documentation

◆ C

blitz::Array<double, 1> FullPhysics::CostFuncState::C

protected

A cost function is a scalar function; therefore, its value at a point is also a scalar.

However, here we use a 1D array to store the value of the cost function evaluated at the current point in the parameter space. The reason for using a 1D array is only for convenience. However, the details of how we store the cost function value does not appear in the class interface.

This must be used as a one element array or an empty array.

Definition at line 89 of file cost_func_state.h.

◆ X

blitz::Array<double, 1> FullPhysics::ProblemState::X

protectedinherited

Definition at line 222 of file problem_state.h.

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

Interface/cost_func_state.h
Interface/cost_func_state.cc

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CostFuncState() [1/2]

◆ CostFuncState() [2/2]

◆ ~CostFuncState()

Member Function Documentation

◆ assert_parameter_correct()

◆ assert_parameter_set_correctly()

◆ clear()

◆ expected_parameter_size()

◆ parameter_size()

◆ parameters() [1/2]

◆ parameters() [2/2]

◆ parameters_different()

◆ print()

◆ print_to_string()

◆ set() [1/2]

◆ set() [2/2]

Member Data Documentation

◆ C

◆ X