HybridEngine Class Reference

Collaboration diagram for HybridEngine:

Public Member Functions
	HybridEngine (Communicate *comm, const xmlNodePtr cur)
	HybridEngine ()
xmlNodePtr	getSelectedXML ()
void	incrementStepCounter ()
bool	queryStore (int store_num, OptimizerType method_type) const
void	addMethod (OptimizerType method)
void	addUpdates (int num_steps)

Private Types
using	FullPrecValueType = qmcplusplus::QMCTraits::FullPrecValueType
using	ValueType = qmcplusplus::QMCTraits::ValueType

Private Member Functions
bool	processXML (const xmlNodePtr cur)
	process xml node More...
int	identifyMethodIndex () const

Private Attributes
Communicate *	myComm
int	step_num_
	number of optimization steps taken More...
std::vector< OptimizerType >	opt_methods_
	list of methods known by hybrid More...
std::vector< xmlNodePtr >	saved_xml_opt_methods_
	xml saved node More...
std::vector< int >	num_updates_opt_methods_

Detailed Description

Definition at line 28 of file HybridEngine.h.

Member Typedef Documentation

FullPrecValueType

using FullPrecValueType = qmcplusplus::QMCTraits::FullPrecValueType

private

Definition at line 30 of file HybridEngine.h.

ValueType

using ValueType = qmcplusplus::QMCTraits::ValueType

private

Definition at line 31 of file HybridEngine.h.

Constructor & Destructor Documentation

HybridEngine() [1/2]

HybridEngine	(	Communicate *	comm,
		const xmlNodePtr	cur
	)

Definition at line 24 of file HybridEngine.cpp.

References HybridEngine::processXML(), and HybridEngine::step_num_.

                                                                  : myComm(comm)
{
  step_num_ = -1;
  processXML(cur);
}

HybridEngine() [2/2]

HybridEngine ( )

inline

Definition at line 60 of file HybridEngine.h.

References HybridEngine::step_num_.

{ step_num_ = 0; }

Member Function Documentation

addMethod()

void addMethod ( OptimizerType  method )

inline

Definition at line 72 of file HybridEngine.h.

References HybridEngine::opt_methods_.

{ opt_methods_.push_back(method); }

addUpdates()

void addUpdates ( int  num_steps )

inline

Definition at line 75 of file HybridEngine.h.

References HybridEngine::num_updates_opt_methods_.

{ num_updates_opt_methods_.push_back(num_steps); }

getSelectedXML()

xmlNodePtr getSelectedXML

(

)

Definition at line 69 of file HybridEngine.cpp.

References HybridEngine::identifyMethodIndex(), and HybridEngine::saved_xml_opt_methods_.

{
  return saved_xml_opt_methods_[identifyMethodIndex()];
}

identifyMethodIndex()

int identifyMethodIndex ( ) const

private

Definition at line 109 of file HybridEngine.cpp.

References HybridEngine::num_updates_opt_methods_, and HybridEngine::step_num_.

Referenced by HybridEngine::getSelectedXML().

{
  const int tot_micro_it = std::accumulate(num_updates_opt_methods_.begin(), num_updates_opt_methods_.end(), 0);
  const int pos          = step_num_ % tot_micro_it;

  int run_sum    = 0;
  int select_idx = 0;

  //Compare pos to running sum of microiterations of different methods to determine which method is being used
  for (int i = 0; i < num_updates_opt_methods_.size(); i++)
  {
    run_sum += num_updates_opt_methods_[i];
    if (run_sum > pos)
    {
      select_idx = i;
      break;
    }
  }

  return select_idx;
}

incrementStepCounter()

void incrementStepCounter ( )

inline

Definition at line 66 of file HybridEngine.h.

References HybridEngine::step_num_.

{step_num_++;}

processXML()

bool processXML ( const xmlNodePtr  cur )

private

process xml node

Definition at line 31 of file HybridEngine.cpp.

References ParameterSet::add(), qmcplusplus::app_log(), getXMLAttributeValue(), HybridEngine::num_updates_opt_methods_, HybridEngine::opt_methods_, qmcplusplus::OptimizerNames, ParameterSet::put(), and HybridEngine::saved_xml_opt_methods_.

Referenced by HybridEngine::HybridEngine().

{
  opt_methods_.clear();
  saved_xml_opt_methods_.clear();
  num_updates_opt_methods_.clear();

  xmlNodePtr cur = opt_xml->children;
  while (cur != NULL)
  {
    std::string cname((const char*)(cur->name));
    if (cname == "optimizer")
    {
      std::string children_MinMethod;
      ParameterSet m_param;
      m_param.add(children_MinMethod, "MinMethod");
      m_param.put(cur);

      if (children_MinMethod.empty())
        throw std::runtime_error("MinMethod must be given!\n");
      std::string updates_string(getXMLAttributeValue(cur, "num_updates"));
      app_log() << "HybridEngine saved MinMethod " << children_MinMethod << " num_updates = " << updates_string << '\n';
      auto iter = OptimizerNames.find(children_MinMethod);
      if (iter == OptimizerNames.end())
        throw std::runtime_error("Unknown MinMethod!\n");
      opt_methods_.push_back(iter->second);
      saved_xml_opt_methods_.push_back(cur);
      num_updates_opt_methods_.push_back(std::stoi(updates_string));
    }
    cur = cur->next;
  }

  if (saved_xml_opt_methods_.size() != 2)
    throw std::runtime_error("MinMethod hybrid needs two optimizer input blocks!\n");

  return true;
}

queryStore()

bool queryStore	(	int	store_num,
		OptimizerType	method_type
	)		const

Definition at line 75 of file HybridEngine.cpp.

References qmcplusplus::app_log(), HybridEngine::num_updates_opt_methods_, HybridEngine::opt_methods_, and HybridEngine::step_num_.

{
  bool store = false;

  int idx = 0;

  auto iter = std::find(opt_methods_.begin(), opt_methods_.end(), method);
  if (iter == opt_methods_.end())
    throw std::runtime_error("Unknown MinMethod!\n");
  else
    idx = std::distance(opt_methods_.begin(), iter);


  const int tot_micro_it = std::accumulate(num_updates_opt_methods_.begin(), num_updates_opt_methods_.end(), 0);
  const int pos          = step_num_ % tot_micro_it;
  //interval is the number of steps between stores based on the number of stores desired
  int interval = num_updates_opt_methods_[idx] / store_num;

  if (interval == 0)
  {
    app_log()
        << "Requested Number of Stored Vectors greater than number of descent steps. Storing a vector on each step."
        << std::endl;
    interval = 1;
  }
  if ((pos + 1) % interval == 0)
  {
    store = true;
  }

  return store;
}

Member Data Documentation

myComm

Communicate* myComm

private

Definition at line 34 of file HybridEngine.h.

num_updates_opt_methods_

std::vector<int> num_updates_opt_methods_

private

Definition at line 50 of file HybridEngine.h.

Referenced by HybridEngine::addUpdates(), HybridEngine::identifyMethodIndex(), HybridEngine::processXML(), and HybridEngine::queryStore().

opt_methods_

std::vector<OptimizerType> opt_methods_

private

list of methods known by hybrid

Definition at line 44 of file HybridEngine.h.

Referenced by HybridEngine::addMethod(), HybridEngine::processXML(), and HybridEngine::queryStore().

saved_xml_opt_methods_

std::vector<xmlNodePtr> saved_xml_opt_methods_

private

xml saved node

Definition at line 47 of file HybridEngine.h.

Referenced by HybridEngine::getSelectedXML(), and HybridEngine::processXML().

step_num_

int step_num_

private

number of optimization steps taken

Definition at line 38 of file HybridEngine.h.

Referenced by HybridEngine::HybridEngine(), HybridEngine::identifyMethodIndex(), HybridEngine::incrementStepCounter(), and HybridEngine::queryStore().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/QMCDrivers/Optimizers/HybridEngine.h
• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/QMCDrivers/Optimizers/HybridEngine.cpp