rndm::details::PerInstancePolicy< SEED > Class Template Reference

Base class for policies reacting at engine instance level. More...

#include "BasePolicies.h"

Inheritance diagram for rndm::details::PerInstancePolicy< SEED >:

Public Types
using	base_t = CheckedRangePolicy< SEED >
using	this_t = PerInstancePolicy< SEED >
using	seed_t = typename base_t::seed_t
using	base_t = CheckedRangePolicy< SEED >
using	this_t = PerInstancePolicy< SEED >
using	seed_t = typename base_t::seed_t
using	EventData_t = NuRandomServiceHelper::EventSeedInputData
	type of data used for event seeds More...
using	EventData_t = NuRandomServiceHelper::EventSeedInputData
	type of data used for event seeds More...

Public Member Functions
	PerInstancePolicy (std::string name, fhicl::ParameterSet const &pset)
virtual void	configure (fhicl::ParameterSet const &pset) override
	Configure this policy. More...
	PerInstancePolicy (std::string name, fhicl::ParameterSet const &pset)
virtual void	configure (fhicl::ParameterSet const &pset) override
	Configure this policy. More...
virtual seed_t	getSeed (SeedMasterHelper::EngineId const &id)
	Returns the next random number. More...
virtual seed_t	getSeed (SeedMasterHelper::EngineId const &id) override
	Returns the next random number. More...
virtual void	print (std::ostream &out) const override
	Prints information on the configuration of this policy. More...
virtual void	print (std::ostream &out) const override
	Prints information on the configuration of this policy. More...
virtual seed_t	getEventSeed (SeedMasterHelper::EngineId const &id, EventData_t const &eventInfo)
	Returns a random number specific to an event. More...
virtual seed_t	getEventSeed (SeedMasterHelper::EngineId const &id, EventData_t const &eventInfo)
	Returns a random number specific to an event. More...
std::string	getName () const
	Returns the given name of the policy. More...
std::string	getName () const
	Returns the given name of the policy. More...
virtual bool	yieldsUniqueSeeds () const override
	Returns whether the returned seed should be unique. More...
virtual bool	yieldsUniqueSeeds () const
	Returns whether the returned seed should be unique. More...

Static Public Attributes
static constexpr seed_t	InvalidSeed = 0
	An invalid seed. More...

Protected Member Functions
	PerInstancePolicy (std::string name)
	Internal constructor: does not configure. For use in derived classes. More...
seed_t	getInstanceSeed (SeedMasterHelper::EngineId const &id) const
	Retrieves the parameter (seed) for the specified engine ID. More...
void	static_configure (fhicl::ParameterSet const &pset)
	PerInstancePolicy (std::string name)
	Internal constructor: does not configure. For use in derived classes. More...
seed_t	getInstanceSeed (SeedMasterHelper::EngineId const &id) const
	Retrieves the parameter (seed) for the specified engine ID. More...
void	static_configure (fhicl::ParameterSet const &pset)
virtual void	ensureRange (SeedMasterHelper::EngineId const &id, seed_t seed) const
	Performs the range checks and complains if needed. More...
virtual void	ensureRange (SeedMasterHelper::EngineId const &id, seed_t seed) const
	Performs the range checks and complains if needed. More...
void	CheckRangeConfiguration () const
	Check that the configuration is complete. More...
void	CheckRangeConfiguration () const
	Check that the configuration is complete. More...
virtual seed_t	createSeed (SeedMasterHelper::EngineId const &)=0
	Extracts the next random number seed. More...
virtual seed_t	createSeed (SeedMasterHelper::EngineId const &)=0
	Extracts the next random number seed. More...
virtual seed_t	createEventSeed (SeedMasterHelper::EngineId const &, EventData_t const &)
	Extracts a seed for specified event information; returns InvalidSeed. More...
virtual seed_t	createEventSeed (SeedMasterHelper::EngineId const &, EventData_t const &)
	Extracts a seed for specified event information; returns InvalidSeed. More...

Static Protected Member Functions
template<typename T >
static T	getInstanceParameter (fhicl::ParameterSet const &pset, SeedMasterHelper::EngineId const &id)
	Retrieves the parameter (seed) for the specified engine ID. More...
template<typename T >
static T	getInstanceParameter (fhicl::ParameterSet const &pset, SeedMasterHelper::EngineId const &id)
	Retrieves the parameter (seed) for the specified engine ID. More...

Protected Attributes
fhicl::ParameterSet	parameters
	configuration parameters More...
RangeCheckHelper< seed_t >	range_check
std::string	name
	name of the policy More...

Detailed Description

template<typename SEED>
class rndm::details::PerInstancePolicy< SEED >

Base class for policies reacting at engine instance level.

---

See also

CheckedRangePolicy

Definition at line 510 of file BasePolicies.h.

Member Typedef Documentation

template<typename SEED >

using rndm::details::PerInstancePolicy< SEED >::base_t = CheckedRangePolicy<SEED>

Definition at line 389 of file RandomSeedPolicyBase.h.

template<typename SEED >

using rndm::details::PerInstancePolicy< SEED >::base_t = CheckedRangePolicy<SEED>

Definition at line 512 of file BasePolicies.h.

template<typename SEED>

using rndm::details::RandomSeedPolicyBase< SEED >::EventData_t = NuRandomServiceHelper::EventSeedInputData

inherited

type of data used for event seeds

Definition at line 48 of file BasePolicies.h.

template<typename SEED>

using rndm::details::RandomSeedPolicyBase< SEED >::EventData_t = NuRandomServiceHelper::EventSeedInputData

inherited

type of data used for event seeds

Definition at line 93 of file RandomSeedPolicyBase.h.

template<typename SEED >

using rndm::details::PerInstancePolicy< SEED >::seed_t = typename base_t::seed_t

Definition at line 391 of file RandomSeedPolicyBase.h.

template<typename SEED >

using rndm::details::PerInstancePolicy< SEED >::seed_t = typename base_t::seed_t

Definition at line 514 of file BasePolicies.h.

template<typename SEED >

using rndm::details::PerInstancePolicy< SEED >::this_t = PerInstancePolicy<SEED>

Definition at line 390 of file RandomSeedPolicyBase.h.

template<typename SEED >

using rndm::details::PerInstancePolicy< SEED >::this_t = PerInstancePolicy<SEED>

Definition at line 513 of file BasePolicies.h.

Constructor & Destructor Documentation

template<typename SEED >

rndm::details::PerInstancePolicy< SEED >::PerInstancePolicy ( std::string  name, fhicl::ParameterSet const &  pset  )

inline

Configures from a parameter set

See also

configure()

Definition at line 518 of file BasePolicies.h.

                                                                      :
        base_t(name)
        { this_t::configure(pset); }

template<typename SEED >

rndm::details::PerInstancePolicy< SEED >::PerInstancePolicy ( std::string  name )

inlineprotected

Internal constructor: does not configure. For use in derived classes.

Definition at line 534 of file BasePolicies.h.

: base_t(name) {}

template<typename SEED >

rndm::details::PerInstancePolicy< SEED >::PerInstancePolicy ( std::string  name, fhicl::ParameterSet const &  pset  )

inline

Configures from a parameter set

See also

configure()

Definition at line 395 of file RandomSeedPolicyBase.h.

                                                                      :
        base_t(name)
        { this_t::configure(pset); }

template<typename SEED >

rndm::details::PerInstancePolicy< SEED >::PerInstancePolicy ( std::string  name )

inlineprotected

Internal constructor: does not configure. For use in derived classes.

Definition at line 411 of file RandomSeedPolicyBase.h.

: base_t(name) {}

Member Function Documentation

template<typename SEED >

void rndm::details::CheckedRangePolicy< SEED >::CheckRangeConfiguration ( ) const

protectedinherited

Check that the configuration is complete.

Definition at line 323 of file BasePolicies.h.

References art::errors::Configuration, rndm::details::RandomSeedPolicyBase< SEED >::getName(), rndm::details::RangeCheckHelper< SEED >::isConfigured(), and rndm::details::RangeCheckHelper< SEED >::missingConfig().

Referenced by rndm::details::AutoIncrementPolicy< SEED >::createSeed(), rndm::details::LinearMappingPolicy< SEED >::createSeed(), rndm::details::PredefinedOffsetPolicy< SEED >::createSeed(), and rndm::details::CheckedRangePolicy< SEED >::ensureRange().

                                                                 {
      if (!range_check.isConfigured()) {
        std::ostringstream sstr;
        sstr << "configuration of policy '" << this->getName()
          << "' incomplete:";
        for (std::string const& name: range_check.missingConfig())
          sstr << " " << name;
        throw art::Exception(art::errors::Configuration) << sstr.str();
      }
    } // CheckedRangePolicy<SEED>::CheckRangeConfiguration()

template<typename SEED >

void rndm::details::CheckedRangePolicy< SEED >::CheckRangeConfiguration ( ) const

protectedinherited

Check that the configuration is complete.

template<typename SEED >

virtual void rndm::details::PerInstancePolicy< SEED >::configure ( fhicl::ParameterSet const &  pset )

inlineoverridevirtual

Configure this policy.

Parameters

pset	the parameter set for the configuration

Reimplemented from rndm::details::CheckedRangePolicy< SEED >.

Reimplemented in rndm::details::PredefinedOffsetPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::PredefinedOffsetPolicy< SEED >, and rndm::details::PredefinedSeedPolicy< SEED >.

Definition at line 404 of file RandomSeedPolicyBase.h.

        { base_t::configure(pset); static_configure(pset); }

template<typename SEED >

virtual void rndm::details::PerInstancePolicy< SEED >::configure ( fhicl::ParameterSet const &  pset )

inlineoverridevirtual

Configure this policy.

Parameters

pset	the parameter set for the configuration

Reimplemented from rndm::details::CheckedRangePolicy< SEED >.

Reimplemented in rndm::details::PredefinedOffsetPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::PredefinedOffsetPolicy< SEED >, and rndm::details::PredefinedSeedPolicy< SEED >.

Definition at line 527 of file BasePolicies.h.

        { base_t::configure(pset); static_configure(pset); }

template<typename SEED>

virtual seed_t rndm::details::RandomSeedPolicyBase< SEED >::createEventSeed ( SeedMasterHelper::EngineId const &  , EventData_t const &    )

inlineprotectedvirtualinherited

Extracts a seed for specified event information; returns InvalidSeed.

Reimplemented in rndm::details::PerEventPolicy< SEED >.

Definition at line 90 of file BasePolicies.h.

References rndm::details::RandomSeedPolicyBase< SEED >::InvalidSeed.

Referenced by rndm::details::RandomSeedPolicyBase< SEED >::getEventSeed().

        { return InvalidSeed; }

template<typename SEED>

virtual seed_t rndm::details::RandomSeedPolicyBase< SEED >::createEventSeed ( SeedMasterHelper::EngineId const &  , EventData_t const &    )

inlineprotectedvirtualinherited

Extracts a seed for specified event information; returns InvalidSeed.

Reimplemented in rndm::details::PerEventPolicy< SEED >.

Definition at line 135 of file RandomSeedPolicyBase.h.

        { return InvalidSeed; }

template<typename SEED>

virtual seed_t rndm::details::RandomSeedPolicyBase< SEED >::createSeed ( SeedMasterHelper::EngineId const &  )

protectedpure virtualinherited

Extracts the next random number seed.

Implemented in rndm::details::RandomPolicy< SEED >, rndm::details::PredefinedOffsetPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::LinearMappingPolicy< SEED >, rndm::details::AutoIncrementPolicy< SEED >, rndm::details::PredefinedOffsetPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::LinearMappingPolicy< SEED >, rndm::details::PerEventPolicy< SEED >, rndm::details::RandomPolicy< SEED >, and rndm::details::AutoIncrementPolicy< SEED >.

Referenced by rndm::details::RandomSeedPolicyBase< SEED >::getSeed(), and rndm::details::CheckedRangePolicy< SEED >::getSeed().

template<typename SEED>

virtual seed_t rndm::details::RandomSeedPolicyBase< SEED >::createSeed ( SeedMasterHelper::EngineId const &  )

protectedpure virtualinherited

Extracts the next random number seed.

Implemented in rndm::details::RandomPolicy< SEED >, rndm::details::PredefinedOffsetPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::LinearMappingPolicy< SEED >, rndm::details::AutoIncrementPolicy< SEED >, rndm::details::PredefinedOffsetPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::LinearMappingPolicy< SEED >, rndm::details::PerEventPolicy< SEED >, rndm::details::RandomPolicy< SEED >, and rndm::details::AutoIncrementPolicy< SEED >.

template<typename SEED >

virtual void rndm::details::CheckedRangePolicy< SEED >::ensureRange ( SeedMasterHelper::EngineId const &  id, seed_t  seed  ) const

inlineprotectedvirtualinherited

Performs the range checks and complains if needed.

Definition at line 303 of file BasePolicies.h.

References rndm::details::RangeCheckHelper< SEED >::EnsureRange(), rndm::details::RandomSeedPolicyBase< SEED >::getName(), and rndm::details::CheckedRangePolicy< SEED >::static_configure().

        { range_check.EnsureRange(this->getName(), id, seed); }

template<typename SEED >

virtual void rndm::details::CheckedRangePolicy< SEED >::ensureRange ( SeedMasterHelper::EngineId const &  id, seed_t  seed  ) const

inlineprotectedvirtualinherited

Performs the range checks and complains if needed.

Definition at line 348 of file RandomSeedPolicyBase.h.

References rndm::details::CheckedRangePolicy< SEED >::CheckRangeConfiguration(), art::errors::Configuration, rndm::details::RangeCheckHelper< SEED >::configure(), rndm::details::RangeCheckHelper< SEED >::EnsureRange(), rndm::details::RangeCheckHelper< SEED >::isConfigured(), rndm::details::RangeCheckHelper< SEED >::missingConfig(), and rndm::details::CheckedRangePolicy< SEED >::static_configure().

        { range_check.EnsureRange(this->getName(), id, seed); }

template<typename SEED>

virtual seed_t rndm::details::RandomSeedPolicyBase< SEED >::getEventSeed ( SeedMasterHelper::EngineId const &  id, EventData_t const &  eventInfo  )

inlinevirtualinherited

Returns a random number specific to an event.

Definition at line 69 of file BasePolicies.h.

References rndm::details::RandomSeedPolicyBase< SEED >::createEventSeed().

Referenced by rndm::details::RandomSeedPolicyBase< SEED >::getSeed().

        { return createEventSeed(id, eventInfo); }

template<typename SEED>

virtual seed_t rndm::details::RandomSeedPolicyBase< SEED >::getEventSeed ( SeedMasterHelper::EngineId const &  id, EventData_t const &  eventInfo  )

inlinevirtualinherited

Returns a random number specific to an event.

Definition at line 114 of file RandomSeedPolicyBase.h.

        { return createEventSeed(id, eventInfo); }

template<typename SEED >

template<typename T >

static T rndm::details::PerInstancePolicy< SEED >::getInstanceParameter ( fhicl::ParameterSet const &  pset, SeedMasterHelper::EngineId const &  id  )

staticprotected

Retrieves the parameter (seed) for the specified engine ID.

template<typename SEED >

template<typename T >

T rndm::details::PerInstancePolicy< SEED >::getInstanceParameter ( fhicl::ParameterSet const &  pset, SeedMasterHelper::EngineId const &  id  )

staticprotected

Retrieves the parameter (seed) for the specified engine ID.

Definition at line 562 of file BasePolicies.h.

References art::errors::Configuration, fhicl::ParameterSet::get(), fhicl::ParameterSet::get_if_present(), fhicl::ParameterSet::get_names(), fhicl::ParameterSet::is_key_to_atom(), and fhicl::ParameterSet::is_key_to_table().

Referenced by rndm::details::PerInstancePolicy< SEED >::getInstanceSeed().

      {
      // there must be /some/ configuration for the module
      // FIXME: use ParameterSet::has_key() as soon as it's available
      const auto cfgKeys = pset.get_names();
      if (std::find(cfgKeys.begin(), cfgKeys.end(), id.moduleLabel) == cfgKeys.end()) {
        throw art::Exception(art::errors::Configuration)
          << "A seed for the nameless instance '" << id
          << "' was requested, but there is no configuration for '"
          << id.moduleLabel << "' module label.";
      }
      
      T param;
      if (!id.hasInstanceName()) { // Case 1: no instance name.
        // We expect the element to be just an item.
        if (pset.is_key_to_table(id.moduleLabel)) {
          // this is mostly a limitation of the FHiCL syntax,
          // that we can overcome with some cumbersomeness if we need to.
          throw art::Exception(art::errors::Configuration)
            << "A seed for the nameless instance '" << id
            << "' was requested, but the configuration sets named instances ("
            << pset.get<fhicl::ParameterSet>(id.moduleLabel).to_compact_string()
            << ").\nNameless and named engine instances can't coexist.";
        }
        if (!pset.get_if_present(id.moduleLabel, param)) {
          throw art::Exception(art::errors::Configuration)
            << "NuRandomService: unable to find the parameter for '" << id << "'";
        }
      } // if no instance name
      else { // Case 2: instance name is given.
        
        if (pset.is_key_to_atom(id.moduleLabel)) {
          // see above
          throw art::Exception(art::errors::Configuration)
            << "A seed for '" << std::string(id) << "' was requested,"
               " but the configuration sets a nameless instance of '"
            << id.moduleLabel << "'.\n"
            << "Nameless and named engine instances can't coexist.";
        }
        fhicl::ParameterSet subSet;
        if (!pset.get_if_present(id.moduleLabel, subSet)) {
          throw art::Exception(art::errors::Configuration)
            << "NuRandomService: unable to find the parameter block for: '"
            << id << "'";
        }
        
        if (!subSet.get_if_present(id.instanceName, param)) {
          throw art::Exception(art::errors::Configuration)
            << "NuRandomService: unable to find the parameter value for: '"
            << id << "'";
        }
      } // if instance name
      
      return param;
    } // PerInstancePolicy<SEED>::getInstanceParameter<>()

template<typename SEED >

seed_t rndm::details::PerInstancePolicy< SEED >::getInstanceSeed ( SeedMasterHelper::EngineId const &  id ) const

inlineprotected

Retrieves the parameter (seed) for the specified engine ID.

Definition at line 414 of file RandomSeedPolicyBase.h.

References art::errors::Configuration, fhicl::ParameterSet::get(), fhicl::ParameterSet::get_if_present(), rndm::details::PerInstancePolicy< SEED >::getInstanceParameter(), fhicl::ParameterSet::has_key(), fhicl::ParameterSet::is_key_to_atom(), fhicl::ParameterSet::is_key_to_table(), and rndm::details::PerInstancePolicy< SEED >::static_configure().

        { return getInstanceParameter<seed_t>(parameters, id); }

template<typename SEED >

seed_t rndm::details::PerInstancePolicy< SEED >::getInstanceSeed ( SeedMasterHelper::EngineId const &  id ) const

inlineprotected

Retrieves the parameter (seed) for the specified engine ID.

Definition at line 537 of file BasePolicies.h.

References rndm::details::PerInstancePolicy< SEED >::static_configure().

        { return getInstanceParameter<seed_t>(parameters, id); }

template<typename SEED>

std::string rndm::details::RandomSeedPolicyBase< SEED >::getName ( ) const

inlineinherited

Returns the given name of the policy.

Definition at line 73 of file BasePolicies.h.

References rndm::details::RandomSeedPolicyBase< SEED >::name.

Referenced by rndm::details::CheckedRangePolicy< SEED >::CheckRangeConfiguration(), rndm::details::CheckedRangePolicy< SEED >::ensureRange(), and rndm::details::RandomSeedPolicyBase< SEED >::print().

{ return name; }

template<typename SEED>

std::string rndm::details::RandomSeedPolicyBase< SEED >::getName ( ) const

inlineinherited

Returns the given name of the policy.

Definition at line 118 of file RandomSeedPolicyBase.h.

{ return name; }

template<typename SEED >

virtual seed_t rndm::details::CheckedRangePolicy< SEED >::getSeed ( SeedMasterHelper::EngineId const &  id )

inlinevirtualinherited

Returns the next random number.

Reimplemented from rndm::details::RandomSeedPolicyBase< SEED >.

Definition at line 281 of file BasePolicies.h.

References rndm::details::RandomSeedPolicyBase< SEED >::createSeed(), and seed.

        {
          seed_t seed = this->createSeed(id);
          ensureRange(id, seed);
          return seed;
        } // getSeed()

template<typename SEED >

virtual seed_t rndm::details::CheckedRangePolicy< SEED >::getSeed ( SeedMasterHelper::EngineId const &  id )

inlineoverridevirtualinherited

Returns the next random number.

Reimplemented from rndm::details::RandomSeedPolicyBase< SEED >.

Definition at line 326 of file RandomSeedPolicyBase.h.

References rndm::details::ValidSeed< SEED >::seed.

        {
          seed_t seed = this->createSeed(id);
          ensureRange(id, seed);
          return seed;
        } // getSeed()

template<typename SEED >

virtual void rndm::details::CheckedRangePolicy< SEED >::print ( std::ostream &  out ) const

inlineoverridevirtualinherited

Prints information on the configuration of this policy.

Reimplemented from rndm::details::RandomSeedPolicyBase< SEED >.

Reimplemented in rndm::details::PredefinedOffsetPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::LinearMappingPolicy< SEED >, rndm::details::AutoIncrementPolicy< SEED >, rndm::details::PredefinedOffsetPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::LinearMappingPolicy< SEED >, and rndm::details::AutoIncrementPolicy< SEED >.

Definition at line 289 of file BasePolicies.h.

Referenced by rndm::details::AutoIncrementPolicy< SEED >::createSeed(), rndm::details::LinearMappingPolicy< SEED >::createSeed(), rndm::details::PredefinedOffsetPolicy< SEED >::createSeed(), and rndm::details::PredefinedSeedPolicy< SEED >::static_configure().

        {
          base_t::print(out);
          range_check.print(out << "\n", "  ");
        } // print()

template<typename SEED >

virtual void rndm::details::CheckedRangePolicy< SEED >::print ( std::ostream &  out ) const

inlineoverridevirtualinherited

Prints information on the configuration of this policy.

Reimplemented from rndm::details::RandomSeedPolicyBase< SEED >.

Reimplemented in rndm::details::PredefinedOffsetPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::LinearMappingPolicy< SEED >, rndm::details::AutoIncrementPolicy< SEED >, rndm::details::PredefinedOffsetPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::LinearMappingPolicy< SEED >, and rndm::details::AutoIncrementPolicy< SEED >.

Definition at line 334 of file RandomSeedPolicyBase.h.

        {
          base_t::print(out);
          range_check.print(out << "\n", "  ");
        } // print()

template<typename SEED >

void rndm::details::PerInstancePolicy< SEED >::static_configure ( fhicl::ParameterSet const &  pset )

protected

template<typename SEED >

void rndm::details::PerInstancePolicy< SEED >::static_configure ( fhicl::ParameterSet const &  pset )

protected

Definition at line 554 of file BasePolicies.h.

Referenced by rndm::details::PerInstancePolicy< SEED >::getInstanceSeed().

    {
      parameters = pset; // copy the parameters locally
    } // PerInstancePolicy<SEED>::configure()

template<typename SEED>

virtual bool rndm::details::RandomSeedPolicyBase< SEED >::yieldsUniqueSeeds ( ) const

inlineoverridevirtualinherited

Returns whether the returned seed should be unique.

Reimplemented in rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, and rndm::details::PerEventPolicy< SEED >.

Definition at line 80 of file BasePolicies.h.

{ return true; }

template<typename SEED>

virtual bool rndm::details::RandomSeedPolicyBase< SEED >::yieldsUniqueSeeds ( ) const

inlinevirtualinherited

Returns whether the returned seed should be unique.

Reimplemented in rndm::details::PredefinedSeedPolicy< SEED >, rndm::details::PredefinedSeedPolicy< SEED >, and rndm::details::PerEventPolicy< SEED >.

Definition at line 125 of file RandomSeedPolicyBase.h.

{ return true; }

Member Data Documentation

template<typename SEED>

static constexpr seed_t rndm::details::RandomSeedPolicyBase< SEED >::InvalidSeed = 0

staticinherited

An invalid seed.

Definition at line 51 of file BasePolicies.h.

Referenced by rndm::details::RandomSeedPolicyBase< SEED >::createEventSeed(), rndm::details::PerEventPolicy< SEED >::createEventSeed(), and rndm::details::PerEventPolicy< SEED >::createSeed().

template<typename SEED>

std::string rndm::details::RandomSeedPolicyBase< SEED >::name

protectedinherited

name of the policy

Definition at line 83 of file BasePolicies.h.

Referenced by rndm::details::RandomSeedPolicyBase< SEED >::getName().

template<typename SEED >

fhicl::ParameterSet rndm::details::PerInstancePolicy< SEED >::parameters

protected

configuration parameters

Definition at line 531 of file BasePolicies.h.

template<typename SEED >

RangeCheckHelper< seed_t > rndm::details::CheckedRangePolicy< SEED >::range_check

protectedinherited

Definition at line 296 of file BasePolicies.h.

Referenced by rndm::details::AutoIncrementPolicy< SEED >::configure(), rndm::details::LinearMappingPolicy< SEED >::configure(), rndm::details::PredefinedOffsetPolicy< SEED >::configure(), rndm::details::AutoIncrementPolicy< SEED >::createSeed(), rndm::details::LinearMappingPolicy< SEED >::createSeed(), rndm::details::PredefinedOffsetPolicy< SEED >::createSeed(), and rndm::details::PredefinedSeedPolicy< SEED >::static_configure().

---

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

• nutools/RandomUtils/Providers/BasePolicies.h
• nutools/RandomUtils/Providers/RandomSeedPolicyBase.h