Books a configurable grid of column-wise tuples: many trees, many columns, few entries. More...

Inheritance diagram for WideNTupleAlgorithm:

Collaboration diagram for WideNTupleAlgorithm:

Classes
struct	Block
	One booked tuple and everything written into it. More...

Public Member Functions
StatusCode	initialize () override
StatusCode	execute () override
Public Member Functions inherited from Algorithm
	LegacyAlgorithmAdapter (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
Public Member Functions inherited from Gaudi::details::LegacyAlgorithmAdapter
	LegacyAlgorithmAdapter (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
const EventContext &	getContext () const
bool	isExecuted () const
	Has this algorithm been executed since the last reset?
void	setExecuted (bool state) const
	Set the executed flag to the specified state.
bool	filterPassed () const
	Did this algorithm pass or fail its filter criterion for the last event?
void	setFilterPassed (bool state) const
	Set the filter passed flag to the specified state.
Public Member Functions inherited from Gaudi::Algorithm
	Algorithm (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
	Constructor.
StatusCode	sysStart () override
	Reinitialization method invoked by the framework.
StatusCode	sysInitialize () override
	Initialization method invoked by the framework.
StatusCode	sysReinitialize () override
	Reinitialization method invoked by the framework.
StatusCode	sysRestart () override
	Restart method invoked by the framework.
StatusCode	sysExecute (const EventContext &ctx) override
	The actions to be performed by the algorithm on an event.
StatusCode	sysStop () override
	System stop.
StatusCode	sysFinalize () override
	System finalization.
const std::string &	name () const override
	The identifying name of the algorithm object.
const Gaudi::StringKey &	nameKey () const override
const std::string &	type () const override
	The type of the algorithm object.
void	setType (std::string type) override
const std::string &	version () const override
unsigned int	index () const override
StatusCode	configure () override
	Dummy implementation of IStateful::configure() method.
StatusCode	terminate () override
	Dummy implementation of IStateful::terminate() method.
StatusCode	initialize () override
	the default (empty) implementation of IStateful::initialize() method
StatusCode	start () override
	the default (empty) implementation of IStateful::start() method
StatusCode	stop () override
	the default (empty) implementation of IStateful::stop() method
StatusCode	finalize () override
	the default (empty) implementation of IStateful::finalize() method
StatusCode	reinitialize () override
	the default (empty) implementation of IStateful::reinitialize() method
StatusCode	restart () override
	the default (empty) implementation of IStateful::restart() method
Gaudi::StateMachine::State	FSMState () const override
	returns the current state of the algorithm
Gaudi::StateMachine::State	targetFSMState () const override
	returns the state the algorithm will be in after the ongoing transition
bool	isEnabled () const override
	Is this algorithm enabled or disabled?
bool	isSequence () const override
	Are we a Sequence?
unsigned int	errorCount () const
	Get the number of failures of the algorithm.
SmartIF< IService >	service (std::string_view name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name").
template<class T>
SmartIF< T >	service (std::string_view name, bool createIf=true, bool quiet=false) const
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.
SmartIF< IChronoStatSvc > &	chronoSvc () const
	The standard Chrono & Stat service, Return a pointer to the service if present.
SmartIF< IDataProviderSvc > &	detSvc () const
	The standard detector data service.
SmartIF< IConversionSvc > &	detCnvSvc () const
	The standard detector data persistency conversion service.
SmartIF< IDataProviderSvc > &	eventSvc () const
	The standard event data service.
SmartIF< IDataProviderSvc > &	evtSvc () const
	shortcut for method eventSvc
SmartIF< IConversionSvc > &	eventCnvSvc () const
	The standard event data persistency conversion service.
SmartIF< IHistogramSvc > &	histoSvc () const
	The standard histogram service.
SmartIF< INTupleSvc > &	ntupleSvc () const
	The standard N tuple service.
SmartIF< IRndmGenSvc > &	randSvc () const
	The standard RandomGen service, Return a pointer to the service if present.
SmartIF< IToolSvc > &	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present.
SmartIF< IExceptionSvc > &	exceptionSvc () const
	Get the exception Service.
SmartIF< IAlgContextSvc > &	contextSvc () const
	get Algorithm Context Service
SmartIF< ITimelineSvc > &	timelineSvc () const
SmartIF< ISvcLocator > &	serviceLocator () const override
	The standard service locator.
SmartIF< ISvcLocator > &	svcLoc () const
	shortcut for method serviceLocator
SmartIF< IHiveWhiteBoard > &	whiteboard () const
SmartIF< IAlgExecStateSvc > &	algExecStateSvc () const
bool	registerContext () const
	register for Algorithm Context Service?
template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")
template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")
SmartIF< IMonitorSvc > &	monitorSvc () const
	Access the monitor service.
template<class T>
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information.
void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case).
void	acceptDHVisitor (IDataHandleVisitor *) const override
void	registerTool (IAlgTool *tool) const
void	deregisterTool (IAlgTool *tool) const
template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)
template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)
const std::vector< IAlgTool * > &	tools () const
bool	isAsynchronous () const
void	setAsynchronous (bool value)
unsigned int	cardinality () const override
	Return the cardinality.
const AlgResources_t &	neededResources () const override
AlgExecStateRef	execState (const EventContext &ctx) const override
	get the AlgExecStateRef of current algorithm Actually a small wrapper around it, thus the plain object return type
std::ostream &	toControlFlowExpression (std::ostream &os) const override
	Produce string represention of the control flow expression.
Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * >	inputHandles () const override
std::vector< Gaudi::DataHandle * >	outputHandles () const override
virtual const DataObjIDColl &	extraInputDeps () const override
virtual const DataObjIDColl &	extraOutputDeps () const override
void	declare (Gaudi::DataHandle &handle) override
void	renounce (Gaudi::DataHandle &handle) override
bool	renounceInput (const DataObjID &id) override
const DataObjIDColl &	inputDataObjs () const override
const DataObjIDColl &	outputDataObjs () const override
void	addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override
Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.
Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.
StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.
StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value
	PropertyHolder ()=default
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.
Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.
StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation
StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property
const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties
bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.
Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected
void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)
PropertyHolder &	operator= (const PropertyHolder &)=delete
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.
const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.
MsgStream &	msgStream () const
	Return an uninitialized MsgStream.
MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.
MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)
MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)
MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)
MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)
MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)
MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)
MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)
MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)
MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Private Attributes
Gaudi::Property< int >	m_nTuples { this, "NTuples", 4, "number of tuples to book" }
Gaudi::Property< int >	m_nColumns { this, "Columns", 64, "approximate number of columns per tuple" }
Gaudi::Property< int >	m_entries { this, "EntriesPerTuple", 10, "entries written to each tuple" }
Gaudi::Property< int >	m_maxArray { this, "MaxArraySize", 8, "declared maximum of the variable columns" }
Gaudi::Property< std::string >	m_dir { this, "Directory", "MyTuples", "top-level directory" }
std::vector< std::unique_ptr< Block > >	m_blocks
int	m_event = 0

Additional Inherited Members
Public Types inherited from Gaudi::Algorithm
typedef Gaudi::PluginService::Factory< IAlgorithm (const std::string &, ISvcLocator )>	Factory
Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
using	base_class
	Typedef to this class.
using	extend_interfaces_base
	Typedef to the base of this class.
Public Types inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.
Public Types inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
using	base_class
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...
Public Attributes inherited from Gaudi::Algorithm
friend	AlgorithmManager
Protected Member Functions inherited from Gaudi::details::LegacyAlgorithmAdapter
bool	isReEntrant () const override
Protected Member Functions inherited from Gaudi::Algorithm
std::vector< IAlgTool * > &	tools ()
bool	isInitialized () const override
	Has the Algorithm already been initialized?
bool	isFinalized () const override
	Has the Algorithm already been finalized?
void	setIndex (const unsigned int &idx) override
	set instantiation index of Alg
bool	isReEntrant () const override
Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
void	initDataHandleHolder ()
	initializes all handles - called by the sysInitialize method of any descendant of this
Protected Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
MSG::Level	setUpMessaging () const override final
	Set up local caches.
MSG::Level	resetMessaging ()
	Reinitialize internal states.
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.
Protected Attributes inherited from Gaudi::Algorithm
std::unique_ptr< IDataHandleVisitor >	m_updateDataHandles
	Hook for for derived classes to provide a custom visitor for data handles.
Protected Attributes inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl	m_inputDataObjs
DataObjIDColl	m_outputDataObjs

Detailed Description

Books a configurable grid of column-wise tuples: many trees, many columns, few entries.

That is the shape where per-branch write buffers dominate a job, and where NTupleSvc.DiskBuffer is meant to help, so it is what both the equivalence test and the benchmark need.

Every column kind the converter handles appears: scalars of each type, arrays and matrices counted by an index (two indexes, each shared by several columns), and arrays and matrices of fixed size. Array lengths vary from entry to entry, including zero, since a zero-length column is where an off-by-one in the offset walk would hide.

Definition at line 32 of file WideNTupleAlgorithm.cpp.

Member Function Documentation

◆ execute()

StatusCode WideNTupleAlgorithm::execute ( )

overridevirtual

Implements Algorithm.

Definition at line 114 of file WideNTupleAlgorithm.cpp.

                                        {
  const int e = m_event++;
  if ( e >= m_entries ) return StatusCode::SUCCESS;
 
  for ( size_t t = 0; t < m_blocks.size(); ++t ) {
    auto& blk = *m_blocks[t];
    // Zero on some entries on purpose
    blk.n = ( e * 3 + static_cast<int>( t ) ) % ( m_maxArray + 1 );
    blk.m = ( e * 5 + 2 * static_cast<int>( t ) ) % ( m_maxArray + 1 );
    for ( size_t c = 0; c < blk.d.size(); ++c ) {
      const double v = 1000.0 * t + 10.0 * e + c;
      blk.d[c]       = v;
      blk.f[c]       = static_cast<float>( -v );
      blk.i[c]       = static_cast<int>( v );
      blk.b[c]       = ( ( e + c ) % 2 ) == 0;
      for ( int k = 0; k < blk.n; ++k ) {
        blk.var[c][k]    = v + 0.25 * k;
        blk.mat[c][k][0] = v + 0.5 * k;
        blk.mat[c][k][1] = v - 0.5 * k;
      }
      for ( int k = 0; k < blk.m; ++k ) blk.var2[c][k] = static_cast<int>( v ) - k;
      for ( int k = 0; k < 3; ++k ) blk.fixed[c][k] = static_cast<float>( v + k );
      for ( int k = 0; k < 2; ++k )
        for ( int l = 0; l < 3; ++l ) blk.fmat[c][k][l] = static_cast<float>( v + 10 * k + l );
    }
    if ( blk.tuple->write().isFailure() ) {
      error() << "cannot fill tuple " << t << endmsg;
      return StatusCode::FAILURE;
    }
  }
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode WideNTupleAlgorithm::initialize ( )

override

Definition at line 67 of file WideNTupleAlgorithm.cpp.

                                           {
  StatusCode sc = Algorithm::initialize();
  if ( sc.isFailure() ) return sc;
 
  // Split the requested width evenly over the column kinds
  const int nEach = std::max( 1, m_nColumns / 9 );
 
  for ( int t = 0; t < m_nTuples; ++t ) {
    auto        blk  = std::make_unique<Block>();
    std::string path = m_dir.value() + "/t" + std::to_string( t );
    blk->tuple       = ntupleSvc()->book( path, CLID_ColumnWiseTuple, "wide tuple " + std::to_string( t ) );
    if ( !blk->tuple ) {
      error() << "cannot book " << path << endmsg;
      return StatusCode::FAILURE;
    }
    blk->d.resize( nEach );
    blk->f.resize( nEach );
    blk->i.resize( nEach );
    blk->b.resize( nEach );
    blk->var.resize( nEach );
    blk->var2.resize( nEach );
    blk->fixed.resize( nEach );
    blk->mat.resize( nEach );
    blk->fmat.resize( nEach );
 
    // The index has to be declared before the columns it counts: ROOT resolves a
    // leaf count by name against the leaves already in the tree.
    if ( blk->tuple->addItem( "n", blk->n, 0, m_maxArray.value() ).isFailure() ) return StatusCode::FAILURE;
    if ( blk->tuple->addItem( "m", blk->m, 0, m_maxArray.value() ).isFailure() ) return StatusCode::FAILURE;
    for ( int c = 0; c < nEach; ++c ) {
      const auto s = std::to_string( c );
      if ( blk->tuple->addItem( "d" + s, blk->d[c] ).isFailure() ) return StatusCode::FAILURE;
      if ( blk->tuple->addItem( "f" + s, blk->f[c] ).isFailure() ) return StatusCode::FAILURE;
      if ( blk->tuple->addItem( "i" + s, blk->i[c] ).isFailure() ) return StatusCode::FAILURE;
      if ( blk->tuple->addItem( "b" + s, blk->b[c] ).isFailure() ) return StatusCode::FAILURE;
      if ( blk->tuple->addIndexedItem( "var" + s, blk->n, blk->var[c] ).isFailure() ) return StatusCode::FAILURE;
      if ( blk->tuple->addIndexedItem( "var2_" + s, blk->m, blk->var2[c] ).isFailure() ) return StatusCode::FAILURE;
      if ( blk->tuple->addItem( "fix" + s, 3, blk->fixed[c] ).isFailure() ) return StatusCode::FAILURE;
      if ( blk->tuple->addIndexedItem( "mat" + s, blk->n, 2, blk->mat[c] ).isFailure() ) return StatusCode::FAILURE;
      if ( blk->tuple->addItem( "fmat" + s, 2, 3, blk->fmat[c] ).isFailure() ) return StatusCode::FAILURE;
    }
    m_blocks.push_back( std::move( blk ) );
  }
  info() << "booked " << m_blocks.size() << " tuples of about " << m_nColumns.value() << " columns" << endmsg;
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_blocks

std::vector<std::unique_ptr<Block> > WideNTupleAlgorithm::m_blocks

private

Definition at line 61 of file WideNTupleAlgorithm.cpp.

◆ m_dir

Gaudi::Property<std::string> WideNTupleAlgorithm::m_dir { this, "Directory", "MyTuples", "top-level directory" }

private

Definition at line 44 of file WideNTupleAlgorithm.cpp.

44{ this, "Directory", "MyTuples", "top-level directory" };

◆ m_entries

Gaudi::Property<int> WideNTupleAlgorithm::m_entries { this, "EntriesPerTuple", 10, "entries written to each tuple" }

private

Definition at line 42 of file WideNTupleAlgorithm.cpp.

42{ this, "EntriesPerTuple", 10, "entries written to each tuple" };

◆ m_event

int WideNTupleAlgorithm::m_event = 0

private

Definition at line 62 of file WideNTupleAlgorithm.cpp.

◆ m_maxArray

Gaudi::Property<int> WideNTupleAlgorithm::m_maxArray { this, "MaxArraySize", 8, "declared maximum of the variable columns" }

private

Definition at line 43 of file WideNTupleAlgorithm.cpp.

43{ this, "MaxArraySize", 8, "declared maximum of the variable columns" };

◆ m_nColumns

Gaudi::Property<int> WideNTupleAlgorithm::m_nColumns { this, "Columns", 64, "approximate number of columns per tuple" }

private

Definition at line 41 of file WideNTupleAlgorithm.cpp.

41{ this, "Columns", 64, "approximate number of columns per tuple" };

◆ m_nTuples

Gaudi::Property<int> WideNTupleAlgorithm::m_nTuples { this, "NTuples", 4, "number of tuples to book" }

private

Definition at line 40 of file WideNTupleAlgorithm.cpp.

40{ this, "NTuples", 4, "number of tuples to book" };

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

GaudiTestSuite/src/NTuples/WideNTupleAlgorithm.cpp

Classes

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ execute()

◆ initialize()

Member Data Documentation

◆ m_blocks

◆ m_dir

◆ m_entries

◆ m_event

◆ m_maxArray

◆ m_nColumns

◆ m_nTuples