Graph Receiver for a type GraphInput. More...

#include "core_graph_receiver.h"

Inheritance diagram for hh::core::CoreGraphReceiver< GraphInput >:

Collaboration diagram for hh::core::CoreGraphReceiver< GraphInput >:

Public Member Functions
	CoreGraphReceiver (std::string_view const &name, NodeType const type, size_t const numberThreads)
	CoreGraphReceiver constructor. More...

virtual	~CoreGraphReceiver ()
	CoreGraphReceiver destructor.

void	addSender (CoreSender< GraphInput > *sender) final
	Add a CoreSender to the graph. More...

void	removeSender (CoreSender< GraphInput > *sender) final
	Remove a CoreSender from the graph. More...

void	receive (std::shared_ptr< GraphInput > ptr) final
	Define how the graph receives data for a specific type and sends the data to all input nodes. More...

void	addGraphReceiverInput (CoreReceiver< GraphInput > *receiver)
	Register a CoreReceiver from an input node. More...

bool	receiverEmpty () final
	Test emptiness in all graph receivers. More...

std::set< CoreReceiver< GraphInput > * >	receivers () override
	Get a set of CoreReceiver built from the input nodes. More...

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

Public Member Functions inherited from hh::core::CoreReceiver< GraphInput >
	CoreReceiver (std::string_view const &name, NodeType const type, size_t const numberThreads)
	Constructor with node name, node type and number of threads for the node. More...

	~CoreReceiver () override
	Default destructor.

virtual size_t	queueSize ()
	Interface to get the number of element to be treated by this node for this type, by default return 0. More...

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::shared_ptr< CoreNode >	clone ()=0
	Virtual constructor for copy. More...

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.

virtual void	duplicateEdge (CoreNode duplicateNode, std::map< CoreNode , std::shared_ptr< CoreNode >> &correspondenceMap)=0
	Duplicate all of the edges from this to its copy duplicateNode. More...

virtual void	visit (AbstractPrinter *printer)=0
	Abstract visit method for printing mechanism. More...

virtual std::set< CoreSlot * >	getSlots ()=0
	Slots accessor for the node. More...

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...

Private Attributes
std::unique_ptr< std::set< CoreReceiver< GraphInput > * > >	graphReceiverInputs_ = nullptr
	Graph receivers (Input node receivers)

Additional Inherited Members
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 GraphInput>
class hh::core::CoreGraphReceiver< GraphInput >

Graph Receiver for a type GraphInput.

Template Parameters

GraphInput Type received by the graph

Definition at line 31 of file core_graph_receiver.h.

Constructor & Destructor Documentation

◆ CoreGraphReceiver()

template<class GraphInput>

hh::core::CoreGraphReceiver< GraphInput >::CoreGraphReceiver	(	std::string_view const &	name,
		NodeType const	type,
		size_t const	numberThreads
	)

inline

CoreGraphReceiver constructor.

Parameters

name	Node name
type	Node type
numberThreads	Node number of threads

Definition at line 41 of file core_graph_receiver.h.

Member Function Documentation

◆ addGraphReceiverInput()

template<class GraphInput>

void hh::core::CoreGraphReceiver< GraphInput >::addGraphReceiverInput ( CoreReceiver< GraphInput > * receiver )

inline

Register a CoreReceiver from an input node.

Parameters

receiver CoreReceiver from an input node to register

Definition at line 82 of file core_graph_receiver.h.

◆ addSender()

template<class GraphInput>

void hh::core::CoreGraphReceiver< GraphInput >::addSender ( CoreSender< GraphInput > * sender )

inlinefinalvirtual

Add a CoreSender to the graph.

Add a CoreSender to all input nodes

Parameters

sender CoreSender to add to the graph

Implements hh::core::CoreReceiver< GraphInput >.

Definition at line 56 of file core_graph_receiver.h.

◆ node()

template<class GraphInput>

behavior::Node* hh::core::CoreGraphReceiver< GraphInput >::node ( )

inlineoverridevirtual

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

Exceptions

std::runtime_error A graph does not have node

Returns: nothing, fail with a std::runtime_error

Implements hh::core::CoreNode.

Definition at line 114 of file core_graph_receiver.h.

◆ receive()

template<class GraphInput>

void hh::core::CoreGraphReceiver< GraphInput >::receive ( std::shared_ptr< GraphInput > ptr )

inlinefinalvirtual

Define how the graph receives data for a specific type and sends the data to all input nodes.

Parameters

ptr	Data received by the graph

Implements hh::core::CoreReceiver< GraphInput >.

Definition at line 75 of file core_graph_receiver.h.

◆ receiverEmpty()

template<class GraphInput>

bool hh::core::CoreGraphReceiver< GraphInput >::receiverEmpty ( )

inlinefinalvirtual

Test emptiness in all graph receivers.

Returns: True if all graph receivers are empty, else False

Implements hh::core::CoreReceiver< GraphInput >.

Definition at line 89 of file core_graph_receiver.h.

◆ receivers()

template<class GraphInput>

std::set<CoreReceiver < GraphInput> *> hh::core::CoreGraphReceiver< GraphInput >::receivers ( )

inlineoverridevirtual

Get a set of CoreReceiver built from the input nodes.

Returns: Set of CoreReceiver build from the input nodes

Implements hh::core::CoreReceiver< GraphInput >.

Definition at line 101 of file core_graph_receiver.h.

Here is the caller graph for this function:

◆ removeSender()

template<class GraphInput>

void hh::core::CoreGraphReceiver< GraphInput >::removeSender ( CoreSender< GraphInput > * sender )

inlinefinalvirtual

Remove a CoreSender from the graph.

CoreSender to remove from all input nodes

Parameters

sender CoreSender to remove from the graph

Implements hh::core::CoreReceiver< GraphInput >.

Definition at line 66 of file core_graph_receiver.h.

Here is the caller graph for this function:

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

/home/tjb3/work/hedgehog-nist/hedgehog/core/io/graph/receiver/core_graph_receiver.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class GraphInput> class hh::core::CoreGraphReceiver< GraphInput >

Constructor & Destructor Documentation

◆ CoreGraphReceiver()

Member Function Documentation

◆ addGraphReceiverInput()

◆ addSender()

◆ node()

◆ receive()

◆ receiverEmpty()

◆ receivers()

◆ removeSender()

template<class GraphInput>
class hh::core::CoreGraphReceiver< GraphInput >