A basic integral counter;. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/Gaudi/Accumulators.h>

Inheritance diagram for Gaudi::Accumulators::Counter< Atomicity, Arithmetic >:

[legend]

Collaboration diagram for Gaudi::Accumulators::Counter< Atomicity, Arithmetic >:

[legend]

Public Member Functions
template<typename OWNER >
	Counter (OWNER *o, std::string const &name)

Counter &	operator++ ()

Counter &	operator+= (const Arithmetic v)

template<typename stream >
stream &	printImpl (stream &o, bool tableFormat) const

std::ostream &	print (std::ostream &o, bool tableFormat=false) const override
	prints the counter to a stream More...

MsgStream &	print (MsgStream &o, bool tableFormat=false) const override

bool	toBePrinted () const override
	hint whether we should print that counter or not. More...

Public Member Functions inherited from Gaudi::Accumulators::BufferableCounter< atomicity::full, IntegralAccumulator, unsigned long >
	BufferableCounter ()=default

	BufferableCounter (OWNER *o, std::string const &name)

	BufferableCounter (BufferableCounter const &)=delete

BufferType	buffer ()

BufferableCounter &	operator= (BufferableCounter const &)=delete

	~BufferableCounter ()

Public Member Functions inherited from Gaudi::Accumulators::PrintableCounter
	PrintableCounter ()=default

virtual	~PrintableCounter ()=default
	destructor More...

template<typename stream >
stream &	printImpl (stream &s, std::string_view tag) const

virtual std::ostream &	print (std::ostream &o, std::string_view tag) const
	prints the counter to a stream in table format, with the given tag More...

virtual MsgStream &	print (MsgStream &o, std::string_view tag) const

std::string	toString () const
	get a string representation More...

Public Member Functions inherited from Gaudi::Accumulators::IntegralAccumulator< Atomicity, Args... >
IntegralAccumulator &	operator++ ()

IntegralAccumulator	operator++ (int)

Args...	nEntries () const

Args...	sum () const

Public Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< Args..., Args..., Atomicity, Identity >
	GenericAccumulator ()=default

	GenericAccumulator (construct_empty_t, const GenericAccumulator< InputType, Args..., ato, Identity, Identity, VH > &)
	constructor of an empty GenericAccumulator, copying the (non existent) config from another GenericAccumulator More...

	GenericAccumulator (std::in_place_t, Args &&... args)

	GenericAccumulator (const GenericAccumulator &other)

GenericAccumulator	operator+= (const InputType by)

GenericAccumulator &	operator= (const GenericAccumulator &other)

OutputType	value () const

void	reset ()

void	mergeAndReset (GenericAccumulator< InputType, Args..., ato, Identity, Identity, VH > &other)

void	operator+ (GenericAccumulator< InputType, Args..., ato, Identity, Identity, VH > &&other)

Static Public Member Functions
static Counter	fromJSON (const nlohmann::json &j)

Static Public Attributes
static const std::string	typeString { std::string{ "counter:Counter:" } + typeid( Arithmetic ).name() }

Static Public Attributes inherited from Gaudi::Accumulators::BufferableCounter< atomicity::full, IntegralAccumulator, unsigned long >
static const std::string	typeString

Friends
void	reset (Counter &c)

void	mergeAndReset (Counter &c, Counter &o)

void	to_json (nlohmann::json &j, Counter const &c)

Additional Inherited Members
Public Types inherited from Gaudi::Accumulators::BufferableCounter< atomicity::full, IntegralAccumulator, unsigned long >
using	BufferType = Buffer< IntegralAccumulator, Atomicity, Args... >

Public Types inherited from Gaudi::Accumulators::GenericAccumulator< Args..., Args..., Atomicity, Identity >
using	InputType = Args...

using	OutputType = std::decay_t< std::invoke_result_t< Identity, Args... > >

using	InternalType = Args...

using	JSONStringEntriesType = std::string

Protected Member Functions inherited from Gaudi::Accumulators::BufferableCounter< atomicity::full, IntegralAccumulator, unsigned long >
	BufferableCounter (OWNER *o, std::string const &name, SELF &self, CARGS... args)

Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< Args..., Args..., Atomicity, Identity >
	GenericAccumulator (Args... in)

void	reset (Args... in)

auto	rawValue () const

Static Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< Args..., Args..., Atomicity, Identity >
static Args...	extractJSONData (const nlohmann::json &j, const JSONStringEntriesType &entries)

Detailed Description

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>
struct Gaudi::Accumulators::Counter< Atomicity, Arithmetic >

A basic integral counter;.

See also: Gaudi::Accumulators for detailed documentation

Definition at line 939 of file Accumulators.h.

Constructor & Destructor Documentation

◆ Counter()

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

template<typename OWNER >

Gaudi::Accumulators::Counter< Atomicity, Arithmetic >::Counter	(	OWNER *	o,
		std::string const &	name
	)

inline

Definition at line 943 of file Accumulators.h.

944 : BufferableCounter<Atomicity, IntegralAccumulator, Arithmetic>( o, name, *this ) {}

Member Function Documentation

◆ fromJSON()

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

static Counter Gaudi::Accumulators::Counter< Atomicity, Arithmetic >::fromJSON ( const nlohmann::json & j )

inlinestatic

Definition at line 969 of file Accumulators.h.

                                                      {
       return IntegralAccumulator<Atomicity, Arithmetic>::extractJSONData( j, { "nEntries" } );
     }

◆ operator++()

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

Counter& Gaudi::Accumulators::Counter< Atomicity, Arithmetic >::operator++ ( )

inline

Definition at line 945 of file Accumulators.h.

945 { return ( *this ) += 1; }

◆ operator+=()

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

Counter& Gaudi::Accumulators::Counter< Atomicity, Arithmetic >::operator+= ( const Arithmetic v )

inline

Definition at line 946 of file Accumulators.h.

                                               {
       BufferableCounter<Atomicity, IntegralAccumulator, Arithmetic>::operator+=( v );
       return *this;
     }

◆ print() [1/2]

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

MsgStream& Gaudi::Accumulators::Counter< Atomicity, Arithmetic >::print	(	MsgStream &	o,
		bool	tableFormat = `false`
	)		const

inlineoverridevirtual

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 962 of file Accumulators.h.

962 { return printImpl( o, tableFormat ); }

◆ print() [2/2]

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

std::ostream& Gaudi::Accumulators::Counter< Atomicity, Arithmetic >::print	(	std::ostream &	,
		bool	tableFormat = `false`
	)		const

inlineoverridevirtual

prints the counter to a stream

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 959 of file Accumulators.h.

                                                                                 {
       return printImpl( o, tableFormat );
     }

◆ printImpl()

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

template<typename stream >

stream& Gaudi::Accumulators::Counter< Atomicity, Arithmetic >::printImpl	(	stream &	o,
		bool	tableFormat
	)		const

inline

Definition at line 953 of file Accumulators.h.

                                                            {
       // Avoid printing empty counters in non DEBUG mode
       auto fmt = ( tableFormat ? "|%|10d| |" : "#=%|-7lu|" );
       return o << boost::format{ fmt } % this->nEntries();
     }

◆ toBePrinted()

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

bool Gaudi::Accumulators::Counter< Atomicity, Arithmetic >::toBePrinted ( ) const

inlineoverridevirtual

hint whether we should print that counter or not.

Typically empty counters may not be printed

Reimplemented from Gaudi::Accumulators::PrintableCounter.

Definition at line 963 of file Accumulators.h.

963 { return this->nEntries() > 0; }

Friends And Related Function Documentation

◆ mergeAndReset

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

void mergeAndReset	(	Counter< Atomicity, Arithmetic > &	c,
		Counter< Atomicity, Arithmetic > &	o
	)

friend

Definition at line 965 of file Accumulators.h.

965 { c.mergeAndReset( o ); }

◆ reset

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

void reset ( Counter< Atomicity, Arithmetic > & c )

friend

Definition at line 964 of file Accumulators.h.

964 { c.reset(); }

◆ to_json

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

void to_json	(	nlohmann::json &	j,
		Counter< Atomicity, Arithmetic > const &	c
	)

friend

Definition at line 966 of file Accumulators.h.

                                                              {
       j = { { "type", c.typeString }, { "empty", c.nEntries() == 0 }, { "nEntries", c.nEntries() } };
     }

Member Data Documentation

◆ typeString

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>

const std::string Gaudi::Accumulators::Counter< Atomicity, Arithmetic >::typeString { std::string{ "counter:Counter:" } + typeid( Arithmetic ).name() }

inlinestatic

Definition at line 940 of file Accumulators.h.

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

GaudiKernel/include/Gaudi/Accumulators.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long> struct Gaudi::Accumulators::Counter< Atomicity, Arithmetic >

Constructor & Destructor Documentation

◆ Counter()

Member Function Documentation

◆ fromJSON()

◆ operator++()

◆ operator+=()

◆ print() [1/2]

◆ print() [2/2]

◆ printImpl()

◆ toBePrinted()

Friends And Related Function Documentation

◆ mergeAndReset

◆ reset

◆ to_json

Member Data Documentation

◆ typeString

template<atomicity Atomicity = atomicity::full, typename Arithmetic = unsigned long>
struct Gaudi::Accumulators::Counter< Atomicity, Arithmetic >