Thread-local data object for NDMSPC processing. More...

#include <NGnThreadData.h>

Inheritance diagram for Ndmspc::NGnThreadData:

Public Member Functions
	NGnThreadData ()
	Constructor.

virtual	~NGnThreadData ()
	Destructor.

bool	Init (size_t id, NGnProcessFuncPtr func, NGnBeginFuncPtr beginFunc, NGnEndFuncPtr endFunc, NGnTree ngnt, NBinning binningIn, NGnTree *input=nullptr, const std::string &filename="", const std::string &treename="ngnt")
	Initialize thread data for processing.

void	SetProcessFunc (NGnProcessFuncPtr func)
	Set the processing function pointer.

bool	InitStorage (NStorageTree *ts, const std::string &filename="", const std::string &treename="ngnt")
	Initialize storage tree for thread data.

NGnTree *	GetHnSparseBase () const
	Get pointer to base NGnTree object.

Long64_t	GetNProcessed () const
	Get number of processed entries.

void	SetNProcessed (Long64_t n)
	Set number of processed entries.

void	SetCfg (const json &cfg)
	Set configuration JSON object.

json	GetCfg () const
	Get configuration JSON object.

void	SetResultsFilename (const std::string &filename)
	Set the results filename for TCP mode (shared filesystem path).

const std::string &	GetResultsFilename () const
	Get the results filename for TCP mode.

bool	IsPureCopy () const
	Checks if the object is a pure copy.

void	SetIsPureCopy (bool val)
	Sets the pure copy status of the object.

virtual void	Process (const std::vector< int > &coords)
	Process coordinates (virtual).

void	SetCurrentDefinitionName (const std::string &name)

void	SyncCurrentDefinitionIds (const std::vector< Long64_t > &ids)

void	ExecuteBeginFunction ()

void	ExecuteEndFunction ()

void	FlushDeferredDeletes ()
	Delete deferred ROOT objects, skipping TCanvas/TPad (leaked safely).

virtual Long64_t	Merge (TCollection *list)
	Merge thread data from a collection (virtual).

void	SetItemCount (long long itemCount)
	Setters for data members.

void	SetCoordSum (long long coordSum)
	Set the sum of coordinates processed by the thread.

void	SetThreadId (std::thread::id threadId)
	Set the thread's unique identifier.

void	SetIdSet (bool idSet)
	Set whether the thread ID has been assigned.

void	SetAssignedIndex (size_t assignedIndex)
	Set the assigned index for the thread.

void	SetResourceMonitor (NResourceMonitor *monitor)
	Sets the resource monitor for this thread data.

long long	GetItemCount () const
	Getters for data members.

long long	GetCoordSum () const
	Get the sum of coordinates processed by the thread.

std::thread::id	GetThreadId () const
	Get the thread's unique identifier.

bool	GetIdSet () const
	Check if the thread ID has been assigned.

size_t	GetAssignedIndex () const
	Get the assigned index for the thread.

NResourceMonitor *	GetResourceMonitor () const
	Gets the resource monitor associated with this thread data.

virtual void	Print (Option_t *option="") const
	Print method override.

Static Public Attributes
static std::mutex	fSharedMutex
	Shared mutex for thread-safe operations.

Protected Attributes
NResourceMonitor *	fResourceMonitor {nullptr}
	Pointer to resource monitor.

Private Attributes
NGnProcessFuncPtr	fProcessFunc {nullptr}
	Function pointer to the processing function.

NGnBeginFuncPtr	fBeginFunc {nullptr}
	Function pointer to the begin function.

NGnEndFuncPtr	fEndFunc {nullptr}
	Function pointer to the end function.

NGnTree *	fHnSparseBase {nullptr}
	Pointer to the base class.

Long64_t	fNProcessed {0}
	Number of processed entries.

NBinning *	fBiningSource {nullptr}
	Pointer to the source binning (from the original NGnTree)

json	fCfg {}
	Configuration object.

bool	fIsPureCopy {false}
	Flag indicating pure copy mode.

std::string	fResultsFilename {}
	Shared-FS path to copy result to after Close(true) (TCP mode)

std::unordered_set< Long64_t >	fProcessedBinIds {}
	Set of already-processed global bin IDs (duplicate guard)

std::vector< TObject * >	fDeferredDeletes
	Objects deferred for single-threaded deletion.

long long	fItemCount = 0
	Number of items processed.

long long	fCoordSum = 0
	Sum of coordinates.

std::thread::id	fThreadId
	Thread ID.

bool	fIdSet = false
	Flag to indicate if the thread ID is set.

size_t	fAssignedIndex = 0
	Index assigned to this object.

Detailed Description

Thread-local data object for NDMSPC processing.

Manages per-thread processing function, input/output trees, binning, configuration, and processed entry count. Supports initialization, storage setup, processing, and merging.

Author: Martin Vala mvala.nosp@m.@cer.nosp@m.n.ch

Definition at line 20 of file NGnThreadData.h.

Constructor & Destructor Documentation

◆ NGnThreadData()

Ndmspc::NGnThreadData::NGnThreadData ( )

Constructor.

Definition at line 17 of file NGnThreadData.cxx.

References Ndmspc::NThreadData::NThreadData().

Referenced by Merge().

◆ ~NGnThreadData()

Ndmspc::NGnThreadData::~NGnThreadData ( )

virtual

Destructor.

Definition at line 18 of file NGnThreadData.cxx.

Member Function Documentation

◆ ExecuteBeginFunction()

void Ndmspc::NGnThreadData::ExecuteBeginFunction ( )

Definition at line 507 of file NGnThreadData.cxx.

◆ ExecuteEndFunction()

void Ndmspc::NGnThreadData::ExecuteEndFunction ( )

Definition at line 514 of file NGnThreadData.cxx.

◆ FlushDeferredDeletes()

void Ndmspc::NGnThreadData::FlushDeferredDeletes ( )

Delete deferred ROOT objects, skipping TCanvas/TPad (leaked safely).

Definition at line 521 of file NGnThreadData.cxx.

References fDeferredDeletes, Ndmspc::NThreadData::GetAssignedIndex(), and Ndmspc::NUtils::SafeDeleteObjects().

◆ GetAssignedIndex()

size_t Ndmspc::NThreadData::GetAssignedIndex ( ) const

inlineinherited

Get the assigned index for the thread.

Returns: Index assigned to the thread.

Definition at line 96 of file NThreadData.h.

References fAssignedIndex.

Referenced by Ndmspc::NDimensionalExecutor::ExecuteParallel(), Ndmspc::NGnThreadData::FlushDeferredDeletes(), Ndmspc::NGnThreadData::Merge(), and Ndmspc::NGnThreadData::Process().

◆ GetCfg()

json Ndmspc::NGnThreadData::GetCfg ( ) const

inline

Get configuration JSON object.

Returns: JSON configuration.

Definition at line 90 of file NGnThreadData.h.

References fCfg.

◆ GetCoordSum()

long long Ndmspc::NThreadData::GetCoordSum ( ) const

inlineinherited

Get the sum of coordinates processed by the thread.

Returns: Sum of coordinates.

Definition at line 78 of file NThreadData.h.

References fCoordSum.

◆ GetHnSparseBase()

NGnTree * Ndmspc::NGnThreadData::GetHnSparseBase ( ) const

inline

Get pointer to base NGnTree object.

Returns: Pointer to NGnTree.

Definition at line 66 of file NGnThreadData.h.

References fHnSparseBase.

Referenced by Merge(), and Ndmspc::NGnTree::Process().

◆ GetIdSet()

bool Ndmspc::NThreadData::GetIdSet ( ) const

inlineinherited

Check if the thread ID has been assigned.

Returns: True if ID is set, false otherwise.

Definition at line 90 of file NThreadData.h.

References fIdSet.

◆ GetItemCount()

long long Ndmspc::NThreadData::GetItemCount ( ) const

inlineinherited

Getters for data members.

Get the number of items processed by the thread.

Returns: Number of items.

Definition at line 72 of file NThreadData.h.

References fItemCount.

◆ GetNProcessed()

Long64_t Ndmspc::NGnThreadData::GetNProcessed ( ) const

inline

Get number of processed entries.

Returns: Number of processed entries.

Definition at line 72 of file NGnThreadData.h.

References fNProcessed.

Referenced by Merge().

◆ GetResourceMonitor()

NResourceMonitor * Ndmspc::NThreadData::GetResourceMonitor ( ) const

inlineinherited

Gets the resource monitor associated with this thread data.

Returns a pointer to the NResourceMonitor instance currently associated with this thread data. The caller does not take ownership of the returned pointer.

Returns: Pointer to the associated NResourceMonitor instance.

Definition at line 108 of file NThreadData.h.

References fResourceMonitor.

◆ GetResultsFilename()

const std::string & Ndmspc::NGnThreadData::GetResultsFilename ( ) const

inline

Get the results filename for TCP mode.

Returns: Shared-filesystem path, or empty string if not set.

Definition at line 105 of file NGnThreadData.h.

References fResultsFilename.

Referenced by Merge().

◆ GetThreadId()

std::thread::id Ndmspc::NThreadData::GetThreadId ( ) const

inlineinherited

Get the thread's unique identifier.

Returns: Thread ID.

Definition at line 84 of file NThreadData.h.

References fThreadId.

◆ Init()

bool Ndmspc::NGnThreadData::Init	(	size_t	id,
		NGnProcessFuncPtr	func,
		NGnBeginFuncPtr	beginFunc,
		NGnEndFuncPtr	endFunc,
		NGnTree *	ngnt,
		NBinning *	binningIn,
		NGnTree *	input = nullptr,
		const std::string &	filename = "",
		const std::string &	treename = "ngnt" )

Initialize thread data for processing.

Parameters

id	Thread ID.
func	Processing function pointer.
ngnt	Pointer to NGnTree object.
binningIn	Pointer to NBinning object.
input	Optional input NGnTree pointer.
filename	Optional file name.
treename	Optional tree name (default: "ngnt").

Returns: True if initialization successful.

Initialize thread data

Definition at line 19 of file NGnThreadData.cxx.

References Ndmspc::NStorageTree::AddBranch(), Ndmspc::NStorageTree::Clear(), fBeginFunc, fBiningSource, fEndFunc, fHnSparseBase, fIsPureCopy, fProcessFunc, Ndmspc::NStorageTree::GetBranch(), Ndmspc::NStorageTree::GetBrancheNames(), Ndmspc::NStorageTree::GetBranchesMap(), Ndmspc::NBinningDef::GetContent(), Ndmspc::NStorageTree::GetFileName(), Ndmspc::NBinningDef::GetIds(), Ndmspc::NGnTree::GetParameters(), Ndmspc::NGnTree::GetStorageTree(), Ndmspc::NStorageTree::InitTree(), Ndmspc::NGnTree::IsPureCopy(), Ndmspc::NUtils::Join(), Ndmspc::NGnTree::Open(), Ndmspc::NTreeBranch::SetAddress(), Ndmspc::NThreadData::SetAssignedIndex(), and Ndmspc::NThreadData::SetThreadId().

Referenced by Ndmspc::NGnTree::Process().

◆ InitStorage()

bool Ndmspc::NGnThreadData::InitStorage	(	NStorageTree *	ts,
		const std::string &	filename = "",
		const std::string &	treename = "ngnt" )

Initialize storage tree for thread data.

Parameters

ts	Pointer to NStorageTree.
filename	Optional file name.
treename	Optional tree name (default: "ngnt").

Returns: True if storage initialized successfully.

◆ IsPureCopy()

bool Ndmspc::NGnThreadData::IsPureCopy ( ) const

inline

Checks if the object is a pure copy.

Returns: True if the object is a pure copy, false otherwise.

Definition at line 111 of file NGnThreadData.h.

References fIsPureCopy.

◆ Merge()

Long64_t Ndmspc::NGnThreadData::Merge ( TCollection * list )

virtual

Merge thread data from a collection (virtual).

Parameters

list	Pointer to TCollection.

Returns: Number of merged entries.

Merge function

Definition at line 323 of file NGnThreadData.cxx.

References fBiningSource, fHnSparseBase, Ndmspc::NThreadData::GetAssignedIndex(), Ndmspc::NBinningDef::GetContent(), Ndmspc::NBinningPoint::GetCoords(), Ndmspc::NUtils::GetCoordsString(), Ndmspc::NStorageTree::GetFileName(), GetHnSparseBase(), Ndmspc::NBinningDef::GetIds(), GetNProcessed(), Ndmspc::NGnTree::GetOutputs(), GetResultsFilename(), Ndmspc::NGnTree::GetStorageTree(), NGnThreadData(), and Ndmspc::NGnTree::Open().

Referenced by Ndmspc::NGnTree::Process().

◆ Print()

void Ndmspc::NThreadData::Print ( Option_t * option = "" ) const

virtualinherited

Print method override.

Parameters

option Print options.

Definition at line 43 of file NThreadData.cxx.

References fAssignedIndex, fCoordSum, fItemCount, and fThreadId.

◆ Process()

void Ndmspc::NGnThreadData::Process ( const std::vector< int > & coords )

virtual

Process coordinates (virtual).

Parameters

coords Vector of coordinates.

Process method This method is called for each set of coordinates It initializes the NHnSparseTree if not already done

Reimplemented from Ndmspc::NThreadData.

Definition at line 137 of file NGnThreadData.cxx.

◆ SetAssignedIndex()

void Ndmspc::NThreadData::SetAssignedIndex ( size_t assignedIndex )

inlineinherited

Set the assigned index for the thread.

Parameters

assignedIndex Index assigned to the thread.

Definition at line 53 of file NThreadData.h.

References fAssignedIndex.

Referenced by Ndmspc::NGnThreadData::Init().

◆ SetCfg()

void Ndmspc::NGnThreadData::SetCfg ( const json & cfg )

inline

Set configuration JSON object.

Parameters

cfg	JSON configuration.

Definition at line 84 of file NGnThreadData.h.

References fCfg.

Referenced by Ndmspc::NGnTree::Process().

◆ SetCoordSum()

void Ndmspc::NThreadData::SetCoordSum ( long long coordSum )

inlineinherited

Set the sum of coordinates processed by the thread.

Parameters

coordSum Sum of coordinates.

Definition at line 35 of file NThreadData.h.

References fCoordSum.

◆ SetCurrentDefinitionName()

void Ndmspc::NGnThreadData::SetCurrentDefinitionName ( const std::string & name )

Definition at line 293 of file NGnThreadData.cxx.

◆ SetIdSet()

void Ndmspc::NThreadData::SetIdSet ( bool idSet )

inlineinherited

Set whether the thread ID has been assigned.

Parameters

idSet True if ID is set, false otherwise.

Definition at line 47 of file NThreadData.h.

References fIdSet.

◆ SetIsPureCopy()

void Ndmspc::NGnThreadData::SetIsPureCopy ( bool val )

inline

Sets the pure copy status of the object.

Parameters

val	Boolean value to set the pure copy status.

Definition at line 117 of file NGnThreadData.h.

References fIsPureCopy.

◆ SetItemCount()

void Ndmspc::NThreadData::SetItemCount ( long long itemCount )

inlineinherited

Setters for data members.

Set the number of items processed by the thread.

Parameters

itemCount Number of items.

Definition at line 29 of file NThreadData.h.

References fItemCount.

◆ SetNProcessed()

void Ndmspc::NGnThreadData::SetNProcessed ( Long64_t n )

inline

Set number of processed entries.

Parameters

n	Number of processed entries.

Definition at line 78 of file NGnThreadData.h.

References fNProcessed.

◆ SetProcessFunc()

void Ndmspc::NGnThreadData::SetProcessFunc ( NGnProcessFuncPtr func )

inline

Set the processing function pointer.

Parameters

func	Function pointer to set.

Definition at line 51 of file NGnThreadData.h.

References fProcessFunc.

◆ SetResourceMonitor()

void Ndmspc::NThreadData::SetResourceMonitor ( NResourceMonitor * monitor )

inlineinherited

Sets the resource monitor for this thread data.

This function assigns the given NResourceMonitor pointer to the internal resource monitor member. Ownership of the pointer is not transferred; the caller is responsible for managing the lifetime of the monitor object.

Parameters

monitor Pointer to an NResourceMonitor instance to be associated with this thread data.

Definition at line 64 of file NThreadData.h.

References fResourceMonitor.

◆ SetResultsFilename()

void Ndmspc::NGnThreadData::SetResultsFilename ( const std::string & filename )

inline

Set the results filename for TCP mode (shared filesystem path).

When set, TaskLoop will copy the locally-written file to this path after Close(true) before sending DONE to the supervisor.

Parameters

filename Shared-filesystem path where results should be deposited.

Definition at line 99 of file NGnThreadData.h.

References fResultsFilename.

Referenced by Ndmspc::NGnTree::Process().

◆ SetThreadId()

void Ndmspc::NThreadData::SetThreadId ( std::thread::id threadId )

inlineinherited

Set the thread's unique identifier.

Parameters

threadId Thread ID.

Definition at line 41 of file NThreadData.h.

References fThreadId.

Referenced by Ndmspc::NGnThreadData::Init().

◆ SyncCurrentDefinitionIds()

void Ndmspc::NGnThreadData::SyncCurrentDefinitionIds ( const std::vector< Long64_t > & ids )

Definition at line 303 of file NGnThreadData.cxx.

Member Data Documentation

◆ fAssignedIndex

size_t Ndmspc::NThreadData::fAssignedIndex = 0

privateinherited

Index assigned to this object.

Definition at line 140 of file NThreadData.h.

Referenced by GetAssignedIndex(), NThreadData(), Print(), and SetAssignedIndex().

◆ fBeginFunc

NGnBeginFuncPtr Ndmspc::NGnThreadData::fBeginFunc {nullptr}

private

Function pointer to the begin function.

Definition at line 145 of file NGnThreadData.h.

Referenced by Init().

◆ fBiningSource

NBinning* Ndmspc::NGnThreadData::fBiningSource {nullptr}

private

Pointer to the source binning (from the original NGnTree)

Definition at line 149 of file NGnThreadData.h.

Referenced by Init(), Merge(), and Process().

◆ fCfg

json Ndmspc::NGnThreadData::fCfg {}

private

Configuration object.

Definition at line 150 of file NGnThreadData.h.

Referenced by GetCfg(), Process(), and SetCfg().

◆ fCoordSum

long long Ndmspc::NThreadData::fCoordSum = 0

privateinherited

Sum of coordinates.

Definition at line 137 of file NThreadData.h.

Referenced by GetCoordSum(), NThreadData(), Print(), Process(), and SetCoordSum().

◆ fDeferredDeletes

std::vector<TObject *> Ndmspc::NGnThreadData::fDeferredDeletes

private

Objects deferred for single-threaded deletion.

Definition at line 154 of file NGnThreadData.h.

Referenced by FlushDeferredDeletes(), and Process().

◆ fEndFunc

NGnEndFuncPtr Ndmspc::NGnThreadData::fEndFunc {nullptr}

private

Function pointer to the end function.

Definition at line 146 of file NGnThreadData.h.

Referenced by Init().

◆ fHnSparseBase

NGnTree* Ndmspc::NGnThreadData::fHnSparseBase {nullptr}

private

Pointer to the base class.

Definition at line 147 of file NGnThreadData.h.

Referenced by GetHnSparseBase(), Init(), Merge(), and Process().

◆ fIdSet

bool Ndmspc::NThreadData::fIdSet = false

privateinherited

Flag to indicate if the thread ID is set.

Definition at line 139 of file NThreadData.h.

Referenced by GetIdSet(), NThreadData(), Process(), and SetIdSet().

◆ fIsPureCopy

bool Ndmspc::NGnThreadData::fIsPureCopy {false}

private

Flag indicating pure copy mode.

Definition at line 151 of file NGnThreadData.h.

Referenced by Init(), IsPureCopy(), Process(), and SetIsPureCopy().

◆ fItemCount

long long Ndmspc::NThreadData::fItemCount = 0

privateinherited

Number of items processed.

Definition at line 136 of file NThreadData.h.

Referenced by GetItemCount(), NThreadData(), Print(), Process(), and SetItemCount().

◆ fNProcessed

Long64_t Ndmspc::NGnThreadData::fNProcessed {0}

private

Number of processed entries.

Definition at line 148 of file NGnThreadData.h.

Referenced by GetNProcessed(), Process(), and SetNProcessed().

◆ fProcessedBinIds

std::unordered_set<Long64_t> Ndmspc::NGnThreadData::fProcessedBinIds {}

private

Set of already-processed global bin IDs (duplicate guard)

Definition at line 153 of file NGnThreadData.h.

Referenced by Process().

◆ fProcessFunc

NGnProcessFuncPtr Ndmspc::NGnThreadData::fProcessFunc {nullptr}

private

Function pointer to the processing function.

Definition at line 144 of file NGnThreadData.h.

Referenced by Init(), Process(), and SetProcessFunc().

◆ fResourceMonitor

NResourceMonitor* Ndmspc::NThreadData::fResourceMonitor {nullptr}

protectedinherited

Pointer to resource monitor.

Definition at line 133 of file NThreadData.h.

Referenced by GetResourceMonitor(), Ndmspc::NGnThreadData::Process(), and SetResourceMonitor().

◆ fResultsFilename

std::string Ndmspc::NGnThreadData::fResultsFilename {}

private

Shared-FS path to copy result to after Close(true) (TCP mode)

Definition at line 152 of file NGnThreadData.h.

Referenced by GetResultsFilename(), and SetResultsFilename().

◆ fSharedMutex

std::mutex Ndmspc::NThreadData::fSharedMutex

staticinherited

Shared mutex for thread-safe operations.

Definition at line 98 of file NThreadData.h.

◆ fThreadId

std::thread::id Ndmspc::NThreadData::fThreadId

privateinherited

Thread ID.

Definition at line 138 of file NThreadData.h.

Referenced by GetThreadId(), NThreadData(), Print(), Process(), and SetThreadId().

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

Public Member Functions

Static Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NGnThreadData()

◆ ~NGnThreadData()

Member Function Documentation

◆ ExecuteBeginFunction()

◆ ExecuteEndFunction()

◆ FlushDeferredDeletes()

◆ GetAssignedIndex()

◆ GetCfg()

◆ GetCoordSum()

◆ GetHnSparseBase()

◆ GetIdSet()

◆ GetItemCount()

◆ GetNProcessed()

◆ GetResourceMonitor()

◆ GetResultsFilename()

◆ GetThreadId()

◆ Init()

◆ InitStorage()

◆ IsPureCopy()

◆ Merge()

◆ Print()

◆ Process()

◆ SetAssignedIndex()

◆ SetCfg()

◆ SetCoordSum()

◆ SetCurrentDefinitionName()

◆ SetIdSet()

◆ SetIsPureCopy()

◆ SetItemCount()

◆ SetNProcessed()

◆ SetProcessFunc()

◆ SetResourceMonitor()

◆ SetResultsFilename()

◆ SetThreadId()

◆ SyncCurrentDefinitionIds()

Member Data Documentation

◆ fAssignedIndex

◆ fBeginFunc

◆ fBiningSource

◆ fCfg

◆ fCoordSum

◆ fDeferredDeletes

◆ fEndFunc

◆ fHnSparseBase

◆ fIdSet

◆ fIsPureCopy

◆ fItemCount

◆ fNProcessed

◆ fProcessedBinIds

◆ fProcessFunc

◆ fResourceMonitor

◆ fResultsFilename

◆ fSharedMutex

◆ fThreadId