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

Helper class to support range checking. More...

#include "BasePolicies.h"

Public Types
using	seed_t = SEED
using	seed_t = SEED

Public Member Functions
	RangeCheckHelper (std::string maxSeedsLabel="maxUniqueEngines", std::string baseSeedLabel="baseSeed", std::string checkRangeLabel="checkRange")
	Constructor; specify configuration labels. More...
void	SetConfigLabels (std::string maxSeedsLabel="maxUniqueEngines", std::string baseSeedLabel="baseSeed", std::string checkRangeLabel="checkRange")
bool	configure (fhicl::ParameterSet const &pset)
void	SetCheck (bool doCheck=true)
	Sets whether to perform the check or not. More...
void	SetBaseSeed (seed_t base_seed)
	Sets the base seed directly. More...
void	SetNSeeds (seed_t nSeeds)
	Sets the number of seeds directly. More...
bool	operator() (seed_t seed) const
	Performs the check on the specified seed. More...
void	EnsureRange (std::string policy, SeedMasterHelper::EngineId const &id, seed_t seed) const
	Throws an exception if the range check on seed fails. More...
bool	isConfigured () const
	Returns whether all the parameters are configured. More...
std::vector< std::string >	missingConfig () const
	Returns the items currently not configured. More...
template<typename STREAM >
void	print (STREAM &out, std::string indent=std::string()) const
	Prints the configuration int the specified stream. More...
	RangeCheckHelper (std::string maxSeedsLabel="maxUniqueEngines", std::string baseSeedLabel="baseSeed", std::string checkRangeLabel="checkRange")
	Constructor; specify configuration labels. More...
void	SetConfigLabels (std::string maxSeedsLabel="maxUniqueEngines", std::string baseSeedLabel="baseSeed", std::string checkRangeLabel="checkRange")
bool	configure (fhicl::ParameterSet const &pset)
void	SetCheck (bool doCheck=true)
	Sets whether to perform the check or not. More...
void	SetBaseSeed (seed_t base_seed)
	Sets the base seed directly. More...
void	SetNSeeds (seed_t nSeeds)
	Sets the number of seeds directly. More...
bool	operator() (seed_t seed) const
	Performs the check on the specified seed. More...
void	EnsureRange (std::string policy, SeedMasterHelper::EngineId const &id, seed_t seed) const
	Throws an exception if the range check on seed fails. More...
bool	isConfigured () const
	Returns whether all the parameters are configured. More...
std::vector< std::string >	missingConfig () const
	Returns the items currently not configured. More...
template<typename STREAM >
void	print (STREAM &out, std::string indent=std::string()) const
	Prints the configuration int the specified stream. More...

Protected Types
enum	Params_t {   pmMaxSeeds, pmBaseSeed, pmDoCheck, pmNParams,   pmMaxSeeds, pmBaseSeed, pmDoCheck, pmNParams }
enum	Params_t {   pmMaxSeeds, pmBaseSeed, pmDoCheck, pmNParams,   pmMaxSeeds, pmBaseSeed, pmDoCheck, pmNParams }

Protected Attributes
std::array< std::string, NParams >	paramLabels
std::bitset< NParams >	hasParameters
bool	bCheck = true
	should we perform the check? More...
seed_t	BaseSeed
	minimum valid seed More...
seed_t	MaxSeeds
	number of valid seeds More...

Static Protected Attributes
static constexpr unsigned int	NParams = (unsigned int) pmNParams

Detailed Description

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

Helper class to support range checking.

Definition at line 99 of file BasePolicies.h.

Member Typedef Documentation

template<typename SEED>

using rndm::details::RangeCheckHelper< SEED >::seed_t = SEED

Definition at line 101 of file BasePolicies.h.

template<typename SEED>

using rndm::details::RangeCheckHelper< SEED >::seed_t = SEED

Definition at line 146 of file RandomSeedPolicyBase.h.

Member Enumeration Documentation

template<typename SEED>

enum rndm::details::RangeCheckHelper::Params_t

protected

Enumerator
pmMaxSeeds
pmBaseSeed
pmDoCheck
pmNParams
pmMaxSeeds
pmBaseSeed
pmDoCheck
pmNParams

Definition at line 158 of file BasePolicies.h.

                   {
        pmMaxSeeds,
        pmBaseSeed,
        pmDoCheck,
        pmNParams
      } Params_t;

template<typename SEED>

enum rndm::details::RangeCheckHelper::Params_t

protected

Enumerator
pmMaxSeeds
pmBaseSeed
pmDoCheck
pmNParams
pmMaxSeeds
pmBaseSeed
pmDoCheck
pmNParams

Definition at line 203 of file RandomSeedPolicyBase.h.

                   {
        pmMaxSeeds,
        pmBaseSeed,
        pmDoCheck,
        pmNParams
      } Params_t;

Constructor & Destructor Documentation

template<typename SEED>

rndm::details::RangeCheckHelper< SEED >::RangeCheckHelper ( std::string  maxSeedsLabel = "maxUniqueEngines", std::string  baseSeedLabel = "baseSeed", std::string  checkRangeLabel = "checkRange"  )

inline

Constructor; specify configuration labels.

Definition at line 104 of file BasePolicies.h.

        { SetConfigLabels(maxSeedsLabel, baseSeedLabel, checkRangeLabel); }

template<typename SEED>

rndm::details::RangeCheckHelper< SEED >::RangeCheckHelper ( std::string  maxSeedsLabel = "maxUniqueEngines", std::string  baseSeedLabel = "baseSeed", std::string  checkRangeLabel = "checkRange"  )

inline

Constructor; specify configuration labels.

Definition at line 149 of file RandomSeedPolicyBase.h.

        { SetConfigLabels(maxSeedsLabel, baseSeedLabel, checkRangeLabel); }

Member Function Documentation

template<typename SEED >

bool rndm::details::RangeCheckHelper< SEED >::configure

(

fhicl::ParameterSet const &

pset

)

Configures from a parameter set

Returns

if the configuration after the call is complete

Definition at line 189 of file BasePolicies.h.

References fhicl::ParameterSet::get_if_present(), and seed.

Referenced by rndm::details::CheckedRangePolicy< SEED >::ensureRange(), and rndm::details::CheckedRangePolicy< SEED >::static_configure().

                                                                        {
      if (!paramLabels[pmMaxSeeds].empty()) {
        seed_t seed;
        if (pset.get_if_present(paramLabels[pmMaxSeeds], seed)) SetNSeeds(seed);
      }
      if (!paramLabels[pmBaseSeed].empty()) {
        seed_t seed;
        if (pset.get_if_present(paramLabels[pmBaseSeed], seed))
          SetBaseSeed(seed);
      }
      if (!paramLabels[pmDoCheck].empty()) {
        bool flag;
        if (pset.get_if_present(paramLabels[pmDoCheck], flag)) SetCheck(flag);
      }
      return isConfigured();
    } // RangeCheckHelper<SEED>::configure()

template<typename SEED>

bool rndm::details::RangeCheckHelper< SEED >::configure

(

fhicl::ParameterSet const &

pset

)

Configures from a parameter set

Returns

if the configuration after the call is complete

template<typename SEED >

void rndm::details::RangeCheckHelper< SEED >::EnsureRange	(	std::string	policy,
		SeedMasterHelper::EngineId const &	id,
		seed_t	seed
	)		const

Throws an exception if the range check on seed fails.

Definition at line 214 of file BasePolicies.h.

References art::errors::LogicError, and rndm::details::RangeCheckHelper< SEED >::print().

Referenced by rndm::details::CheckedRangePolicy< SEED >::ensureRange().

            {
      if (operator()(seed)) return;
      seed_t offset = seed - BaseSeed;
      throw art::Exception(art::errors::LogicError)
        << "NuRandomService (policy: " << policy << ") for engine: "
        << id << " the offset of seed " << seed << " is: " << offset << "."
        "\nAllowed seed offsets are in the range 0....(N-1) where N is: "
        << MaxSeeds << " (as configured in maxUniqueEngines)";
    } // RangeCheckHelper<SEED>::EnsureRange()

template<typename SEED>

void rndm::details::RangeCheckHelper< SEED >::EnsureRange	(	std::string	policy,
		SeedMasterHelper::EngineId const &	id,
		seed_t	seed
	)		const

Throws an exception if the range check on seed fails.

template<typename SEED >

bool rndm::details::RangeCheckHelper< SEED >::isConfigured

(

)

const

Returns whether all the parameters are configured.

Definition at line 208 of file BasePolicies.h.

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

                                                    {
      return (hasParameters.test(pmDoCheck) && !bCheck) || hasParameters.all();
    } // RangeCheckHelper<SEED>::isConfigured()

template<typename SEED>

bool rndm::details::RangeCheckHelper< SEED >::isConfigured

(

)

const

Returns whether all the parameters are configured.

template<typename SEED >

std::vector< std::string > rndm::details::RangeCheckHelper< SEED >::missingConfig

(

)

const

Returns the items currently not configured.

Definition at line 242 of file BasePolicies.h.

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

                                                                     {
      if (hasParameters.test(pmDoCheck) && !bCheck) return {};
      std::vector<std::string> missing;
      for (unsigned int i = 0; i < NParams; ++i)
        if (!hasParameters.test(i)) missing.push_back(paramLabels[i]);
      return missing;
    } // RangeCheckHelper<SEED>::missingConfig()

template<typename SEED>

std::vector<std::string> rndm::details::RangeCheckHelper< SEED >::missingConfig

(

)

const

Returns the items currently not configured.

template<typename SEED>

bool rndm::details::RangeCheckHelper< SEED >::operator() ( seed_t  seed ) const

inline

Performs the check on the specified seed.

Definition at line 136 of file BasePolicies.h.

        {
          return
            !bCheck || ((seed >= BaseSeed) && (seed < BaseSeed + MaxSeeds));
        } // operator()

template<typename SEED>

bool rndm::details::RangeCheckHelper< SEED >::operator() ( seed_t  seed ) const

inline

Performs the check on the specified seed.

Definition at line 181 of file RandomSeedPolicyBase.h.

        {
          return
            !bCheck || ((seed >= BaseSeed) && (seed < BaseSeed + MaxSeeds));
        } // operator()

template<typename SEED >

template<typename STREAM >

void rndm::details::RangeCheckHelper< SEED >::print	(	STREAM &	out,
		std::string	indent = std::string()
	)		const

Prints the configuration int the specified stream.

Definition at line 230 of file BasePolicies.h.

Referenced by rndm::details::RangeCheckHelper< SEED >::EnsureRange().

    {
      if (!isConfigured())
        out << indent << "seed range checker not configured!";
      else if (bCheck)
        out << indent << "maximum number of seeds: " << MaxSeeds;
      else
        out << indent << "no limit on number of seeds.";
    } // RangeCheckHelper<SEED>::print()

template<typename SEED>

template<typename STREAM >

void rndm::details::RangeCheckHelper< SEED >::print	(	STREAM &	out,
		std::string	indent = std::string()
	)		const

Prints the configuration int the specified stream.

template<typename SEED>

void rndm::details::RangeCheckHelper< SEED >::SetBaseSeed ( seed_t  base_seed )

inline

Sets the base seed directly.

Definition at line 128 of file BasePolicies.h.

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

        { BaseSeed = base_seed; hasParameters.set(pmBaseSeed); }

template<typename SEED>

void rndm::details::RangeCheckHelper< SEED >::SetBaseSeed ( seed_t  base_seed )

inline

Sets the base seed directly.

Definition at line 173 of file RandomSeedPolicyBase.h.

        { BaseSeed = base_seed; hasParameters.set(pmBaseSeed); }

template<typename SEED>

void rndm::details::RangeCheckHelper< SEED >::SetCheck ( bool  doCheck = true )

inline

Sets whether to perform the check or not.

Definition at line 124 of file BasePolicies.h.

Referenced by rndm::details::PredefinedSeedPolicy< SEED >::static_configure().

        { bCheck = doCheck; hasParameters.set(pmDoCheck); }

template<typename SEED>

void rndm::details::RangeCheckHelper< SEED >::SetCheck ( bool  doCheck = true )

inline

Sets whether to perform the check or not.

Definition at line 169 of file RandomSeedPolicyBase.h.

        { bCheck = doCheck; hasParameters.set(pmDoCheck); }

template<typename SEED >

void rndm::details::RangeCheckHelper< SEED >::SetConfigLabels	(	std::string	maxSeedsLabel = "maxUniqueEngines",
		std::string	baseSeedLabel = "baseSeed",
		std::string	checkRangeLabel = "checkRange"
	)

Definition at line 177 of file BasePolicies.h.

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

      {
      paramLabels[pmMaxSeeds] = maxSeedsLabel;
      paramLabels[pmBaseSeed] = baseSeedLabel;
      paramLabels[pmDoCheck]  = checkRangeLabel;
    } // RangeCheckHelper::SetConfigLabels()

template<typename SEED>

void rndm::details::RangeCheckHelper< SEED >::SetConfigLabels	(	std::string	maxSeedsLabel = "maxUniqueEngines",
		std::string	baseSeedLabel = "baseSeed",
		std::string	checkRangeLabel = "checkRange"
	)

template<typename SEED>

void rndm::details::RangeCheckHelper< SEED >::SetNSeeds ( seed_t  nSeeds )

inline

Sets the number of seeds directly.

Definition at line 132 of file BasePolicies.h.

Referenced by rndm::details::LinearMappingPolicy< SEED >::createSeed().

        { MaxSeeds = nSeeds; hasParameters.set(pmMaxSeeds); }

template<typename SEED>

void rndm::details::RangeCheckHelper< SEED >::SetNSeeds ( seed_t  nSeeds )

inline

Sets the number of seeds directly.

Definition at line 177 of file RandomSeedPolicyBase.h.

        { MaxSeeds = nSeeds; hasParameters.set(pmMaxSeeds); }

Member Data Documentation

template<typename SEED>

seed_t rndm::details::RangeCheckHelper< SEED >::BaseSeed

protected

minimum valid seed

Definition at line 170 of file BasePolicies.h.

template<typename SEED>

bool rndm::details::RangeCheckHelper< SEED >::bCheck = true

protected

should we perform the check?

Definition at line 169 of file BasePolicies.h.

template<typename SEED>

std::bitset< NParams > rndm::details::RangeCheckHelper< SEED >::hasParameters

protected

Definition at line 167 of file BasePolicies.h.

template<typename SEED>

seed_t rndm::details::RangeCheckHelper< SEED >::MaxSeeds

protected

number of valid seeds

Definition at line 171 of file BasePolicies.h.

template<typename SEED>

static constexpr unsigned int rndm::details::RangeCheckHelper< SEED >::NParams = (unsigned int) pmNParams

staticprotected

Definition at line 164 of file BasePolicies.h.

template<typename SEED>

std::array< std::string, NParams > rndm::details::RangeCheckHelper< SEED >::paramLabels

protected

Definition at line 166 of file BasePolicies.h.

---

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

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