Direct Graphical Models  v.1.7.0
Public Member Functions | Static Public Member Functions | List of all members
DirectGraphicalModels::CGraphKit Class Referenceabstract
DGM Module » Graph Building » Graph Kit

Abstract Kit class for constructing Graph-related objects. More...

#include <GraphKit.h>

Inheritance diagram for DirectGraphicalModels::CGraphKit:
Inheritance graph
[legend]

Public Member Functions

 CGraphKit ()=default
 
 CGraphKit (const CGraphKit &)=delete
 
virtual ~CGraphKit ()=default
 
const CGraphKit & operator= (const CGraphKit &)=delete
 
virtual CGraph & getGraph ()=0
 Returns the graph object. More...
 
virtual CInfer & getInfer ()=0
 Returns the inference / decoding object. More...
 
virtual CGraphExt & getGraphExt ()=0
 Returns the graph extension object. More...
 

Static Public Member Functions

static std::shared_ptr< CGraphKit > create (GraphType graphType, byte nStates)
 Factory method returning graph kit object. More...
 

Detailed Description

Abstract Kit class for constructing Graph-related objects.

The derived classes are aught to create compatible objects for graph building and inference / decoding. This abstract class provides a standard interface for accessing these objects.

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

Definition at line 27 of file GraphKit.h.

Constructor & Destructor Documentation

◆ CGraphKit() [1/2]

DirectGraphicalModels::CGraphKit::CGraphKit ( )
default

◆ CGraphKit() [2/2]

DirectGraphicalModels::CGraphKit::CGraphKit ( const CGraphKit &  )
delete

◆ ~CGraphKit()

virtual DirectGraphicalModels::CGraphKit::~CGraphKit ( )
virtualdefault

Member Function Documentation

◆ create()

std::shared_ptr< CGraphKit > DirectGraphicalModels::CGraphKit::create ( GraphType  graphType,
byte  nStates 
)
static

Factory method returning graph kit object.

Note
The resulting graph kit object is created with default parameters
Parameters
graphTypeType of the desired graphical model (Ref. GraphType)
nStatesThe number of States (classes)
Returns
Tne pointer to the concrete implementation of the graph kit class

Definition at line 8 of file GraphKit.cpp.

◆ getGraph()

virtual CGraph& DirectGraphicalModels::CGraphKit::getGraph ( )
pure virtual

Returns the graph object.

Returns
The reference to the graph object

Implemented in DirectGraphicalModels::CGraphPairwiseKit, and DirectGraphicalModels::CGraphDenseKit.

◆ getGraphExt()

virtual CGraphExt& DirectGraphicalModels::CGraphKit::getGraphExt ( )
pure virtual

Returns the graph extension object.

Returns
The reference to the graph extension object

Implemented in DirectGraphicalModels::CGraphPairwiseKit, and DirectGraphicalModels::CGraphDenseKit.

◆ getInfer()

virtual CInfer& DirectGraphicalModels::CGraphKit::getInfer ( )
pure virtual

Returns the inference / decoding object.

Returns
The reference to the inference / decoding object

Implemented in DirectGraphicalModels::CGraphPairwiseKit, and DirectGraphicalModels::CGraphDenseKit.

◆ operator=()

const CGraphKit& DirectGraphicalModels::CGraphKit::operator= ( const CGraphKit &  )
delete
The documentation for this class was generated from the following files: