EstimatorManagerInput Class Reference

Input type for EstimatorManagerNew Parses Estimators level of input and and delegates child estimator nodes to appropriate estimator input class Will later provide access to estimator input instances for estimator construction. More...

Collaboration diagram for EstimatorManagerInput:

Public Member Functions
	EstimatorManagerInput ()=default
	EstimatorManagerInput (const EstimatorManagerInput &emi)=default
	EstimatorManagerInput (EstimatorManagerInput &&emi)=default
EstimatorManagerInput &	operator= (const EstimatorManagerInput &emi)=default
EstimatorManagerInput &	operator= (EstimatorManagerInput &&emi)=default
	EstimatorManagerInput (std::initializer_list< EstimatorManagerInput > emil)
	EstimatorManagerInput (xmlNodePtr cur)
EstimatorInputs &	get_estimator_inputs ()
ScalarEstimatorInputs &	get_scalar_estimator_inputs ()
void	readXML (xmlNodePtr cur)
	read <estimators> node or (<estimator> node for legacy support) This can be done multiple times with <estimators> nodes or with <estimator> nodes to support deprecated bare <estimator> definitions More...
void	append (const EstimatorInput &ei)
	typed appending of already parsed inputs. More...
void	append (const ScalarEstimatorInput &sei)

Private Member Functions
template<typename T >
void	appendEstimatorInput (xmlNodePtr node)
template<typename T >
void	appendScalarEstimatorInput (xmlNodePtr node)

Private Attributes
EstimatorInputs	estimator_inputs_
	this is a vector of variants for typesafe access to the estimator inputs More...
ScalarEstimatorInputs	scalar_estimator_inputs_

Friends
class	testing::EstimatorManagerInputTests

Detailed Description

Input type for EstimatorManagerNew Parses Estimators level of input and and delegates child estimator nodes to appropriate estimator input class Will later provide access to estimator input instances for estimator construction.

Definition at line 68 of file EstimatorManagerInput.h.

Constructor & Destructor Documentation

EstimatorManagerInput() [1/5]

EstimatorManagerInput ( )

default

EstimatorManagerInput() [2/5]

EstimatorManagerInput ( const EstimatorManagerInput &  emi )

default

EstimatorManagerInput() [3/5]

EstimatorManagerInput ( EstimatorManagerInput &&  emi )

default

EstimatorManagerInput() [4/5]

EstimatorManagerInput

(

std::initializer_list< EstimatorManagerInput >

emil

)

Definition at line 21 of file EstimatorManagerInput.cpp.

References copy(), qmcplusplus::emi(), EstimatorManagerInput::estimator_inputs_, and EstimatorManagerInput::scalar_estimator_inputs_.

{
  // \todo the following code fusing two vectors can be written in more consice way with std::back_inserter. See history.
  // Right now needs to use a clumsy way to make intel classic compiler 19.1.x happy when using gcc 9 on some OS distros.
  size_t est_offset        = 0;
  size_t scalar_est_offset = 0;
  for (const EstimatorManagerInput& emi : emil)
  {
    est_offset += emi.estimator_inputs_.size();
    scalar_est_offset += emi.scalar_estimator_inputs_.size();
  }
  estimator_inputs_.resize(est_offset);
  scalar_estimator_inputs_.resize(scalar_est_offset);

  est_offset        = 0;
  scalar_est_offset = 0;
  for (const EstimatorManagerInput& emi : emil)
  {
    std::copy(emi.estimator_inputs_.begin(), emi.estimator_inputs_.end(), estimator_inputs_.begin() + est_offset);
    est_offset += emi.estimator_inputs_.size();
    std::copy(emi.scalar_estimator_inputs_.begin(), emi.scalar_estimator_inputs_.end(),
              scalar_estimator_inputs_.begin() + scalar_est_offset);
    scalar_est_offset += emi.scalar_estimator_inputs_.size();
  }
}

EstimatorManagerInput() [5/5]

EstimatorManagerInput

(

xmlNodePtr

cur

)

Definition at line 19 of file EstimatorManagerInput.cpp.

References EstimatorManagerInput::readXML().

{ readXML(cur); }

Member Function Documentation

append() [1/2]

void append

(

const EstimatorInput &

ei

)

typed appending of already parsed inputs.

only used in testing.

Definition at line 113 of file EstimatorManagerInput.cpp.

References EstimatorManagerInput::estimator_inputs_.

Referenced by qmcplusplus::TEST_CASE().

{ estimator_inputs_.emplace_back(ei); }

append() [2/2]

void append

(

const ScalarEstimatorInput &

sei

)

Definition at line 114 of file EstimatorManagerInput.cpp.

References EstimatorManagerInput::scalar_estimator_inputs_.

{ scalar_estimator_inputs_.emplace_back(sei); }

appendEstimatorInput()

void appendEstimatorInput ( xmlNodePtr  node )

inlineprivate

Definition at line 100 of file EstimatorManagerInput.h.

References EstimatorManagerInput::estimator_inputs_, and qmcplusplus::node.

Referenced by EstimatorManagerInputTests::testAppendFromXML().

  {
    estimator_inputs_.emplace_back(std::in_place_type<T>, node);
  }

appendScalarEstimatorInput()

void appendScalarEstimatorInput ( xmlNodePtr  node )

inlineprivate

Definition at line 106 of file EstimatorManagerInput.h.

References qmcplusplus::node, and EstimatorManagerInput::scalar_estimator_inputs_.

  {
    scalar_estimator_inputs_.emplace_back(std::in_place_type<T>, node);
  }

get_estimator_inputs()

EstimatorInputs& get_estimator_inputs ( )

inline

Definition at line 80 of file EstimatorManagerInput.h.

References EstimatorManagerInput::estimator_inputs_.

Referenced by EstimatorManagerNew::EstimatorManagerNew(), and qmcplusplus::TEST_CASE().

{ return estimator_inputs_; }

get_scalar_estimator_inputs()

ScalarEstimatorInputs& get_scalar_estimator_inputs ( )

inline

Definition at line 81 of file EstimatorManagerInput.h.

References EstimatorManagerInput::scalar_estimator_inputs_.

Referenced by EstimatorManagerNew::EstimatorManagerNew(), and qmcplusplus::TEST_CASE().

{ return scalar_estimator_inputs_; }

operator=() [1/2]

EstimatorManagerInput& operator= ( const EstimatorManagerInput &  emi )

default

operator=() [2/2]

EstimatorManagerInput& operator= ( EstimatorManagerInput &&  emi )

default

readXML()

void readXML

(

xmlNodePtr

cur

)

read <estimators> node or (<estimator> node for legacy support) This can be done multiple times with <estimators> nodes or with <estimator> nodes to support deprecated bare <estimator> definitions

Definition at line 47 of file EstimatorManagerInput.cpp.

References qmcplusplus::app_summary(), qmcplusplus::app_warning(), castXMLCharToChar(), getXMLAttributeValue(), and qmcplusplus::lowerCase().

Referenced by EstimatorManagerInput::EstimatorManagerInput().

{
  const std::string error_tag{"EstimatorManager input:"};
  std::string cur_name{lowerCase(castXMLCharToChar(cur->name))};
  xmlNodePtr child;
  if (cur_name == "estimators")
    child = cur->xmlChildrenNode;
  else
    child = cur; // the case when 'estimator's are not encapsulated by a 'estimators' node
  while (child != NULL)
  {
    std::string cname{lowerCase(castXMLCharToChar(child->name))};
    if (cname == "estimator")
    {
      std::string atype(lowerCase(getXMLAttributeValue(child, "type")));
      std::string aname(lowerCase(getXMLAttributeValue(child, "name")));
      if (atype.empty() && !aname.empty())
        atype = aname;
      if (aname.empty() && !atype.empty())
        aname = atype;
      if (atype == "localenergy" || atype == "elocal")
        appendScalarEstimatorInput<LocalEnergyInput>(child);
      else if (atype == "cslocalenergy")
      {
        appendScalarEstimatorInput<CSLocalEnergyInput>(child);
        app_warning() << "CSLocalEnergyEstimator support is at best experimental with batch drivers" << std::endl;
      }
      else if (atype == "rmc")
      {
        appendScalarEstimatorInput<RMCLocalEnergyInput>(child);
        app_warning() << "RMCLocalEnergyEstimator support is at best experimental with batch drivers" << std::endl;
      }
      else if (atype == "onebodydensitymatrices")
        appendEstimatorInput<OneBodyDensityMatricesInput>(child);
      else if (atype == "spindensity")
        appendEstimatorInput<SpinDensityInput>(child);
      else if (atype == "momentumdistribution")
        appendEstimatorInput<MomentumDistributionInput>(child);
      else if (atype == "selfhealingoverlap")
        appendEstimatorInput<SelfHealingOverlapInput>(child);
      else if (atype == "perparticlehamiltonianlogger")
        appendEstimatorInput<PerParticleHamiltonianLoggerInput>(child);
      else if (atype == "magnetizationdensity")
        appendEstimatorInput<MagnetizationDensityInput>(child);
      else
        throw UniformCommunicateError(error_tag + "unparsable <estimator> node, name: " + aname + " type: " + atype +
                                      " in Estimators input.");
    }
    else if (cname != "text")
    {
      std::string atype(lowerCase(getXMLAttributeValue(child, "type")));
      std::string aname(lowerCase(getXMLAttributeValue(child, "name")));
      throw UniformCommunicateError(error_tag + "<estimators> can only contain <estimator> nodes");
    }

    if (cur_name == "estimators")
      child = child->next;
    else
    {
      app_summary() << "<estimator> nodes not contained in <estimators>...</estimators> is a deprecated input xml idiom"
                    << std::endl;
      break;
    }
  }
}

Friends And Related Function Documentation

testing::EstimatorManagerInputTests

friend class testing::EstimatorManagerInputTests

friend

Definition at line 111 of file EstimatorManagerInput.h.

Member Data Documentation

estimator_inputs_

EstimatorInputs estimator_inputs_

private

this is a vector of variants for typesafe access to the estimator inputs

Definition at line 96 of file EstimatorManagerInput.h.

Referenced by EstimatorManagerInput::append(), EstimatorManagerInput::appendEstimatorInput(), EstimatorManagerInput::EstimatorManagerInput(), and EstimatorManagerInput::get_estimator_inputs().

scalar_estimator_inputs_

ScalarEstimatorInputs scalar_estimator_inputs_

private

Definition at line 97 of file EstimatorManagerInput.h.

Referenced by EstimatorManagerInput::append(), EstimatorManagerInput::appendScalarEstimatorInput(), EstimatorManagerInput::EstimatorManagerInput(), and EstimatorManagerInput::get_scalar_estimator_inputs().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Estimators/EstimatorManagerInput.h
• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Estimators/EstimatorManagerInput.cpp