Part of the outer graph that sends data from the outside to the input nodes. More...

#include "core_graph_source.h"

Inheritance diagram for hh::core::CoreGraphSource< GraphInputs >:

Collaboration diagram for hh::core::CoreGraphSource< GraphInputs >:

Public Member Functions
	CoreGraphSource ()
	CoreGraphSource default constructor.

	~CoreGraphSource () override
	CoreGraphSource default destructor.

void	visit (AbstractPrinter *printer) override
	Special visit method for graph's source. More...

void	addSlot (CoreSlot *slot) final
	Add slot to all inputs node possessing a CoreQueueSender. More...

std::set< CoreSlot * >	getSlots () override
	Get the graph's source slot. More...

void	notifyAllTerminated () final
	Notify all input nodes possessing a CoreQueueSender of termination.

std::shared_ptr< CoreNode >	clone () override
	Get a clone of the graph's source, that does not exist, throw an error in every case. More...

behavior::Node *	node () override
	Get a node from the graph's source, that does not exist, throw an error in every case. More...

void	duplicateEdge ([[maybe_unused]] CoreNode duplicateNode, [[maybe_unused]] std::map< CoreNode , std::shared_ptr< CoreNode >> &correspondenceMap) override
	Duplicate edge for a source, throw an error in every case. More...

Public Member Functions inherited from hh::core::CoreQueueSender< GraphInputs >
	CoreQueueSender (std::string_view const &name, NodeType const type, size_t const numberThreads)
	CoreQueueSender constructor. More...

	~CoreQueueSender () override
	CoreQueueSender destructor.

virtual std::shared_ptr< std::set< CoreQueueReceiver< GraphInputs > *> > const &	destinations () const
	Destination accessor. More...

void	addReceiver (CoreReceiver< GraphInputs > *receiver) override
	Add a receiver to the set of receivers. More...

void	removeReceiver (CoreReceiver< GraphInputs > *receiver) override
	Remove a receiver from the set of receivers. More...

void	sendAndNotify (std::shared_ptr< GraphInputs > ptr) final
	Send a data to the list of destinations, and notify them. More...

void	visit (AbstractPrinter *printer) override
	Special visit method for a CoreQueueSender, printing an edge. More...

std::set< CoreSender< GraphInputs > *>	getSenders () override
	Get inner CoreSender i.e. this. More...

void	copyInnerStructure (CoreQueueSender< GraphInputs > *rhs)
	Copy the inner structure of a CoreQueueSender (destinations, and notifier) More...

Public Member Functions inherited from hh::core::CoreSender< GraphInputs >
	CoreSender (std::string_view const &name, NodeType const type, size_t const numberThreads)
	CoreSender constructor. More...

	~CoreSender () override
	CoreSender destructor.

Public Member Functions inherited from hh::core::CoreNotifier
	CoreNotifier ()=delete
	Deleted default constructor.

	CoreNotifier (std::string_view const &name, NodeType const type, size_t const numberThreads)
	Notifier constructor. More...

	~CoreNotifier () override
	Notifier destructor.

Public Member Functions inherited from hh::core::CoreNode
	CoreNode ()=delete
	Deleted default constructor.

	CoreNode (std::string_view const &name, NodeType const type, size_t numberThreads)
	Core node only constructor. More...

virtual	~CoreNode ()
	Default virtual destructor.

virtual std::string	id () const
	Unique Id accessor. More...

virtual std::vector< std::pair< std::string, std::string > >	ids () const
	Input node ids [nodeId, nodeIdCluster] accessor. More...

std::string_view const &	name () const
	Node name accessor. More...

NodeType	type () const
	Node type accessor. More...

bool	isInside () const
	Node inside property accessor. More...

bool	hasBeenRegistered () const
	Node registration property accessor. More...

CoreNode *	coreClusterNode () const
	Main cluster core node link to this node accessor. More...

int	threadId () const
	Thread id accessor. More...

size_t	numberThreads () const
	Number of threads associated accessor. More...

CoreNode *	belongingNode () const
	Belonging node accessor. More...

std::shared_ptr< std::multimap< CoreNode *, std::shared_ptr< CoreNode > > > const &	insideNodes () const
	Inside node accessor. More...

std::shared_ptr< std::multimap< CoreNode *, std::shared_ptr< CoreNode > > > &	insideNodes ()
	Inside nodes accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	executionTime () const
	Execution time accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	waitTime () const
	Wait time accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	memoryWaitTime () const
	Memory wait time accessor. More...

bool	isInCluster () const
	In cluster property accessor. More...

bool	isActive () const
	Is active property accessor. More...

bool	isCudaRelated () const
	Is related to CUDA, used to have a green background on the dot file. More...

virtual int	graphId ()
	Graph id accessor. More...

virtual int	deviceId ()
	Device id accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	maxExecutionTime () const
	Maximum execution time accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	minExecutionTime () const
	Minimum execution time accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	maxWaitTime () const
	Maximum waiting time accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	minWaitTime () const
	Minimum waiting time accessor. More...

std::chrono::time_point< std::chrono::high_resolution_clock > const &	creationTimeStamp () const
	Creation timestamp accessor. More...

std::chrono::time_point< std::chrono::high_resolution_clock > const &	startExecutionTimeStamp () const
	Execution start timestamp accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	creationDuration () const
	Creation duration accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	executionDuration () const
	Execution duration accessor. More...

std::chrono::duration< uint64_t, std::micro >	meanExecTimeCluster () const
	Compute and return the mean execution time for all tasks in the node cluster. More...

std::chrono::duration< uint64_t, std::micro >	meanWaitTimeCluster () const
	Compute and return the mean wait time for all tasks in the node cluster. More...

std::chrono::duration< uint64_t, std::micro >	meanMemoryWaitTimeCluster () const
	Compute and return the mean memory wait time for all tasks in the node cluster. More...

uint64_t	stdvExecTimeCluster () const
	Compute and return the standard deviation execution time for all tasks in the node cluster. More...

uint64_t	stdvWaitTimeCluster () const
	Compute and return the standard deviation wait time for all tasks in the node cluster. More...

uint64_t	stdvMemoryWaitTimeCluster () const
	Compute and return the standard deviation memory wait time for all tasks in the node cluster. More...

std::pair< uint64_t, uint64_t >	minmaxWaitTimeCluster () const
	Compute and return the min and max wait time for all tasks in the node cluster. More...

std::pair< uint64_t, uint64_t >	minmaxMemoryWaitTimeCluster () const
	Compute and return the min and max memory wait time for all tasks in the node cluster. More...

std::pair< uint64_t, uint64_t >	minmaxExecTimeCluster () const
	Compute and return the min and max execution time for all tasks in the node cluster. More...

size_t	numberActiveThreadInCluster () const
	Compute and return the number of active nodes in a cluster. More...

virtual std::string	extraPrintingInformation ()
	Extra printing information accessor. More...

void	startExecutionTimeStamp (std::chrono::time_point< std::chrono::high_resolution_clock > const &startExecutionTimeStamp)
	Execution timestamp setter. More...

virtual void	deviceId (int deviceId)
	Device id setter. More...

virtual void	setInside ()
	Set the node as inside, (inside a graph)

void	setInCluster ()
	Set the task as part of a cluster.

void	threadId (uint8_t threadId)
	Set the thread id. More...

void	coreClusterNode (CoreNode *coreClusterNode)
	Set the main cluster node to associate to this node. More...

void	name (std::string_view const &name)
	Name node setter. More...

void	numberThreads (size_t numberThreads)
	Number of threads setter. More...

void	belongingNode (CoreNode *belongingNode)
	Belonging node setter. More...

void	hasBeenRegistered (bool hasBeenRegistered)
	Has been registered property setter. More...

void	isActive (bool isActive)
	Is active property setter. More...

void	isCudaRelated (bool isCudaRelated)
	Is CUDA related property setter. More...

void	isInside (bool isInside)
	Set the node as being inside another one. More...

void	creationDuration (std::chrono::duration< uint64_t, std::micro > const &creationDuration)
	Creation duration setter. More...

void	executionDuration (std::chrono::duration< uint64_t, std::micro > const &executionDuration)
	Execution duration setter. More...

void	incrementWaitForMemoryDuration (std::chrono::duration< uint64_t, std::micro > const &memoryWait)
	Add wait for memory duration to total duration. More...

virtual void	preRun ()
	Method defining what to do before the run.

virtual void	run ()
	Run method, main execution.

virtual void	postRun ()
	Method defining what to do after the run.

virtual void	createCluster (std::shared_ptr< std::multimap< CoreNode *, std::shared_ptr< CoreNode >>> &)
	Define how to create a cluster for the node, by default do nothing.

virtual void	joinThreads ()
	Define what is done when the thread is joined.

void	removeInsideNode (CoreNode *coreNode)
	Remove a node from the registered inside nodes. More...

void	copyInnerStructure (CoreNode *rhs)
	Copy inner structure from rhs nodes to this. More...

Public Member Functions inherited from hh::core::CoreQueueNotifier
	CoreQueueNotifier (std::string_view const &name, NodeType const type, size_t const numberThreads)
	CoreQueueNotifier constructor. More...

	~CoreQueueNotifier () override
	CoreQueueNotifier destructor.

std::shared_ptr< std::set< CoreSlot * > > const &	slots () const
	Connected slots accessor. More...

void	addSlot (CoreSlot *slot) override
	Add a slot to the set of connected slots. More...

void	removeSlot (CoreSlot *slot) override
	Remove a slot from the set of connected slots. More...

void	notifyAllTerminated () override
	Notify all slots that the node is terminated.

void	copyInnerStructure (CoreQueueNotifier *rhs)
	Copy the inner structure of the notifier (set of slots and connections) More...

Additional Inherited Members
Protected Member Functions inherited from hh::core::CoreQueueSender< GraphInputs >
void	duplicateEdge (CoreNode duplicateNode, std::map< CoreNode , std::shared_ptr< CoreNode >> &correspondenceMap) override
	Duplicate all the edges from this to it's copy duplicateNode. More...

Protected Member Functions inherited from hh::core::CoreNode
void	addUniqueInsideNode (const std::shared_ptr< CoreNode > &coreNode)
	Add a node to the inside nodes. More...

void	incrementWaitDuration (std::chrono::duration< uint64_t, std::micro > const &wait)
	Increment wait duration. More...

void	incrementExecutionDuration (std::chrono::duration< uint64_t, std::micro > const &exec)
	Increment execution duration. More...

Detailed Description

template<class ... GraphInputs>
class hh::core::CoreGraphSource< GraphInputs >

Part of the outer graph that sends data from the outside to the input nodes.

Template Parameters

GraphInputs Graph's data inputs

Definition at line 32 of file core_graph_source.h.

Member Function Documentation

◆ addSlot()

template<class ... GraphInputs>

void hh::core::CoreGraphSource< GraphInputs >::addSlot ( CoreSlot * slot )

inlinefinalvirtual

Add slot to all inputs node possessing a CoreQueueSender.

Parameters

slot	CoreSlot to add to all inputs node possessing a CoreQueueSender

Implements hh::core::CoreNotifier.

Definition at line 58 of file core_graph_source.h.

◆ clone()

template<class ... GraphInputs>

std::shared_ptr<CoreNode> hh::core::CoreGraphSource< GraphInputs >::clone ( )

inlineoverridevirtual

Get a clone of the graph's source, that does not exist, throw an error in every case.

Exceptions

std::runtime_error A graph's source should not be cloned

Returns: nothing, fail with a std::runtime_error

Implements hh::core::CoreNode.

Definition at line 77 of file core_graph_source.h.

◆ duplicateEdge()

template<class ... GraphInputs>

void hh::core::CoreGraphSource< GraphInputs >::duplicateEdge	(	[[maybe_unused] ] CoreNode *	duplicateNode,
		[[maybe_unused] ] std::map< CoreNode *, std::shared_ptr< CoreNode >> &	correspondenceMap
	)

inlineoverride

Duplicate edge for a source, throw an error in every case.

Exceptions

std::runtime_error A source does not have edges to connect

Parameters

duplicateNode	duplicateNode to connect
correspondenceMap	Node correspondence map

Definition at line 100 of file core_graph_source.h.

◆ getSlots()

template<class ... GraphInputs>

std::set<CoreSlot *> hh::core::CoreGraphSource< GraphInputs >::getSlots ( )

inlineoverridevirtual

Get the graph's source slot.

Attention: should not be called

Returns: Empty set of CoreSlot, the Graph's source have no slots connected

Implements hh::core::CoreNode.

Definition at line 66 of file core_graph_source.h.

◆ node()

template<class ... GraphInputs>

behavior::Node* hh::core::CoreGraphSource< GraphInputs >::node ( )

inlineoverridevirtual

Get a node from the graph's source, that does not exist, throw an error in every case.

Exceptions

std::runtime_error A graph's source does not have node

Returns: nothing, fail with a std::runtime_error

Implements hh::core::CoreNode.

Definition at line 89 of file core_graph_source.h.

◆ visit()

template<class ... GraphInputs>

void hh::core::CoreGraphSource< GraphInputs >::visit ( AbstractPrinter * printer )

inlineoverridevirtual

Special visit method for graph's source.

Parameters

printer Printer visitor to print the graph's source

Implements hh::core::CoreNode.

Definition at line 48 of file core_graph_source.h.

Here is the call graph for this function:

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

/home/tjb3/work/hedgehog-nist/hedgehog/core/io/graph/sender/core_graph_source.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<class ... GraphInputs> class hh::core::CoreGraphSource< GraphInputs >

Member Function Documentation

◆ addSlot()

◆ clone()

◆ duplicateEdge()

◆ getSlots()

◆ node()

◆ visit()

template<class ... GraphInputs>
class hh::core::CoreGraphSource< GraphInputs >