Computes pi (but it does not make it available) More...

Inheritance diagram for lar::ComputePi:

Public Types
using	Counter_t = unsigned long long
	type used for integral counters More...

using	Seed_t = std::default_random_engine::result_type
	type for seed and random numbers More...

using	WorkerType = WorkerT< EDAnalyzer >

using	ModuleType = EDAnalyzer

Public Member Functions
	ComputePi (fhicl::ParameterSet const &p)

virtual	~ComputePi ()=default

virtual void	analyze (const art::Event &) override

double	best_pi () const
	Returns the current best estimation of pi. More...

Counter_t	best_pi_tries () const
	Returns the current best estimation of pi. More...

std::string	workerType () const

bool	modifiesEvent () const

void	registerProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)

std::string const &	processName () const

bool	wantAllEvents () const

bool	wantEvent (Event const &e)

fhicl::ParameterSetID	selectorConfig () const

art::Handle< art::TriggerResults >	getTriggerResults (Event const &e) const

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

base_engine_t &	createEngine (seed_t seed)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)

seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Static Public Attributes
static const char *	VersionString = "1.0"
	version of the algorithm More...

Protected Member Functions
CurrentProcessingContext const *	currentContext () const

detail::CachedProducts &	cachedProducts ()

void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

Private Attributes
Counter_t	samples
	number of samples to try on each event More...

Seed_t	seed
	number of digits to compute More...

bool	bFixed
	whether the random sequence is always the same More...

bool	bVerbose
	whether to put stuff on screen More...

std::default_random_engine	generator
	random generator More...

Counter_t	hits = 0
	total number of hits More...

Counter_t	tries = 0
	total number of tries (samples) More...

Detailed Description

Computes pi (but it does not make it available)

This module performs a extensive computation whose duration can be indirectly controlled by a parameter. The time taken is supposed to be independent from the framework. This is meant to help establish an absolute time scale.

The module performs some Monte Carlo integration to compute pi. The same number of cycles is used regardless the result. We use a simple pseudo-random generator (std::linear_congruential_engine) with a constant extraction time (and poor randomness quality, and a period so small that in about 20 events the sequence might repeat itself). The fluctuations of the result don't reflect a fluctuation in time.

A test performed on uboonegpvm06,fnal.gov on August 19th, 2014 on 1000 events with Ksamples=50000 (i.e., 50M samples per event), default seed and verbosity on took 0.9179 +/- 0.0009 s, with an RMS of ~3%. It was observed that processing time asymptotically decreased.

Parameters

Ksamples (integer, default: 10000) number of digits to be computed
Seed (unsigned integer, default: 314159) chooses the seed for the Monte Carlo integration
Fixed (boolean, default: false) if true, the same pseudo-random number sequence will be used for all events; otherwise, each event will get its own specific sequence
Verbose (boolean, default: false) writes the result into the log

Definition at line 51 of file ComputePi_module.cc.

Member Typedef Documentation

using lar::ComputePi::Counter_t = unsigned long long

type used for integral counters

Definition at line 53 of file ComputePi_module.cc.

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 39 of file EDAnalyzer.h.

using lar::ComputePi::Seed_t = std::default_random_engine::result_type

type for seed and random numbers

Definition at line 55 of file ComputePi_module.cc.

using art::EDAnalyzer::WorkerType = WorkerT<EDAnalyzer>

inherited

Definition at line 38 of file EDAnalyzer.h.

Constructor & Destructor Documentation

lar::ComputePi::ComputePi ( fhicl::ParameterSet const & p )

explicit

Definition at line 99 of file ComputePi_module.cc.

References samples, seed, and VersionString.

                                                  :
   EDAnalyzer(p),
   samples(p.get<Counter_t>("Ksamples", 10000) * 1000),
   seed(p.get<Seed_t>("Seed", 314159)),
   bFixed(p.get<bool>("Fixed", false)),
   bVerbose(p.get<bool>("Verbose", false)),
   generator(seed)
 {
   mf::LogInfo("ComputePi")
     << "version " << VersionString
     << " using " << samples << " samples per event, random seed " << seed;
 } // lar::ComputePi::ComputePi()

virtual lar::ComputePi::~ComputePi ( )

virtualdefault

Member Function Documentation

void lar::ComputePi::analyze ( const art::Event & )

overridevirtual

Definition at line 113 of file ComputePi_module.cc.

References best_pi(), best_pi_tries(), bFixed, bVerbose, generator, hits, samples, seed, sqr(), tries, x, and y.

                                           {
   
   // prepare our personal pseudo-random engine;
   // we'll use always the same sequence!
   std::uniform_real_distribution<float> flat(0.0, 1.0);
   
   // if we want to fix the random sequence, we reseed the generator
   // with the same value over and over again
   if (bFixed) generator.seed(seed);
   
   Counter_t local_hits = 0, tries_left = samples;
   while (tries_left-- > 0) {
     float x = flat(generator), y = flat(generator);
     if (sqr(x) + sqr(y) < 1.0) ++local_hits;
   } // while
   
   double local_pi = double(local_hits) / double(samples) * 4.0;
   hits += local_hits;
   tries += samples;
   
   if (bVerbose) {
     mf::LogInfo("ComputePi") << "today's pi = "
       << std::fixed << std::setprecision(9) << local_pi
       << " (pi = "
       << std::fixed << std::setprecision(12) << best_pi()
       << " after " << best_pi_tries() << " samples)";
   } // if verbose
   
 } // lar::ComputePi::analyze()

double lar::ComputePi::best_pi ( ) const

inline

Returns the current best estimation of pi.

Definition at line 64 of file ComputePi_module.cc.

References hits, and tries.

Referenced by analyze().

65 { return tries? 4. * double(hits) / double(tries): 3.0; }

lar::ComputePi::tries

Counter_t tries

total number of tries (samples)

Definition: ComputePi_module.cc:81

lar::ComputePi::hits

Counter_t hits

total number of hits

Definition: ComputePi_module.cc:80

Counter_t lar::ComputePi::best_pi_tries ( ) const

inline

Returns the current best estimation of pi.

Definition at line 68 of file ComputePi_module.cc.

References tries.

Referenced by analyze().

68 { return tries; }

lar::ComputePi::tries

Counter_t tries

total number of tries (samples)

Definition: ComputePi_module.cc:81

detail::CachedProducts& art::EventObserverBase::cachedProducts ( )

inlineprotectedinherited

Definition at line 79 of file EventObserverBase.h.

References art::EventObserverBase::selectors_.

Referenced by art::EDAnalyzer::doEvent(), and art::OutputModule::doWriteEvent().

   {
     return selectors_;
   }

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::consumes ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const & it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::consumesView ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const & it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

 {
   return rng()->createEngine(placeholder_schedule_id(), seed);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make
	)

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make,
		label_t const &	engine_label
	)

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
 }

CurrentProcessingContext const * art::EDAnalyzer::currentContext ( ) const

protectedinherited

Definition at line 114 of file EDAnalyzer.cc.

References art::EDAnalyzer::current_context_.

Referenced by art::EDAnalyzer::workerType().

   {
     return current_context_.get();
   }

EngineCreator::seed_t EngineCreator::get_seed_value	(	fhicl::ParameterSet const &	pset,
		char const	key[] = `"seed"`,
		seed_t const	implicit_seed = `-1`
	)

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

 {
   auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
   return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
 }

art::Handle<art::TriggerResults> art::EventObserverBase::getTriggerResults ( Event const & e ) const

inlineinherited

Definition at line 61 of file EventObserverBase.h.

References art::detail::CachedProducts::getOneTriggerResults(), and art::EventObserverBase::selectors_.

Referenced by art::OutputModule::doWriteEvent().

   {
     return selectors_.getOneTriggerResults(e);
   }

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::mayConsume ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const & it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const & it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

bool art::EventObserverBase::modifiesEvent ( ) const

inlineinherited

Definition at line 25 of file EventObserverBase.h.

   {
     return false;
   }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

 {
   static Consumer invalid{InvalidTag{}};
   return &invalid;
 }

void art::Consumer::prepareForJob ( fhicl::ParameterSet const & pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

 {
   if (!moduleContext_)
     return;
 
   pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
   for (auto& consumablesPerBranch : consumables_) {
     cet::sort_all(consumablesPerBranch);
   }
 }

std::string const& art::EventObserverBase::processName ( ) const

inlineinherited

Definition at line 41 of file EventObserverBase.h.

References art::EventObserverBase::process_name_.

Referenced by art::FileDumperOutput::printPrincipal(), and art::RootOutput::RootOutput().

   {
     return process_name_;
   }

void art::EventObserverBase::registerProducts	(	MasterProductRegistry &	,
		ProductDescriptions &	,
		ModuleDescription const &
	)

inlineinherited

Definition at line 33 of file EventObserverBase.h.

36 {}

fhicl::ParameterSetID art::EventObserverBase::selectorConfig ( ) const

inlineinherited

Definition at line 56 of file EventObserverBase.h.

References art::EventObserverBase::selector_config_id_.

Referenced by art::RootOutputFile::writeOne().

   {
     return selector_config_id_;
   }

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

 {
   if (!moduleContext_)
     return;
 
   // If none of the branches have missing consumes statements, exit early.
   if (std::all_of(cbegin(missingConsumes_),
                   cend(missingConsumes_),
                   [](auto const& perBranch) { return perBranch.empty(); }))
     return;
 
   constexpr cet::HorizontalRule rule{60};
   mf::LogPrint log{"MTdiagnostics"};
   log << '\n'
       << rule('=') << '\n'
       << "The following consumes (or mayConsume) statements are missing from\n"
       << module_context(moduleDescription_) << '\n'
       << rule('-') << '\n';
 
   cet::for_all_with_index(
     missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
       for (auto const& pi : perBranch) {
         log << "  "
             << assemble_consumes_statement(static_cast<BranchType>(i), pi)
             << '\n';
       }
     });
   log << rule('=');
 }

void art::Consumer::validateConsumedProduct	(	BranchType const	bt,
		ProductInfo const &	pi
	)

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

 {
   // Early exits if consumes tracking has been disabled or if the
   // consumed product is an allowed consumable.
   if (!moduleContext_)
     return;
 
   if (cet::binary_search_all(consumables_[bt], pi))
     return;
 
   if (requireConsumes_) {
     throw Exception(errors::ProductRegistrationFailure,
                     "Consumer: an error occurred during validation of a "
                     "retrieved product\n\n")
       << "The following consumes (or mayConsume) statement is missing from\n"
       << module_context(moduleDescription_) << ":\n\n"
       << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
   }
 
   missingConsumes_[bt].insert(pi);
 }

bool art::EventObserverBase::wantAllEvents ( ) const

inlineinherited

Definition at line 46 of file EventObserverBase.h.

References art::EventObserverBase::wantAllEvents_.

Referenced by art::EDAnalyzer::doEvent(), art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), art::RootOutput::RootOutput(), and art::OutputWorker::wantAllEvents().

   {
     return wantAllEvents_;
   }

bool art::EventObserverBase::wantEvent ( Event const & e )

inlineinherited

Definition at line 51 of file EventObserverBase.h.

References art::EventObserverBase::selectors_, and art::detail::CachedProducts::wantEvent().

Referenced by art::EDAnalyzer::doEvent(), art::OutputModule::doEvent(), and art::OutputModule::doWriteEvent().

   {
     return selectors_.wantEvent(e);
   }

std::string art::EDAnalyzer::workerType ( ) const

inlineinherited

Definition at line 109 of file EDAnalyzer.h.

References art::EDAnalyzer::currentContext().

     {
       return "WorkerT<EDAnalyzer>";
     }

Member Data Documentation

bool lar::ComputePi::bFixed

private

whether the random sequence is always the same

Definition at line 76 of file ComputePi_module.cc.

Referenced by analyze().

bool lar::ComputePi::bVerbose

private

whether to put stuff on screen

Definition at line 77 of file ComputePi_module.cc.

Referenced by analyze().

std::default_random_engine lar::ComputePi::generator

private

random generator

Definition at line 79 of file ComputePi_module.cc.

Referenced by analyze().

Counter_t lar::ComputePi::hits = 0

private

total number of hits

Definition at line 80 of file ComputePi_module.cc.

Referenced by analyze(), and best_pi().

Counter_t lar::ComputePi::samples

private

number of samples to try on each event

Definition at line 74 of file ComputePi_module.cc.

Referenced by analyze(), and ComputePi().

Seed_t lar::ComputePi::seed

private

number of digits to compute

Definition at line 75 of file ComputePi_module.cc.

Referenced by analyze(), and ComputePi().

Counter_t lar::ComputePi::tries = 0

private

total number of tries (samples)

Definition at line 81 of file ComputePi_module.cc.

Referenced by analyze(), best_pi(), and best_pi_tries().

const char * lar::ComputePi::VersionString = "1.0"

static

version of the algorithm

Definition at line 71 of file ComputePi_module.cc.

Referenced by ComputePi().

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

/cvmfs/larsoft.opensciencegrid.org/products/lardata/v07_01_01/source/lardata/Utilities/ComputePi_module.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation