Pairwise graph class. More...

#include <GraphWeiss.h>

Inheritance diagram for DirectGraphicalModels::CGraphWeiss:

Collaboration diagram for DirectGraphicalModels::CGraphWeiss:

[legend]

Classes
struct	Edge
	Edge structure More...

struct	Node
	Node structure More...

Public Types
using	vec_pEdge_t = std::vector< Edge * >

using	vec_pNode_t = std::vector< Node * >

Public Member Functions
	CGraphWeiss (byte nStates)
	Constructor. More...

virtual	~CGraphWeiss (void)

void	reset (void) override
	Resets the graph. More...

size_t	addNode (const Mat &pot=EmptyMat) override
	Adds an additional node (with specified potentional) More...

void	setNode (size_t node, const Mat &pot) override
	Sets or changes the potential of node. More...

void	getNode (size_t node, Mat &pot) const override
	Returns the node potential. More...

void	getChildNodes (size_t node, vec_size_t &vNodes) const override
	Returns the set of IDs of the child nodes of the argument node. More...

void	getParentNodes (size_t node, vec_size_t &vNodes) const override
	Returns the set of IDs of the parent nodes of the argument node. More...

size_t	getNumNodes (void) const override
	Returns the number of nodes in the graph. More...

size_t	getNumEdges (void) const override
	Returns the number of edges in the graph. More...

void	addEdge (size_t srcNode, size_t dstNode, byte group, const Mat &pot) override
	Adds an additional directed edge with specified potentional. More...

void	setEdge (size_t srcNode, size_t dstNode, const Mat &pot) override
	Sets or changes the potentional of directed edge. More...

void	setEdges (std::optional< byte > group, const Mat &pot) override
	Sets the potential pot to all edges belonging to group group. More...

void	getEdge (size_t srcNode, size_t dstNode, Mat &pot) const override
	Returns the edge potential. More...

void	setEdgeGroup (size_t srcNode, size_t dstNode, byte group) override
	Assigns a directed edge (srcNode) –> (dstNode) to the group group. More...

byte	getEdgeGroup (size_t srcNode, size_t dstNode) const override
	Returns the group of the edge. More...

void	removeEdge (size_t srcNode, size_t dstNode) override
	Removes the specified edge. More...

bool	isEdgeExists (size_t srcNode, size_t dstNode) const override
	Checks whether the edge exists. More...

Public Member Functions inherited from DirectGraphicalModels::IGraphPairwise
	IGraphPairwise (byte nStates)
	Constructor. More...

virtual	~IGraphPairwise (void)=default

void	marginalize (const vec_size_t &nodes)
	Marginalizes a set of nodes. More...

void	addEdge (size_t srcNode, size_t dstNode, const Mat &pot=EmptyMat)
	Adds an additional directed edge with specified potentional. More...

virtual bool	isEdgeArc (size_t srcNode, size_t dstNode) const
	Checks whether the edge is a part of an arc. More...

void	addArc (size_t Node1, size_t Node2, const Mat &pot=EmptyMat)
	Adds an additional udirected edge (arc) with specified potentional. More...

virtual void	addArc (size_t Node1, size_t Node2, byte group, const Mat &pot)
	Adds an additional udirected edge (arc) with specified potentional. More...

virtual void	setArc (size_t Node1, size_t Node2, const Mat &pot)
	Sets or changes the potentional of udirected edge (arc) More...

virtual void	setArcGroup (size_t Node1, size_t Node2, byte group)
	Assigns an undirected edge (arc) (Node1) – (Node2) to the group group. More...

virtual void	removeArc (size_t Node1, size_t Node2)
	Removes the specified arc. More...

virtual bool	isArcExists (size_t Node1, size_t Node2) const
	Checks whether the arc exists. More...

Public Member Functions inherited from DirectGraphicalModels::CGraph
	CGraph (byte nStates)
	Constructor. More...

	CGraph (const CGraph &)=delete

virtual	~CGraph (void)=default

const CGraph &	operator= (const CGraph &)=delete

virtual void	addNodes (const Mat &pots)
	Adds the graph nodes with potentials. More...

virtual void	setNodes (size_t start_node, const Mat &pots)
	Fills the graph nodes with new potentials. More...

virtual void	getNodes (size_t start_node, size_t num_nodes, Mat &pots) const
	Returns the node potentials. More...

byte	getNumStates (void) const
	Returns number of states (classes) More...

Protected Member Functions
Edge *	findEdge (size_t srcNode, size_t dstNode) const
	Finds and returns the Edge defined by two nodes. More...

Private Attributes
size_t	m_IDx

vec_pNode_t	m_vpNodes

Detailed Description

Pairwise graph class.

Implementation is based on M. A. Weiss recommendations

Warning: This class is added for academic reasons. Do not use with Inference / Decoding classes

Author: Sergey G. Kosov, serge.nosp@m.y.ko.nosp@m.sov@p.nosp@m.roje.nosp@m.ct-10.nosp@m..de

Definition at line 18 of file GraphWeiss.h.

Member Typedef Documentation

◆ vec_pEdge_t

using DirectGraphicalModels::CGraphWeiss::vec_pEdge_t = std::vector<Edge *>

Todo:: Use smart pointers here

Definition at line 52 of file GraphWeiss.h.

◆ vec_pNode_t

using DirectGraphicalModels::CGraphWeiss::vec_pNode_t = std::vector<Node *>

Todo:: Use smart pointers here

Definition at line 74 of file GraphWeiss.h.

Constructor & Destructor Documentation

◆ CGraphWeiss()

DirectGraphicalModels::CGraphWeiss::CGraphWeiss ( byte nStates )

Constructor.

Parameters

nStates the number of States (classes)

Definition at line 7 of file GraphWeiss.cpp.

◆ ~CGraphWeiss()

DirectGraphicalModels::CGraphWeiss::~CGraphWeiss ( void )

virtual

Definition at line 13 of file GraphWeiss.cpp.

Member Function Documentation

◆ addEdge()

void DirectGraphicalModels::CGraphWeiss::addEdge	(	size_t	srcNode,
		size_t	dstNode,
		byte	group,
		const Mat &	pot
	)

overridevirtual

Adds an additional directed edge with specified potentional.

Parameters

srcNode	index of the source node
dstNode	index of the destination node
group	The edge group ID
pot	Edge potential matrix: Mat(size: nStates x nStates; type: CV_32FC1)

Implements DirectGraphicalModels::IGraphPairwise.

Definition at line 87 of file GraphWeiss.cpp.

◆ addNode()

size_t DirectGraphicalModels::CGraphWeiss::addNode ( const Mat & pot = EmptyMat )

overridevirtual

Adds an additional node (with specified potentional)

Parameters

pot	node potential vector: Mat(size: nStates x 1; type: CV_32FC1)

Returns: the node's ID

Implements DirectGraphicalModels::CGraph.

Definition at line 31 of file GraphWeiss.cpp.

◆ findEdge()

CGraphWeiss::Edge * DirectGraphicalModels::CGraphWeiss::findEdge	(	size_t	srcNode,
		size_t	dstNode
	)		const

protected

Finds and returns the Edge defined by two nodes.

Parameters

srcNode	index of the source node
dstNode	index of the destination node

Returns: Pointer to the Edge if found, NULL otherwise

Definition at line 193 of file GraphWeiss.cpp.

Here is the caller graph for this function:

◆ getChildNodes()

void DirectGraphicalModels::CGraphWeiss::getChildNodes	(	size_t	node,
		vec_size_t &	vNodes
	)		const

overridevirtual

Returns the set of IDs of the child nodes of the argument node.

Parameters

[in]	node	node index
[out]	vNodes	vector with the child node's ID

Implements DirectGraphicalModels::CGraph.

Definition at line 59 of file GraphWeiss.cpp.

◆ getEdge()

void DirectGraphicalModels::CGraphWeiss::getEdge	(	size_t	srcNode,
		size_t	dstNode,
		Mat &	pot
	)		const

overridevirtual

Returns the edge potential.

Parameters

[in]	srcNode	index of the source node
[in]	dstNode	index of the destination node
[out]	pot	edge potential matrix: Mat(size: nStates x nStates; type: CV_32FC1) if exists, empty Mat otherwise

Implements DirectGraphicalModels::IGraphPairwise.

Definition at line 127 of file GraphWeiss.cpp.

Here is the call graph for this function:

◆ getEdgeGroup()

byte DirectGraphicalModels::CGraphWeiss::getEdgeGroup	(	size_t	srcNode,
		size_t	dstNode
	)		const

overridevirtual

Returns the group of the edge.

Parameters

srcNode	index of the source node
dstNode	index of the destination node

Returns: The edge group ID

Implements DirectGraphicalModels::IGraphPairwise.

Definition at line 151 of file GraphWeiss.cpp.

Here is the call graph for this function:

◆ getNode()

void DirectGraphicalModels::CGraphWeiss::getNode	(	size_t	node,
		Mat &	pot
	)		const

overridevirtual

Returns the node potential.

Parameters

[in]	node	node index
[out]	pot	node potential vector: Mat(size: nStates x 1; type: CV_32FC1)

Implements DirectGraphicalModels::CGraph.

Definition at line 49 of file GraphWeiss.cpp.

◆ getNumEdges()

size_t DirectGraphicalModels::CGraphWeiss::getNumEdges ( void ) const

overridevirtual

Returns the number of edges in the graph.

Returns: number of edges

Implements DirectGraphicalModels::CGraph.

Definition at line 78 of file GraphWeiss.cpp.

◆ getNumNodes()

size_t DirectGraphicalModels::CGraphWeiss::getNumNodes ( void ) const

inlineoverridevirtual

Returns the number of nodes in the graph.

Returns: number of nodes

Implements DirectGraphicalModels::CGraph.

Definition at line 92 of file GraphWeiss.h.

◆ getParentNodes()

void DirectGraphicalModels::CGraphWeiss::getParentNodes	(	size_t	node,
		vec_size_t &	vNodes
	)		const

overridevirtual

Returns the set of IDs of the parent nodes of the argument node.

Parameters

[in]	node	node index
[out]	vNodes	vector with the parent node's ID

Implements DirectGraphicalModels::CGraph.

Definition at line 69 of file GraphWeiss.cpp.

◆ isEdgeExists()

bool DirectGraphicalModels::CGraphWeiss::isEdgeExists	(	size_t	srcNode,
		size_t	dstNode
	)		const

overridevirtual

Checks whether the edge exists.

Parameters

srcNode	index of the source node
dstNode	index of the destination node

Return values

true	if the edge exists
false	otherwise

Implements DirectGraphicalModels::IGraphPairwise.

Definition at line 184 of file GraphWeiss.cpp.

Here is the call graph for this function:

◆ removeEdge()

void DirectGraphicalModels::CGraphWeiss::removeEdge	(	size_t	srcNode,
		size_t	dstNode
	)

overridevirtual

Removes the specified edge.

Parameters

srcNode	index of the source node
dstNode	index of the destination node

Implements DirectGraphicalModels::IGraphPairwise.

Definition at line 163 of file GraphWeiss.cpp.

Here is the call graph for this function:

◆ reset()

void DirectGraphicalModels::CGraphWeiss::reset ( void )

overridevirtual

Resets the graph.

This function allows to re-use the graph or update node potential, while preserving the graph structure. It deletes all the nodes and edges and sets node index to zero.

Implements DirectGraphicalModels::CGraph.

Definition at line 21 of file GraphWeiss.cpp.

◆ setEdge()

void DirectGraphicalModels::CGraphWeiss::setEdge	(	size_t	srcNode,
		size_t	dstNode,
		const Mat &	pot
	)

overridevirtual

Sets or changes the potentional of directed edge.

Parameters

srcNode	index of the source node
dstNode	index of the destination node
pot	Edge potential matrix: Mat(size: nStates x nStates; type: CV_32FC1)

Implements DirectGraphicalModels::IGraphPairwise.

Definition at line 106 of file GraphWeiss.cpp.

Here is the call graph for this function:

◆ setEdgeGroup()

void DirectGraphicalModels::CGraphWeiss::setEdgeGroup	(	size_t	srcNode,
		size_t	dstNode,
		byte	group
	)

overridevirtual

Assigns a directed edge (srcNode) –> (dstNode) to the group group.

Parameters

srcNode	index of the source node
dstNode	index of the destination node
group	The edge group ID

Implements DirectGraphicalModels::IGraphPairwise.

Definition at line 139 of file GraphWeiss.cpp.

Here is the call graph for this function:

◆ setEdges()

void DirectGraphicalModels::CGraphWeiss::setEdges	(	std::optional< byte >	group,
		const Mat &	pot
	)

overridevirtual

Sets the potential pot to all edges belonging to group group.

This function assigns the same potential matrix to all the edges in graph with group property equal to group. By default all edges have group 0. This mightbe changes with functon setEdgeGroup()

Parameters

group	The edge group ID. This argument is optional, and if it is not set, this function will set potential to all existing edges
pot	Edge potential matrix: Mat(size: nStates x nStates; type: CV_32FC1)

Implements DirectGraphicalModels::IGraphPairwise.

Definition at line 118 of file GraphWeiss.cpp.

◆ setNode()

void DirectGraphicalModels::CGraphWeiss::setNode	(	size_t	node,
		const Mat &	pot
	)

overridevirtual

Sets or changes the potential of node.

Parameters

node	node index
pot	node potential vector: Mat(size: nStates x 1; type: CV_32FC1)

Implements DirectGraphicalModels::CGraph.

Definition at line 39 of file GraphWeiss.cpp.

Member Data Documentation

◆ m_IDx

size_t DirectGraphicalModels::CGraphWeiss::m_IDx

private

Definition at line 115 of file GraphWeiss.h.

◆ m_vpNodes

vec_pNode_t DirectGraphicalModels::CGraphWeiss::m_vpNodes

private

Definition at line 116 of file GraphWeiss.h.

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

D:/Projects/DGM/modules/DGM/GraphWeiss.h
D:/Projects/DGM/modules/DGM/GraphWeiss.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ vec_pEdge_t

◆ vec_pNode_t

Constructor & Destructor Documentation

◆ CGraphWeiss()

◆ ~CGraphWeiss()

Member Function Documentation

◆ addEdge()

◆ addNode()

◆ findEdge()

◆ getChildNodes()

◆ getEdge()

◆ getEdgeGroup()

◆ getNode()

◆ getNumEdges()

◆ getNumNodes()

◆ getParentNodes()

◆ isEdgeExists()

◆ removeEdge()

◆ reset()

◆ setEdge()

◆ setEdgeGroup()

◆ setEdges()

◆ setNode()

Member Data Documentation

◆ m_IDx

◆ m_vpNodes