MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
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:
Inheritance graph
[legend]

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")
 

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
 

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" 
)

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 
)
void MoochoPack::ReducedHessianSerialization_Step::finalize_step ( Algorithm algo,
poss_type  step_poss,
IterationPack::EDoStepType  type,
poss_type  assoc_step_poss 
)
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

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