IXAGVertex Class Reference

Class for the vertices of an IXAssignmentGraph. More...

#include <indigox/graph/assignment.hpp>

Inheritance diagram for IXAGVertex:

Collaboration diagram for IXAGVertex:

Public Member Functions
	IXAGVertex ()=delete
uint32_t	GetAssignedCount () const
	Get the number of assigned electrons. More...
uint32_t	GetPreAssignedCount () const
	Get the number of pre-assigned electrons. More...
MGEdge	GetSourceEdge () const
	Obtain the referenced IXMolecularGraph edge. More...
MGVertex	GetSourceVertex () const
	Obtain the referenced IXMolecularGraph vertex. More...
uint32_t	GetTotalAssigned () const
	Get the total number of assigned electrons. More...
bool	IsEdgeMapped () const
	Is the associated IXMoleculerGraph member an edge. More...
bool	IsVertexMapped () const
	Is the associated IXMolecularGraph member a vertex. More...
void	SetAssignedCount (const uint32_t count)
	Set the number of assigned eletrons. More...
void	SetPreAssignedCount (const uint32_t count)
	Set the number of pre-assigned eletrons. More...

Friends
class	IXAssignmentGraph
	Friendship allows IXAssignmentGraph to construct vertices. More...

Detailed Description

Class for the vertices of an IXAssignmentGraph.

Constructor & Destructor Documentation

IXAGVertex()

IXAGVertex ( )

delete

Member Function Documentation

GetAssignedCount()

uint32_t GetAssignedCount ( ) const

inline

Get the number of assigned electrons.

Does not include preassigned electrons.

Returns

the number of assigned electrons.

GetPreAssignedCount()

uint32_t GetPreAssignedCount ( ) const

inline

Get the number of pre-assigned electrons.

Returns

the number of pre-assigned eletrons.

GetSourceEdge()

MGEdge GetSourceEdge ( ) const

inline

Obtain the referenced IXMolecularGraph edge.

If the IXAGVertex instance is not mapped to an edge, the returned MGVertex will be empty.

Returns

the MGEdge instance associated with this IXAGVertex.

GetSourceVertex()

MGVertex GetSourceVertex ( ) const

inline

Obtain the referenced IXMolecularGraph vertex.

If the IXAGVertex instance is not mapped to a vertex, the returned MGVertex will be empty.

Returns

the MGVertex instance associated with this IXAGVertex.

GetTotalAssigned()

uint32_t GetTotalAssigned ( ) const

inline

Get the total number of assigned electrons.

The total number of electrons is the sum of the number of pre-assigned electrons and the number of assigned electrons.

Returns

the total number of assigned electrons.

IsEdgeMapped()

bool IsEdgeMapped ( ) const

inline

Is the associated IXMoleculerGraph member an edge.

Returns

if the _source_edge member is not empty.

Referenced by IXAGVertex::GetSourceEdge().

IsVertexMapped()

bool IsVertexMapped ( ) const

inline

Is the associated IXMolecularGraph member a vertex.

Returns

if the _source_vert member is not empty.

Referenced by IXAGVertex::GetSourceVertex().

SetAssignedCount()

void SetAssignedCount ( const uint32_t  count )

inline

Set the number of assigned eletrons.

Parameters

count

the number of electrons to assign.

SetPreAssignedCount()

void SetPreAssignedCount ( const uint32_t  count )

inline

Set the number of pre-assigned eletrons.

ElectronAssignerAlgorithms will not modify this value.

Parameters

count

the number of electrons to pre-assign.

Friends And Related Function Documentation

IXAssignmentGraph

friend class IXAssignmentGraph

friend

Friendship allows IXAssignmentGraph to construct vertices.

---

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

• include/indigox/graph/assignment.hpp