#include <Algorithm.h>

Inheritance diagram for genie::Algorithm:

Collaboration diagram for genie::Algorithm:

Public Member Functions
virtual	~Algorithm ()
virtual void	Configure (const Registry &config)
virtual void	Configure (string config)
virtual void	FindConfig (void)
virtual const Registry &	GetConfig (void) const
Registry *	GetOwnedConfig (void)
virtual const AlgId &	Id (void) const
	Get algorithm ID.
virtual AlgStatus_t	GetStatus (void) const
	Get algorithm status.
virtual bool	AllowReconfig (void) const
virtual AlgCmp_t	Compare (const Algorithm *alg) const
	Compare with input algorithm.
virtual void	SetId (const AlgId &id)
	Set algorithm ID.
virtual void	SetId (string name, string config)
const Algorithm *	SubAlg (const RgKey &registry_key) const
void	AdoptConfig (void)
void	AdoptSubstructure (void)
virtual void	Print (ostream &stream) const
	Print algorithm info.

Static Public Member Functions
static string	BuildParamVectKey (const std::string &comm_name, unsigned int i)
static string	BuildParamVectSizeKey (const std::string &comm_name)
static string	BuildParamMatKey (const std::string &comm_name, unsigned int i, unsigned int j)
static string	BuildParamMatRowSizeKey (const std::string &comm_name)
static string	BuildParamMatColSizeKey (const std::string &comm_name)

Protected Member Functions
	Algorithm ()
	Algorithm (string name)
	Algorithm (string name, string config)
void	Initialize (void)
void	DeleteConfig (void)
void	DeleteSubstructure (void)
Registry *	ExtractLocalConfig (const Registry &in) const
Registry *	ExtractLowerConfig (const Registry &in, const string &alg_key) const
	Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key.
template<class T>
bool	GetParam (const RgKey &name, T &p, bool is_top_call=true) const
template<class T>
bool	GetParamDef (const RgKey &name, T &p, const T &def) const
template<class T>
int	GetParamVect (const std::string &comm_name, std::vector< T > &v, bool is_top_call=true) const
	Handle to load vectors of parameters.
int	GetParamVectKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
template<class T>
int	GetParamMat (const std::string &comm_name, TMatrixT< T > &mat, bool is_top_call=true) const
	Handle to load matrix of parameters.
template<class T>
int	GetParamMatSym (const std::string &comm_name, TMatrixTSym< T > &mat, bool is_top_call=true) const
int	GetParamMatKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
int	AddTopRegistry (Registry *rp, bool owns=true)
	add registry with top priority, also update ownership
int	AddLowRegistry (Registry *rp, bool owns=true)
	add registry with lowest priority, also update ownership
int	MergeTopRegistry (const Registry &r)
int	AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
	Add registries with top priority, also udated Ownerships.

Protected Attributes
bool	fAllowReconfig
bool	fOwnsSubstruc
	true if it owns its substructure (sub-algs,...)
AlgId	fID
	algorithm name and configuration set
vector< Registry * >	fConfVect
vector< bool >	fOwnerships
	ownership for every registry in fConfVect
AlgStatus_t	fStatus
	algorithm execution status
AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool)

Private Attributes
Registry *	fConfig
	Summary configuration derived from fConvVect, not necessarily allocated.

Friends
ostream &	operator<< (ostream &stream, const Algorithm &alg)

Detailed Description

Algorithm abstract base class.

Author: Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool

Marco Roda <mroda \at liverpool.ac.uk> University of Liverpool

Created:\n May 02, 2004

License:\n Copyright (c) 2003-2025, The GENIE Collaboration: For the full text of the license visit http://copyright.genie-mc.org

Definition at line 54 of file Algorithm.h.

Constructor & Destructor Documentation

◆ ~Algorithm()

Algorithm::~Algorithm ( )

virtual

Definition at line 56 of file Algorithm.cxx.

{
  this->DeleteConfig();
  this->DeleteSubstructure();
}

References DeleteConfig(), and DeleteSubstructure().

◆ Algorithm() [1/3]

Algorithm::Algorithm ( )

protected

Definition at line 38 of file Algorithm.cxx.

{
  this->Initialize();
}

References Initialize().

Referenced by AdoptSubstructure(), genie::AxialFormFactorModelI::AxialFormFactorModelI(), genie::AxialFormFactorModelI::AxialFormFactorModelI(), genie::AxialFormFactorModelI::AxialFormFactorModelI(), genie::hnl::ChannelCalculatorI::ChannelCalculatorI(), genie::hnl::ChannelCalculatorI::ChannelCalculatorI(), genie::hnl::ChannelCalculatorI::ChannelCalculatorI(), Compare(), Configure(), DeleteSubstructure(), genie::DISStructureFuncModelI::DISStructureFuncModelI(), genie::DISStructureFuncModelI::DISStructureFuncModelI(), genie::DISStructureFuncModelI::DISStructureFuncModelI(), genie::ELFormFactorsModelI::ELFormFactorsModelI(), genie::ELFormFactorsModelI::ELFormFactorsModelI(), genie::ELFormFactorsModelI::ELFormFactorsModelI(), genie::EngelFormFactor::EngelFormFactor(), genie::EngelFormFactor::EngelFormFactor(), genie::EventGeneratorListAssembler::EventGeneratorListAssembler(), genie::EventGeneratorListAssembler::EventGeneratorListAssembler(), genie::EventRecordVisitorI::EventRecordVisitorI(), genie::EventRecordVisitorI::EventRecordVisitorI(), genie::EventRecordVisitorI::EventRecordVisitorI(), genie::FragmentationFunctionI::FragmentationFunctionI(), genie::FragmentationFunctionI::FragmentationFunctionI(), genie::FragmentationFunctionI::FragmentationFunctionI(), GetConfig(), genie::HadronTensorModelI::HadronTensorModelI(), genie::HadronTensorModelI::HadronTensorModelI(), genie::HadronTensorModelI::HadronTensorModelI(), genie::InteractionListAssembler::InteractionListAssembler(), genie::InteractionListAssembler::InteractionListAssembler(), genie::InteractionListGeneratorI::InteractionListGeneratorI(), genie::InteractionListGeneratorI::InteractionListGeneratorI(), genie::InteractionListGeneratorI::InteractionListGeneratorI(), genie::InteractionSelectorI::InteractionSelectorI(), genie::InteractionSelectorI::InteractionSelectorI(), genie::InteractionSelectorI::InteractionSelectorI(), genie::mueloss::MuELossI::MuELossI(), genie::mueloss::MuELossI::MuELossI(), genie::mueloss::MuELossI::MuELossI(), genie::NuclearModelI::NuclearModelI(), genie::NuclearModelI::NuclearModelI(), genie::NuclearModelI::NuclearModelI(), operator<<, genie::PDFModelI::PDFModelI(), genie::PDFModelI::PDFModelI(), genie::PDFModelI::PDFModelI(), Print(), genie::QELFormFactorsModelI::QELFormFactorsModelI(), genie::QELFormFactorsModelI::QELFormFactorsModelI(), genie::QELFormFactorsModelI::QELFormFactorsModelI(), genie::QvalueShifter::QvalueShifter(), genie::QvalueShifter::QvalueShifter(), genie::RSHelicityAmplModelI::RSHelicityAmplModelI(), genie::RSHelicityAmplModelI::RSHelicityAmplModelI(), genie::RSHelicityAmplModelI::RSHelicityAmplModelI(), genie::SmithMonizUtils::SmithMonizUtils(), genie::SmithMonizUtils::SmithMonizUtils(), SubAlg(), genie::XSecAlgorithmI::XSecAlgorithmI(), genie::XSecAlgorithmI::XSecAlgorithmI(), genie::XSecAlgorithmI::XSecAlgorithmI(), genie::XSecIntegratorI::XSecIntegratorI(), genie::XSecIntegratorI::XSecIntegratorI(), genie::XSecIntegratorI::XSecIntegratorI(), and genie::XSecScaleI::XSecScaleI().

◆ Algorithm() [2/3]

Algorithm::Algorithm ( string name )

protected

Definition at line 43 of file Algorithm.cxx.

{
  this->Initialize();
  fID.SetId(name);
}

References fID, and Initialize().

◆ Algorithm() [3/3]

Algorithm::Algorithm	(	string	name,
		string	config )

protected

Definition at line 49 of file Algorithm.cxx.

{
  this->Initialize();
  fID.SetId(name,config);
  this->FindConfig();
}

References fID, FindConfig(), and Initialize().

Member Function Documentation

◆ AddLowRegistry()

int Algorithm::AddLowRegistry	(	Registry *	rp,
		bool	owns = true )

protected

add registry with lowest priority, also update ownership

Definition at line 702 of file Algorithm.cxx.

                                                       {
 
  fConfVect.push_back( rp ) ;
  fOwnerships.push_back( own ) ;
 
  if ( fConfig ) {
    delete fConfig ;
    fConfig = 0 ;
  }
 
  return fConfVect.size() ;
 
}

References fConfig, fConfVect, and fOwnerships.

Referenced by genie::EventGenerator::Configure(), and FindConfig().

◆ AddTopRegisties()

int Algorithm::AddTopRegisties	(	const vector< Registry * > &	rs,
		bool	owns = false )

protected

Add registries with top priority, also udated Ownerships.

Definition at line 754 of file Algorithm.cxx.

                                                                       {
 
  fConfVect.insert( fConfVect.begin(), rs.begin(), rs.end() ) ;
 
  fOwnerships.insert( fOwnerships.begin(), rs.size(), own ) ;
 
  if ( fConfig ) {
    delete fConfig ;
    fConfig = 0 ;
  }
 
  return fConfVect.size() ;
 
}

References fConfig, fConfVect, and fOwnerships.

◆ AddTopRegistry()

int Algorithm::AddTopRegistry	(	Registry *	rp,
		bool	owns = true )

protected

add registry with top priority, also update ownership

Definition at line 686 of file Algorithm.cxx.

                                                       {
 
  fConfVect.insert( fConfVect.begin(), rp ) ;
  fOwnerships.insert( fOwnerships.begin(), own ) ;
 
  if ( fConfig ) {
    delete fConfig ;
    fConfig = 0 ;
  }
 
  return fConfVect.size() ;
 
}

References fConfig, fConfVect, and fOwnerships.

Referenced by genie::EventGeneratorListAssembler::AssembleGeneratorList(), FindConfig(), and MergeTopRegistry().

◆ AdoptConfig()

void Algorithm::AdoptConfig ( void )

Clone the configuration registry looked up from the configuration pool and take its ownership

Definition at line 386 of file Algorithm.cxx.

                                {
 
  LOG("Algorithm", pNOTICE)
    << this->Id().Key() << " is taking ownership of its configuration";
 
  // if(fOwnsConfig) {
  //   LOG("Algorithm", pWARN)
  //     << this->Id().Key() << " already owns its configuration!";
  //   return;
  // }
 
  this->Configure( GetConfig() );
}

References Configure(), GetConfig(), Id(), genie::AlgId::Key(), LOG, and pNOTICE.

◆ AdoptSubstructure()

void Algorithm::AdoptSubstructure ( void )

Take ownership of the algorithms subtructure (sub-algorithms,...) by copying them from the AlgFactory pool to the local pool Also bring all the configuration variables to the top level config Registry. This can be used to group together a series of algorithms & their configurations and extract (a clone of) this group from the shared pools. Having a series of algorithms/configurations behaving as a monolithic block, with a single point of configuration (the top level) is to be used when bits & pieces of GENIE are used in isolation for data fitting or reweighting

Definition at line 400 of file Algorithm.cxx.

{
// Take ownership of the algorithms subtructure (sub-algorithms,..) by copying
// them from the AlgFactory pool to the local pool. Also bring all the
// configuration variables to the top level. See the header for more details.
// A secial naming convention is required for configuration parameter keys
// for parameters belonging to sub-algorithms (or sub-algorithms of these
// sub-algorithms and so on...).
// The convention is: "sub-alg-key/sub-sub-alg-key/.../original name"
// This is a recursive method: The AdoptSubtructure()of all sub-algorithms is
// invoked.
//
  LOG("Algorithm", pNOTICE)
     << "Algorithm: " << this->Id().Key() << " is adopting its substructure";
 
//  Registry deep_config;
//  deep_config.UnLock();
//  deep_config.SetName(this->Id().Key());
 
  //  deep_config.SetName(this->Id().Config() + ";D");
  //  fID.SetConfig(this->Id().Config() + ";D");
 
  if(fOwnsSubstruc) this->DeleteSubstructure();
 
  fOwnedSubAlgMp = new AlgMap;
  fOwnsSubstruc  = true;
 
  AlgFactory * algf = AlgFactory::Instance();
 
  const RgIMap & rgmap = GetConfig().GetItemMap();
 
  RgIMapConstIter iter = rgmap.begin();
  for( ; iter != rgmap.end(); ++iter) {
 
    RgKey reg_key = iter->first;
    RegistryItemI * ri = iter->second;
 
    if(ri->TypeInfo() == kRgAlg) {
        LOG("Algorithm", pDEBUG)
                 << "Found sub-algorithm pointed to by " << reg_key;
        RgAlg reg_alg = fConfig->GetAlg(reg_key);
        AlgId id(reg_alg);
 
        LOG("Algorithm", pDEBUG) << "Adopting sub-algorithm = " << id.Key();
        Algorithm * subalg = algf->AdoptAlgorithm(id.Name(),id.Config());
        subalg->AdoptSubstructure();
 
        LOG("Algorithm", pDEBUG) << "Adding sub-algorithm to local pool";
        AlgMapPair key_alg_pair(reg_key, subalg);
        fOwnedSubAlgMp->insert(key_alg_pair);
 
    }
 
  }
 
 
  if ( fConfig ) {
    delete fConfig ;
    fConfig = 0 ;
  }
 
}

References genie::AlgFactory::AdoptAlgorithm(), AdoptSubstructure(), Algorithm(), DeleteSubstructure(), fConfig, fOwnedSubAlgMp, fOwnsSubstruc, GetConfig(), genie::Registry::GetItemMap(), Id(), genie::AlgFactory::Instance(), genie::AlgId::Key(), genie::kRgAlg, LOG, pDEBUG, pNOTICE, and genie::RegistryItemI::TypeInfo().

Referenced by AdoptSubstructure(), main(), and testReconfigInOwnedModules().

◆ AllowReconfig()

virtual bool genie::Algorithm::AllowReconfig ( void ) const

inlinevirtual

Allow reconfigration after initializaton? Algorithms may opt-out, if reconfiguration is not necessary, to improve event reweighting speed.

Definition at line 106 of file Algorithm.h.

106{ return fAllowReconfig; }

genie::Algorithm::fAllowReconfig

bool fAllowReconfig

Definition Algorithm.h:162

References fAllowReconfig.

Referenced by genie::AlgFactory::ForceReconfiguration().

◆ BuildParamMatColSizeKey()

string Algorithm::BuildParamMatColSizeKey ( const std::string & comm_name )

static

Definition at line 545 of file Algorithm.cxx.

                                                                        {
 
  return "Ncol" + comm_name + 's' ;
 
}

Referenced by genie::AlgConfigPool::AddParameterMatrix(), genie::AlgConfigPool::AddParameterMatrix(), and GetParamMatKeys().

◆ BuildParamMatKey()

string Algorithm::BuildParamMatKey	(	const std::string &	comm_name,
		unsigned int	i,
		unsigned int	j )

static

Definition at line 527 of file Algorithm.cxx.

                                                                                                 {
 
  std::stringstream name;
  name << comm_name << '-' << i << "-" << j ;
  return name.str() ;
 
}

Referenced by genie::AlgConfigPool::AddParameterMatrix(), genie::AlgConfigPool::AddParameterMatrix(), and GetParamMatKeys().

◆ BuildParamMatRowSizeKey()

string Algorithm::BuildParamMatRowSizeKey ( const std::string & comm_name )

static

Definition at line 537 of file Algorithm.cxx.

                                                                        {
 
  return "Nrow" + comm_name + 's' ;
 
}

Referenced by genie::AlgConfigPool::AddParameterMatrix(), genie::AlgConfigPool::AddParameterMatrix(), and GetParamMatKeys().

◆ BuildParamVectKey()

string Algorithm::BuildParamVectKey	(	const std::string &	comm_name,
		unsigned int	i )

static

Definition at line 510 of file Algorithm.cxx.

                                                                                  {
 
  std::stringstream name;
  name << comm_name << '-' << i ;
  return name.str() ;
 
}

Referenced by genie::AlgConfigPool::AddParameterVector(), and GetParamVectKeys().

◆ BuildParamVectSizeKey()

string Algorithm::BuildParamVectSizeKey ( const std::string & comm_name )

static

Definition at line 520 of file Algorithm.cxx.

                                                                      {
 
  return 'N' + comm_name + 's' ;
 
}

Referenced by genie::AlgConfigPool::AddParameterVector(), and GetParamVectKeys().

◆ Compare()

AlgCmp_t Algorithm::Compare ( const Algorithm * alg ) const

virtual

Compare with input algorithm.

Definition at line 286 of file Algorithm.cxx.

{
// Compares itself with the input algorithm
 
  string alg1    = this->Id().Name();
  string config1 = this->Id().Config();
  string alg2    = algo->Id().Name();
  string config2 = algo->Id().Config();
 
  if(alg1 == alg2)
  {
    if(config1 == config2) return kAlgCmpIdentical;
    else                   return kAlgCmpDiffConfig;
  }
  else return kAlgCmpDiffAlg;
 
  return kAlgCmpUnknown;
}

References Algorithm(), genie::AlgId::Config(), Id(), genie::kAlgCmpDiffAlg, genie::kAlgCmpDiffConfig, genie::kAlgCmpIdentical, genie::kAlgCmpUnknown, and genie::AlgId::Name().

◆ Configure() [1/2]

void Algorithm::Configure ( const Registry & config )

virtual

Configure the algorithm with an external registry The registry is merged with the top level registry if it is owned, Otherwise a copy of it is added with the highest priority

Definition at line 62 of file Algorithm.cxx.

{
// Configure the Algorithm using the input configuration Registry
 
  LOG("Algorithm", pNOTICE) << "Input configuration: " << config;
 
  if ( config.NEntries() <= 0 ) {
 
    LOG("Algorithm", pNOTICE) "Registry " << config.Name() << " is empty. Not added to " << fID.Name();
    return;
  }
 
  Registry* rp = ExtractLocalConfig( config ) ;
  if ( rp ) {
 
    MergeTopRegistry( *rp ) ;
    LOG("Algorithm", pNOTICE) << fID.Name() << " merged with external configuration: " << *rp;
 
    // The memory handled by this pointer has been copied and needs to be cleared
    delete rp ;
  }
 
  if(!fOwnsSubstruc) return;              // doesn't own substructure
  if(fOwnedSubAlgMp->size()==0) return;   // no sub-algorithms
 
  LOG("Algorithm", pNOTICE) << "Configuring algorithms stored at local pool";
 
  // loop over local pool algorithms
 
  for( AlgMapIter alg_iter = fOwnedSubAlgMp->begin();
       alg_iter != fOwnedSubAlgMp->end(); ++alg_iter) {
 
    string      alg_key = alg_iter->first;
    Algorithm * alg     = alg_iter->second;
 
    if(!alg) {
      LOG("Algorithm", pERROR)
        << "Key: " << alg_key << " points to a null algorithm at local pool";
      continue;
    }
 
    LOG("Algorithm", pNOTICE) << "Configuring sub-alg: " << alg->Id().Key();
 
    rp = ExtractLowerConfig( config, alg_key ) ;
    if ( rp ) {
 
      alg -> Configure( *rp ) ;
 
      delete rp ;
 
    }
 
  }
 
}

References Algorithm(), Configure(), ExtractLocalConfig(), ExtractLowerConfig(), fID, fOwnedSubAlgMp, fOwnsSubstruc, Id(), genie::AlgId::Key(), LOG, MergeTopRegistry(), pERROR, and pNOTICE.

◆ Configure() [2/2]

void Algorithm::Configure ( string config )

virtual

Configure the algorithm from the AlgoConfigPool based on param_set string given in input An algorithm contains a vector of registries coming from different xml configuration files, which are loaded according a very precise prioriy This methods will load a number registries in order of priority: 1) "Tunable" parameter set from CommonParametes. This is loaded with the highest prioriry and it is designed to be used for tuning procedure Usage not expected from the user. 2) For every string defined in "CommonParame" the corresponding parameter set will be loaded from CommonParameter.xml 3) parameter set specified by the config string and defined in the xml file of the algorithm 4) if config is not "Default" also the Default parameter set from the same xml file will be loaded Effectively this avoids the repetion of a parameter when it is not changed in the requested configuration

Definition at line 118 of file Algorithm.cxx.

{
// Configure the Algorithm looking up at the ConfigPool singleton for a
// configuration Registry corresponding to the input named parameter set.
 
  fID.SetConfig(config);
  this->FindConfig();
}

References fID, and FindConfig().

◆ DeleteConfig()

void Algorithm::DeleteConfig ( void )

protected

Definition at line 463 of file Algorithm.cxx.

{
  // there is nothing to delete if the configuration is not owned but is
  // rather looked up from the configuration pool
  //
 
  for ( unsigned int i = 0 ; i < fConfVect.size() ; ++i ) {
    if ( fOwnerships[i] ) {
      delete fConfVect[i] ;
    }
  }
 
  fConfVect.clear() ;
  fOwnerships.clear() ;
 
  // delete owned configuration registry
 
  if(fConfig) {
    delete fConfig;
    fConfig=0;
  }
 
}

References fConfig, fConfVect, and fOwnerships.

Referenced by FindConfig(), and ~Algorithm().

◆ DeleteSubstructure()

void Algorithm::DeleteSubstructure ( void )

protected

Definition at line 488 of file Algorithm.cxx.

{
  // there is nothing to delete if the sub-algorithms are not owned but rather
  // taken from the AlgFactory's pool
  //
  if(!fOwnsSubstruc) return;
 
  // delete local algorithm pool
  //
  AlgMapIter iter = fOwnedSubAlgMp->begin();
  for( ; iter != fOwnedSubAlgMp->end(); ++iter) {
    Algorithm * alg = iter->second;
    if(alg) {
      delete alg;
      alg=0;
    }
  }
  delete fOwnedSubAlgMp;
  fOwnedSubAlgMp = 0;
}

References Algorithm(), fOwnedSubAlgMp, and fOwnsSubstruc.

Referenced by AdoptSubstructure(), and ~Algorithm().

◆ ExtractLocalConfig()

Registry * Algorithm::ExtractLocalConfig ( const Registry & in ) const

protected

Split an incoming configuration Registry into a block valid for this algorithm Ownership of the returned registry belongs to the algo

Definition at line 619 of file Algorithm.cxx.

                                                                    {
 
  const RgIMap & rgmap = in.GetItemMap();
  Registry * out = new Registry( in.Name(), false );
 
  for( RgIMapConstIter reg_iter = rgmap.begin();
       reg_iter != rgmap.end(); ++reg_iter ) {
 
    RgKey reg_key = reg_iter->first;
    if( reg_key.find( '/' ) != string::npos) continue;
 
    // at this point
    // this key is referred to the local algorithm
    // it has to be copied in out;
 
    RegistryItemI * ri = reg_iter->second;
    RgIMapPair key_item_pair( reg_key, ri->Clone() );
    out -> Set(key_item_pair);
 
  }
 
  if ( out -> NEntries() <= 0 ) {
    delete out ;
    out = 0 ;
  }
 
  return out ;
}

References genie::RegistryItemI::Clone(), genie::Registry::GetItemMap(), and genie::Registry::Name().

Referenced by Configure().

◆ ExtractLowerConfig()

Registry * Algorithm::ExtractLowerConfig	(	const Registry &	in,
		const string &	alg_key ) const

protected

Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key.

Definition at line 650 of file Algorithm.cxx.

                                                                                            {
 
  const RgIMap & rgmap = in.GetItemMap();
  Registry * out = new Registry( in.Name(), false );
 
  for( RgIMapConstIter reg_iter = rgmap.begin();
       reg_iter != rgmap.end(); ++reg_iter ) {
 
    RgKey reg_key = reg_iter->first;
    if( reg_key.find(alg_key+"/") == string::npos) continue;
 
    // at this point
    // this key is referred to the sub-algorithm
    // indicated by alg_key: it has to be copied in out;
 
    int new_key_start = reg_key.find_first_of('/')+1;
    RgKey new_reg_key = reg_key.substr( new_key_start, reg_key.length() );
 
    RegistryItemI * ri = reg_iter->second;
    RgIMapPair key_item_pair(new_reg_key, ri->Clone());
    out -> Set(key_item_pair);
 
  }
 
  if ( out -> NEntries() <= 0 ) {
    delete out ;
    out = 0 ;
  }
 
  return out ;
 
}

References genie::RegistryItemI::Clone(), genie::Registry::GetItemMap(), and genie::Registry::Name().

Referenced by Configure().

◆ FindConfig()

void Algorithm::FindConfig ( void )

virtual

Lookup configuration from the config pool Similar logic from void Configure(string)

Definition at line 127 of file Algorithm.cxx.

{
// Finds its configration Registry from the ConfigPool and gets a pointer to
// it. If the Registry comes from the ConfigPool then the Algorithm does not
// own its configuration (the ConfigPool singleton keeps the ownership and the
// responsibility to -eventually- delete all the Registries it instantiates
// by parsing the XML config files).
 
  DeleteConfig() ;
 
  AlgConfigPool * pool = AlgConfigPool::Instance();
 
  Registry * config = 0 ;
 
  // load the Default config if config is not the default
  if ( fID.Config() != "Default" ) {
    config = pool -> FindRegistry( fID.Name(), "Default" );
    if ( config ) {
      if ( config -> NEntries() > 0 ) {
        AddTopRegistry( config, false ) ;
        LOG("Algorithm", pDEBUG) << "\n" << *config;
      }
    }
  }
 
  // Load the right config
  config = pool->FindRegistry(this);
 
  if(!config)
    // notify & keep whatever config Registry was used before.
    LOG("Algorithm", pWARN)
       << "No Configuration available for "
       << this->Id().Key() << " at the ConfigPool";
  else {
    if ( config -> NEntries() > 0 ) {
      AddTopRegistry( config, false ) ;
      LOG("Algorithm", pDEBUG) << "\n" << config;
    }
  }
 
  const string common_key_root = "Common" ;
  std::map<string, string> common_lists;
 
  // Load Common Parameters if key that start with "Common" is found
  for ( unsigned int i = 0 ; i < fConfVect.size() ; ++i ) {
    const Registry & temp = * fConfVect[i] ;
    for ( RgIMapConstIter it = temp.GetItemMap().begin() ; it !=  temp.GetItemMap().end() ; ++it ) {
 
      // check if it is a "Common" entry
      if ( it -> first.find( common_key_root ) == 0 ) {
        // retrieve the type of the common entry
        std::string type = it -> first.substr(common_key_root.size() ) ;
 
        if ( temp.ItemIsLocal( it -> first ) ) {
 
          string temp_list = temp.GetString( it -> first ) ;
          if ( temp_list.length() > 0 ) {
            common_lists[type] = temp_list ;
          }
        }
      }
 
    }
 
  } // loop over the local registries
 
 
  for ( std::map<string, string>::const_iterator it = common_lists.begin() ;
        it != common_lists.end() ; ++it ) {
 
    vector<string> list = str::Split( it -> second , "," ) ;
 
    for ( unsigned int i = 0; i < list.size(); ++i ) {
 
      config = pool -> CommonList( it -> first, list[i] ) ;
 
      if ( ! config ) {
        LOG("Algorithm", pFATAL)
          << "No Common parameters available for " << it -> first << " list "
          << list[i] << " at the ConfigPool";
 
            exit( 78 ) ;
      }
      else  {
            AddLowRegistry( config, false ) ;
            LOG("Algorithm", pDEBUG) << "Loading "
                                     << it -> first << " registry "
                                     << list[i] << " \n" << config;
      }
 
    }
 
  }
 
 
  // Load Tunable from CommonParameters
  // only if the option is specified in RunOpt
  config = pool -> CommonList( "Param", "Tunable" ) ;
  if ( config ) {
    if ( config -> NEntries() > 0 ) {
      AddTopRegistry( config, false ) ;
      LOG("Algorithm", pDEBUG) << "Loading Tunable registry \n" << config;
    }
  }
  else {
    // notify & keep whatever config Registry was used before.
    LOG("Algorithm", pWARN)
      << "No Tunable parameter set available at the ConfigPool";
  }
 
  if ( fConfig ) {
    delete fConfig ;
    fConfig = 0 ;
  }
 
}

References AddLowRegistry(), AddTopRegistry(), DeleteConfig(), fConfig, fConfVect, fID, genie::AlgConfigPool::FindRegistry(), genie::Registry::GetItemMap(), genie::Registry::GetString(), Id(), genie::AlgConfigPool::Instance(), genie::Registry::ItemIsLocal(), genie::AlgId::Key(), LOG, pDEBUG, pFATAL, pWARN, and genie::utils::str::Split().

Referenced by Algorithm(), and Configure().

◆ GetConfig()

const Registry & Algorithm::GetConfig ( void ) const

virtual

Get configuration registry Evaluate the summary of the configuration and returns it The summary of a configuration is a merge of all the registries known to the algorithm (see Configure() methods) but every parameter is appearing only once and in case of repetitions, only the parameter from the registry with the highest prioriry is considered.

Definition at line 246 of file Algorithm.cxx.

                                                {
 
  if ( fConfig ) return * fConfig ;
 
  const_cast<Algorithm*>( this ) -> fConfig = new Registry( fID.Key() + "_summary", false ) ;
 
  // loop and append
  // understand the append mechanism
  for ( unsigned int i = 0 ; i < fConfVect.size(); ++i ) {
    fConfig -> Append( * fConfVect[i] ) ;
  }
 
  if ( fOwnsSubstruc ) {
 
    for ( AlgMapConstIter iter = fOwnedSubAlgMp -> begin() ;
          iter != fOwnedSubAlgMp -> end() ; ++iter ) {
 
      Algorithm * subalg = iter -> second ;
 
      LOG("Algorithm", pDEBUG) << "Appending config from " << iter -> first << " -> " << subalg -> Id() ;
      const Registry & r = subalg->GetConfig();
      RgKey prefix = iter -> first + "/";
      fConfig -> Append(r,prefix);
 
    }
 
  } //if owned substructure
 
  return * fConfig ;
}

References Algorithm(), fConfig, fConfVect, fID, fOwnedSubAlgMp, fOwnsSubstruc, GetConfig(), Id(), LOG, and pDEBUG.

◆ GetOwnedConfig()

Registry * Algorithm::GetOwnedConfig ( void )

Returns the pointer of the summary registry, see previous method Gives access to the summary so it could be changed. The usage of this method is deprecated as it is mantained only for back compatibility. If you need to add or chage a parter (or more), use the AddTopRegistry() instead

Definition at line 279 of file Algorithm.cxx.

{
 
  GetConfig() ;
  return fConfig;
}

References fConfig, and GetConfig().

Referenced by genie::EffectiveSF::LoadConfig(), and genie::TransverseEnhancementFFModel::LoadConfig().

◆ GetParam()

template<class T>

bool genie::Algorithm::GetParam	(	const RgKey &	name,
		T &	p,
		bool	is_top_call = true ) const

protected

Ideal access to a parameter value from the vector of registries Returns true if the value is found and the parameters is set

◆ GetParamDef()

template<class T>

bool genie::Algorithm::GetParamDef	(	const RgKey &	name,
		T &	p,
		const T &	def ) const

protected

Ideal access to a parameter value from the vector of registries, With default value. Returns true if the value is set from the registries, false if the value is the default

◆ GetParamMat()

template<class T>

int genie::Algorithm::GetParamMat	(	const std::string &	comm_name,
		TMatrixT< T > &	mat,
		bool	is_top_call = true ) const

protected

Handle to load matrix of parameters.

◆ GetParamMatKeys()

int Algorithm::GetParamMatKeys	(	const std::string &	comm_name,
		std::vector< RgKey > &	k,
		bool	is_top_call = true ) const

protected

Definition at line 585 of file Algorithm.cxx.

                                                           {
 
  k.clear() ;
 
  int n_row = 0, n_col = 0 ;
  std::string row_name = Algorithm::BuildParamMatRowSizeKey( comm_name ) ;
  std::string col_name = Algorithm::BuildParamMatColSizeKey( comm_name ) ;
 
  bool found = GetParam( row_name, n_row, is_top_call ) && GetParam( col_name, n_col, is_top_call ) ;
 
  if ( ! found ) {
    return 0 ;
  }
 
  for ( int i = 0; i < n_row; ++i ) {
    for ( int j = 0; j < n_col; ++j ) {
 
      RgKey temp_key = Algorithm::BuildParamMatKey( comm_name, i, j ) ;
 
      // potentially, if it is a top call,
      // we might want to check if the key actually exist in the global Registry
      // Not a priority irght now
 
      k.push_back( temp_key ) ;
    }
  }
 
  return k.size() ;
}

References BuildParamMatColSizeKey(), BuildParamMatKey(), BuildParamMatRowSizeKey(), and GetParam().

◆ GetParamMatSym()

template<class T>

int genie::Algorithm::GetParamMatSym	(	const std::string &	comm_name,
		TMatrixTSym< T > &	mat,
		bool	is_top_call = true ) const

protected

◆ GetParamVect()

template<class T>

int genie::Algorithm::GetParamVect	(	const std::string &	comm_name,
		std::vector< T > &	v,
		bool	is_top_call = true ) const

protected

Handle to load vectors of parameters.

◆ GetParamVectKeys()

int Algorithm::GetParamVectKeys	(	const std::string &	comm_name,
		std::vector< RgKey > &	k,
		bool	is_top_call = true ) const

protected

Definition at line 555 of file Algorithm.cxx.

                                                           {
 
  k.clear() ;
 
  int n ;
  std::string n_name = Algorithm::BuildParamVectSizeKey( comm_name ) ;
 
  bool found = GetParam( n_name, n, is_top_call ) ;
 
  if ( ! found ) {
    return 0 ;
  }
 
  for ( int i = 0; i < n; ++i ) {
 
    RgKey temp_key = Algorithm::BuildParamVectKey( comm_name, i ) ;
 
    // potentially, if it is a top call,
    // we might want to check if the key actually exist in the global Registry
    // Not a priority irght now
 
    k.push_back( temp_key ) ;
  }
 
  return k.size() ;
}

References BuildParamVectKey(), BuildParamVectSizeKey(), and GetParam().

Referenced by genie::XSecLinearCombinations::LoadConfig().

◆ GetStatus()

virtual AlgStatus_t genie::Algorithm::GetStatus ( void ) const

inlinevirtual

Get algorithm status.

Definition at line 101 of file Algorithm.h.

101{ return fStatus; }

genie::Algorithm::fStatus

AlgStatus_t fStatus

algorithm execution status

Definition Algorithm.h:175

References fStatus.

◆ Id()

virtual const AlgId & genie::Algorithm::Id ( void ) const

inlinevirtual

Get algorithm ID.

Definition at line 98 of file Algorithm.h.

98{ return fID; }

References fID.

Referenced by genie::KineGeneratorWithCache::AccessCacheBranch(), AdoptConfig(), AdoptSubstructure(), genie::InteractionListAssembler::AssembleInteractionList(), genie::InteractionGeneratorMap::BuildMap(), genie::XSecAlgorithmMap::BuildMap(), genie::XSecSplineList::BuildSplineKey(), genie::DISXSec::CacheBranchName(), genie::DMDISXSec::CacheBranchName(), Compare(), Configure(), genie::GEVGDriver::CreateSplines(), genie::KNOTunedQPMDISPXSec::DISRESJoinSuppressionFactor(), FindConfig(), genie::AlgConfigPool::FindRegistry(), genie::AlgFactory::ForceReconfiguration(), genie::GEVGDriver::GenerateEvent(), GetAlgorithms(), GetConfig(), genie::COHXSec::Integrate(), genie::EventGenerator::LoadConfig(), genie::HadronTransporter::LoadConfig(), genie::NievesQELCCPXSec::LoadConfig(), genie::NievesSimoVacasMECPXSec2016::LoadConfig(), genie::QPMDISPXSec::LoadConfig(), genie::QPMDMDISPXSec::LoadConfig(), genie::SuSAv2MECPXSec::LoadConfig(), genie::SuSAv2QELPXSec::LoadConfig(), genie::EventGeneratorListAssembler::LoadGenerator(), main(), main(), genie::AlgFactory::Print(), genie::InteractionGeneratorMap::Print(), genie::XSecAlgorithmMap::Print(), genie::COHHadronicSystemGenerator::ProcessEventRecord(), genie::COHPrimaryLeptonGenerator::ProcessEventRecord(), genie::EventGenerator::ProcessEventRecord(), genie::AGKY2019::SelectHadronizer(), SubAlg(), TestPythiaTauDecays(), and genie::GEVGDriver::UseSplines().

◆ Initialize()

void Algorithm::Initialize ( void )

protected

Definition at line 335 of file Algorithm.cxx.

{
// Algorithm initialization
//
  fAllowReconfig  = true;
  fOwnsSubstruc   = false;
  fConfig         = 0;
  fOwnedSubAlgMp  = 0;
}

References fAllowReconfig, fConfig, fOwnedSubAlgMp, and fOwnsSubstruc.

Referenced by Algorithm(), Algorithm(), and Algorithm().

◆ MergeTopRegistry()

int Algorithm::MergeTopRegistry ( const Registry & r )

protected

Merge with top level registry if first reg of the vector is owned Otherwise an owned copy is added as a top registry

Definition at line 719 of file Algorithm.cxx.

                                                      {
 
  if ( fOwnerships.empty() ) {
 
        // this algorithm is not configured right now, the incoming registry is the only configuration
    Registry * p = new Registry( r ) ;
        AddTopRegistry( p ) ;
 
        return 1 ;
  }
 
  if ( fOwnerships[0] ) {
        //the top registry is owned: it can be changed with no consequences for other algorithms
    fConfVect[0] -> Merge( r ) ;
  }
  else {
        // The top registry is not owned so it cannot be changed
        // The registry will be added with top priority
 
        Registry * p = new Registry( r ) ;
        AddTopRegistry( p ) ;
  }
 
  // The configuration has changed so the summary is not updated anymore and must be deleted
  if ( fConfig ) {
     delete fConfig ;
     fConfig = 0 ;
  }
 
  return fConfVect.size() ;
}

References AddTopRegistry(), fConfig, fConfVect, and fOwnerships.

Referenced by Configure().

◆ Print()

void Algorithm::Print ( ostream & stream ) const

virtual

Print algorithm info.

Definition at line 315 of file Algorithm.cxx.

{
  // print algorithm name & parameter-set
  stream << "\nAlgorithm Key: "  << this->fID.Key();
  stream << " - Owns Substruc: " << ((fOwnsSubstruc) ? "[true]" : "[false]");
 
  // print algorithm configuration
  const Registry & r = this->GetConfig();
  stream << r;
 
  if(fOwnsSubstruc) {
    AlgMapConstIter iter = fOwnedSubAlgMp->begin();
    for(; iter!=fOwnedSubAlgMp->end(); ++iter) {
      Algorithm * alg = iter->second;
      stream << "<Next algorithm is owned by : " << this->fID.Key() << ">";
      stream << *alg;
    }
  }
}

References Algorithm(), fID, fOwnedSubAlgMp, fOwnsSubstruc, and GetConfig().

Referenced by operator<<.

◆ SetId() [1/2]

void Algorithm::SetId ( const AlgId & id )

virtual

Set algorithm ID.

Definition at line 305 of file Algorithm.cxx.

{
  fID.Copy(id);
}

References fID.

◆ SetId() [2/2]

void Algorithm::SetId	(	string	name,
		string	config )

virtual

Definition at line 310 of file Algorithm.cxx.

{
  fID.SetId(name, config);
}

References fID.

◆ SubAlg()

const Algorithm * Algorithm::SubAlg ( const RgKey & registry_key ) const

Access the sub-algorithm pointed to by the input key, either from the local pool or from AlgFactory's pool

Definition at line 345 of file Algorithm.cxx.

{
// Returns the sub-algorithm pointed to this algorithm's XML config file using
// the the values of the key.
// This method asserts the existence of these keys in the XML config.
// Note: Since only 1 parameter is used, the key value should contain both the
// algorithm name and its configuration set according to the usual scheme:
// namespace::algorithm_name/configuration_set
//
  LOG("Algorithm", pINFO)
    << "Fetching sub-alg within alg: " << this->Id().Key()
                                   << " pointed to by key: " << registry_key;
 
  //-- if the algorithm owns its substructure:
  //      return the sub-algorithm from the local pool
  //
  if(fOwnsSubstruc) {
    AlgMapConstIter iter = fOwnedSubAlgMp->find(registry_key);
    if(iter!=fOwnedSubAlgMp->end()) return iter->second;
    LOG("Algorithm", pERROR)
      << "Owned sub-alg pointed to by key: " << registry_key
      << " was not found within alg: " << this->Id().Key();
     return 0;
  }
 
  //-- if the algorithm does not own its substructure:
  //      return the sub-algorithm from the AlgFactory's pool
  RgAlg alg ;
  GetParam( registry_key, alg ) ;
 
  LOG("Algorithm", pINFO)
    << "Registry key: " << registry_key << " points to algorithm: " << alg;
 
  // retrieve the Algorithm object from the the Algorithm factory
  AlgFactory * algf = AlgFactory::Instance();
  const Algorithm * algbase = algf->GetAlgorithm(alg.name, alg.config);
  assert(algbase);
 
  return algbase;
}

References Algorithm(), RgAlg::config, fOwnedSubAlgMp, fOwnsSubstruc, genie::AlgFactory::GetAlgorithm(), GetParam(), Id(), genie::AlgFactory::Instance(), genie::AlgId::Key(), LOG, RgAlg::name, pERROR, and pINFO.

◆ operator<<

ostream & operator<<	(	ostream &	stream,
		const Algorithm &	alg )

friend

Definition at line 31 of file Algorithm.cxx.

  {
    alg.Print(stream);
    return stream;
  }

References Algorithm(), and Print().

Member Data Documentation

◆ fAllowReconfig

bool genie::Algorithm::fAllowReconfig

protected

Definition at line 162 of file Algorithm.h.

Referenced by AllowReconfig(), genie::Decayer::Configure(), genie::Decayer::Configure(), genie::LHAPDF5::Configure(), genie::LHAPDF5::Configure(), genie::LHAPDF6::Configure(), genie::LHAPDF6::Configure(), genie::UnstableParticleDecayer::Configure(), genie::UnstableParticleDecayer::Configure(), and Initialize().

◆ fConfig

Registry* genie::Algorithm::fConfig

private

Summary configuration derived from fConvVect, not necessarily allocated.

Definition at line 217 of file Algorithm.h.

Referenced by AddLowRegistry(), AddTopRegisties(), AddTopRegistry(), AdoptSubstructure(), DeleteConfig(), FindConfig(), GetConfig(), GetOwnedConfig(), Initialize(), and MergeTopRegistry().

◆ fConfVect

vector<Registry*> genie::Algorithm::fConfVect

protected

ideally these members should go private Registry will be access only through the GetParam method configurations registries from various sources the order of the vector is the precedence in case of repeated parameters position 0 -> Highest precedence

Definition at line 170 of file Algorithm.h.

Referenced by AddLowRegistry(), AddTopRegisties(), AddTopRegistry(), DeleteConfig(), FindConfig(), GetConfig(), and MergeTopRegistry().

◆ fID

AlgId genie::Algorithm::fID

protected

algorithm name and configuration set

Definition at line 165 of file Algorithm.h.

Referenced by Algorithm(), Algorithm(), Configure(), Configure(), FindConfig(), GetConfig(), Id(), Print(), SetId(), and SetId().

◆ fOwnedSubAlgMp

AlgMap* genie::Algorithm::fOwnedSubAlgMp

protected

local pool for owned sub-algs (taken out of the factory pool)

Definition at line 176 of file Algorithm.h.

Referenced by AdoptSubstructure(), Configure(), DeleteSubstructure(), GetConfig(), Initialize(), Print(), and SubAlg().

◆ fOwnerships

vector<bool> genie::Algorithm::fOwnerships

protected

ownership for every registry in fConfVect

Definition at line 173 of file Algorithm.h.

Referenced by AddLowRegistry(), AddTopRegisties(), AddTopRegistry(), DeleteConfig(), and MergeTopRegistry().

◆ fOwnsSubstruc

bool genie::Algorithm::fOwnsSubstruc

protected

true if it owns its substructure (sub-algs,...)

Definition at line 164 of file Algorithm.h.

Referenced by AdoptSubstructure(), Configure(), DeleteSubstructure(), GetConfig(), Initialize(), Print(), and SubAlg().

◆ fStatus

AlgStatus_t genie::Algorithm::fStatus

protected

algorithm execution status

Definition at line 175 of file Algorithm.h.

Referenced by GetStatus().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~Algorithm()

◆ Algorithm() [1/3]

◆ Algorithm() [2/3]

◆ Algorithm() [3/3]

Member Function Documentation

◆ AddLowRegistry()

◆ AddTopRegisties()

◆ AddTopRegistry()

◆ AdoptConfig()

◆ AdoptSubstructure()

◆ AllowReconfig()

◆ BuildParamMatColSizeKey()

◆ BuildParamMatKey()

◆ BuildParamMatRowSizeKey()

◆ BuildParamVectKey()

◆ BuildParamVectSizeKey()

◆ Compare()

◆ Configure() [1/2]

◆ Configure() [2/2]

◆ DeleteConfig()

◆ DeleteSubstructure()

◆ ExtractLocalConfig()

◆ ExtractLowerConfig()

◆ FindConfig()

◆ GetConfig()

◆ GetOwnedConfig()

◆ GetParam()

◆ GetParamDef()

◆ GetParamMat()

◆ GetParamMatKeys()

◆ GetParamMatSym()

◆ GetParamVect()

◆ GetParamVectKeys()

◆ GetStatus()

◆ Id()

◆ Initialize()

◆ MergeTopRegistry()

◆ Print()

◆ SetId() [1/2]

◆ SetId() [2/2]

◆ SubAlg()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ fAllowReconfig

◆ fConfig

◆ fConfVect

◆ fID

◆ fOwnedSubAlgMp

◆ fOwnerships

◆ fOwnsSubstruc

◆ fStatus