MoochoPack::ReducedHessianSerialization_Step Class Reference

Serializes rHL_k to and from a file. More...

#include <MoochoPack_ReducedHessianSerialization_Step.hpp>

Inheritance diagram for MoochoPack::ReducedHessianSerialization_Step:

Public Member Functions
	STANDARD_MEMBER_COMPOSITION_MEMBERS (std::string, reduced_hessian_input_file_name)
	Pick the file name to read in the reduced Hessian from. More...
	STANDARD_MEMBER_COMPOSITION_MEMBERS (std::string, reduced_hessian_output_file_name)
	Pick the file name to write in the reduced Hessian to. More...
	ReducedHessianSerialization_Step (const std::string &reduced_hessian_input_file_name="reduced_hessian.in", const std::string &reduced_hessian_output_file_name="reduced_hessian.out")
Public Member Functions inherited from IterationPack::AlgorithmStep
virtual	~AlgorithmStep ()
virtual void	initialize_step (Algorithm &algo, poss_type step_poss, EDoStepType type, poss_type assoc_step_poss)
	Called by Algorithm just before the algorithm is run. More...
virtual void	inform_updated (Algorithm &algo, poss_type step_poss, EDoStepType type, poss_type assoc_step_poss)
	Called by Algorithm to inform when a runtime configuration change is finihed. More...

Overridden from AlgorithmStep
bool	do_step (Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
void	finalize_step (Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
void	print_step (const Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss, std::ostream &out, const std::string &leading_str) const

Additional Inherited Members
Public Types inherited from IterationPack::AlgorithmStep
typedef size_t	poss_type

Detailed Description

Serializes rHL_k to and from a file.

ToDo: Finish documentation!

Definition at line 57 of file MoochoPack_ReducedHessianSerialization_Step.hpp.

Constructor & Destructor Documentation

MoochoPack::ReducedHessianSerialization_Step::ReducedHessianSerialization_Step	(	const std::string &	reduced_hessian_input_file_name = "reduced_hessian.in",
		const std::string &	reduced_hessian_output_file_name = "reduced_hessian.out"
	)

Definition at line 61 of file MoochoPack_ReducedHessianSerialization_Step.cpp.

Member Function Documentation

MoochoPack::ReducedHessianSerialization_Step::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	std::string	,
		reduced_hessian_input_file_name
	)

Pick the file name to read in the reduced Hessian from.

MoochoPack::ReducedHessianSerialization_Step::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	std::string	,
		reduced_hessian_output_file_name
	)

Pick the file name to write in the reduced Hessian to.

bool MoochoPack::ReducedHessianSerialization_Step::do_step ( Algorithm &  algo, poss_type  step_poss, IterationPack::EDoStepType  type, poss_type  assoc_step_poss  )

virtual

Implements IterationPack::AlgorithmStep.

Definition at line 71 of file MoochoPack_ReducedHessianSerialization_Step.cpp.

void MoochoPack::ReducedHessianSerialization_Step::finalize_step ( Algorithm &  algo, poss_type  step_poss, IterationPack::EDoStepType  type, poss_type  assoc_step_poss  )

virtual

Reimplemented from IterationPack::AlgorithmStep.

Definition at line 142 of file MoochoPack_ReducedHessianSerialization_Step.cpp.

void MoochoPack::ReducedHessianSerialization_Step::print_step ( const Algorithm &  algo, poss_type  step_poss, IterationPack::EDoStepType  type, poss_type  assoc_step_poss, std::ostream &  out, const std::string &  leading_str  ) const

virtual

Reimplemented from IterationPack::AlgorithmStep.

Definition at line 178 of file MoochoPack_ReducedHessianSerialization_Step.cpp.

---

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

• MoochoPack_ReducedHessianSerialization_Step.hpp
• MoochoPack_ReducedHessianSerialization_Step.cpp