aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
gum::MRFWriter< GUM_SCALAR > Class Template Referenceabstract

Pure virtual class for writting a MRF to a file. More...

#include <agrum/MRF/io/MRFWriter.h>

Inheritance diagram for gum::MRFWriter< GUM_SCALAR >:

Public Member Functions

 MRFWriter ()
 Default constructor.
virtual ~MRFWriter ()
 Default destructor.
virtual void write (std::ostream &output, const IMarkovRandomField< GUM_SCALAR > &MN)=0
 Writes a Markov random field in the ouput stream.
virtual void write (const std::string &filePath, const IMarkovRandomField< GUM_SCALAR > &MN)=0
 Writes a Markov random field in the file referenced by filePath.

Detailed Description

template<typename GUM_SCALAR>
class gum::MRFWriter< GUM_SCALAR >

Pure virtual class for writting a MRF to a file.

Every class used to write the content of a Markov random field in a stream, or a file must be a subclass of MRFWriter.

Definition at line 78 of file MRFWriter.h.

Constructor & Destructor Documentation

◆ MRFWriter()

template<typename GUM_SCALAR>
gum::MRFWriter< GUM_SCALAR >::MRFWriter ( )

Default constructor.

◆ ~MRFWriter()

template<typename GUM_SCALAR>
virtual gum::MRFWriter< GUM_SCALAR >::~MRFWriter ( )
virtual

Default destructor.

Member Function Documentation

◆ write() [1/2]

template<typename GUM_SCALAR>
virtual void gum::MRFWriter< GUM_SCALAR >::write ( const std::string & filePath,
const IMarkovRandomField< GUM_SCALAR > & MN )
pure virtual

Writes a Markov random field in the file referenced by filePath.

If the file doesn't exists, it is created. If the file exists, it's content will be erased.

Parameters
filePathThe path to the file used to write the Markov random field.
MNThe Markov random field writen in the file.
Exceptions
IOErrorRaised if an I/O error occurs.

Implemented in gum::UAIMRFWriter< GUM_SCALAR >.

◆ write() [2/2]

template<typename GUM_SCALAR>
virtual void gum::MRFWriter< GUM_SCALAR >::write ( std::ostream & output,
const IMarkovRandomField< GUM_SCALAR > & MN )
pure virtual

Writes a Markov random field in the ouput stream.

Parameters
outputThe output stream.
MNThe Markov random field writed in output.
Exceptions
IOErrorRaised if an I/O error occurs.

Implemented in gum::UAIMRFWriter< GUM_SCALAR >.


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