gum::NetWriter< GUM_SCALAR > Class Template Reference

Writes a IBayesNet in the BN format. More...

#include <agrum/BN/io/net/netWriter.h>

Inheritance diagram for gum::NetWriter< GUM_SCALAR >:

Collaboration diagram for gum::NetWriter< GUM_SCALAR >:

Public Member Functions
void	write (std::ostream &output, const IBayesNet< GUM_SCALAR > &bn)
	Writes a Bayesian network in the output stream.
void	write (const std::string &filePath, const IBayesNet< GUM_SCALAR > &bn)
	Writes a Bayesian network in the file referenced by filePath.
GUM_NODISCARD bool	isModificationAllowed () const
void	setAllowModification (bool am)
Constructor & destructor
	NetWriter ()
	Default constructor.
	~NetWriter () override
	Destructor.
	NetWriter (const NetWriter &)=default
	Default constructor.
	NetWriter (NetWriter &&) noexcept=default
	Default constructor.
NetWriter &	operator= (const NetWriter &)=default
	Default constructor.
NetWriter &	operator= (NetWriter &&) noexcept=default
	Default constructor.

Protected Member Functions
void	_doWrite (std::ostream &output, const IBayesNet< GUM_SCALAR > &bn) final
	Writes a Bayesian network in the output stream using the BN format.
void	_doWrite (const std::string &filePath, const IBayesNet< GUM_SCALAR > &bn) final
	Writes a Bayesian network in the referenced file using the BN format.

Private Member Functions
std::string	_variableBloc_ (const DiscreteVariable &var)
std::string	_variableCPT_ (const Tensor< GUM_SCALAR > &cpt)

Static Private Member Functions
static std::string	_header_ (const IBayesNet< GUM_SCALAR > &bn)
virtual void	_syntacticalCheck (const IBayesNet< GUM_SCALAR > &bn)
	Check whether the BN is syntactically correct for BIF format.
void	_validCharInNamesCheck (const IBayesNet< GUM_SCALAR > &bn)
	}
std::string	_onlyValidCharsInName (const std::string &name)
	}
std::string	_buildNameWithOnlyValidChars (const std::string &name)
	}
bool	_allowModification_ = false
	}

Detailed Description

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

Writes a IBayesNet in the BN format.

This class servers to write the content of a Bayesian network in the BN format. See TODO for information on this format.

Definition at line 76 of file netWriter.h.

Constructor & Destructor Documentation

NetWriter() [1/3]

template<typename GUM_SCALAR>

gum::NetWriter< GUM_SCALAR >::NetWriter

(

)

Default constructor.

Referenced by NetWriter(), NetWriter(), _variableCPT_(), operator=(), and operator=().

Here is the caller graph for this function:

~NetWriter()

template<typename GUM_SCALAR>

gum::NetWriter< GUM_SCALAR >::~NetWriter ( )

override

Destructor.

NetWriter() [2/3]

template<typename GUM_SCALAR>

gum::NetWriter< GUM_SCALAR >::NetWriter ( const NetWriter< GUM_SCALAR > & )

default

Default constructor.

References NetWriter().

Here is the call graph for this function:

NetWriter() [3/3]

template<typename GUM_SCALAR>

gum::NetWriter< GUM_SCALAR >::NetWriter ( NetWriter< GUM_SCALAR > && )

defaultnoexcept

Default constructor.

References NetWriter().

Here is the call graph for this function:

Member Function Documentation

_buildNameWithOnlyValidChars()

template<typename GUM_SCALAR>

std::string gum::BNWriter< GUM_SCALAR >::_buildNameWithOnlyValidChars ( const std::string & name )

protectedinherited

}

References _buildNameWithOnlyValidChars().

Referenced by _buildNameWithOnlyValidChars().

Here is the call graph for this function:

Here is the caller graph for this function:

_doWrite() [1/2]

template<typename GUM_SCALAR>

void gum::NetWriter< GUM_SCALAR >::_doWrite ( const std::string & filePath, const IBayesNet< GUM_SCALAR > & bn )

finalprotectedvirtual

Writes a Bayesian network in the referenced file using the BN format.

If the files do not exist, it is created.

Parameters

filePath	The path to the file used to write the Bayesian network.
bn	The Bayesian network written in the file.

Exceptions

IOError

Raised if and I/O error occurs.

Implements gum::BNWriter< GUM_SCALAR >.

References _doWrite().

Here is the call graph for this function:

_doWrite() [2/2]

template<typename GUM_SCALAR>

void gum::NetWriter< GUM_SCALAR >::_doWrite ( std::ostream & output, const IBayesNet< GUM_SCALAR > & bn )

finalprotectedvirtual

Writes a Bayesian network in the output stream using the BN format.

Parameters

output	The output stream.
bn	The Bayesian network writen in output.

Exceptions

IOError

Raised if and I/O error occurs.

Implements gum::BNWriter< GUM_SCALAR >.

References _doWrite().

Referenced by _doWrite(), and _doWrite().

Here is the call graph for this function:

Here is the caller graph for this function:

_header_()

template<typename GUM_SCALAR>

std::string gum::NetWriter< GUM_SCALAR >::_header_ ( const IBayesNet< GUM_SCALAR > & bn )

staticprivate

References _header_().

Referenced by _header_().

Here is the call graph for this function:

Here is the caller graph for this function:

_onlyValidCharsInName()

template<typename GUM_SCALAR>

std::string gum::BNWriter< GUM_SCALAR >::_onlyValidCharsInName ( const std::string & name )

protectedinherited

}

References _onlyValidCharsInName().

Referenced by _onlyValidCharsInName().

Here is the call graph for this function:

Here is the caller graph for this function:

_syntacticalCheck()

template<typename GUM_SCALAR>

virtual void gum::BNWriter< GUM_SCALAR >::_syntacticalCheck ( const IBayesNet< GUM_SCALAR > & bn )

protectedvirtualinherited

Check whether the BN is syntactically correct for BIF format.

Exceptions

FatalError

if found.

Reimplemented in gum::BIFWriter< GUM_SCALAR >, and gum::DSLWriter< GUM_SCALAR >.

References _syntacticalCheck().

Referenced by _syntacticalCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

_validCharInNamesCheck()

template<typename GUM_SCALAR>

void gum::BNWriter< GUM_SCALAR >::_validCharInNamesCheck ( const IBayesNet< GUM_SCALAR > & bn )

protectedinherited

}

References _validCharInNamesCheck().

Referenced by _validCharInNamesCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

_variableBloc_()

template<typename GUM_SCALAR>

std::string gum::NetWriter< GUM_SCALAR >::_variableBloc_ ( const DiscreteVariable & var )

private

References _variableBloc_().

Referenced by _variableBloc_().

Here is the call graph for this function:

Here is the caller graph for this function:

_variableCPT_()

template<typename GUM_SCALAR>

std::string gum::NetWriter< GUM_SCALAR >::_variableCPT_ ( const Tensor< GUM_SCALAR > & cpt )

private

References NetWriter(), and _variableCPT_().

Referenced by _variableCPT_().

Here is the call graph for this function:

Here is the caller graph for this function:

isModificationAllowed()

template<typename GUM_SCALAR>

GUM_NODISCARD bool gum::BNWriter< GUM_SCALAR >::isModificationAllowed ( ) const

inherited

References GUM_NODISCARD, and isModificationAllowed().

Referenced by isModificationAllowed().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

template<typename GUM_SCALAR>

NetWriter & gum::NetWriter< GUM_SCALAR >::operator= ( const NetWriter< GUM_SCALAR > & )

default

Default constructor.

References NetWriter().

Here is the call graph for this function:

operator=() [2/2]

template<typename GUM_SCALAR>

NetWriter & gum::NetWriter< GUM_SCALAR >::operator= ( NetWriter< GUM_SCALAR > && )

defaultnoexcept

Default constructor.

References NetWriter().

Here is the call graph for this function:

setAllowModification()

template<typename GUM_SCALAR>

void gum::BNWriter< GUM_SCALAR >::setAllowModification ( bool am )

inherited

References setAllowModification().

Referenced by setAllowModification().

Here is the call graph for this function:

Here is the caller graph for this function:

write() [1/2]

template<typename GUM_SCALAR>

void gum::BNWriter< GUM_SCALAR >::write ( const std::string & filePath, const IBayesNet< GUM_SCALAR > & bn )

inherited

Writes a Bayesian network 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.
• If the bn can not be written for syntactical reasons, throw an error or try to correct it (conditioned by the value of allowModification

Parameters

filePath	The path to the file used to write the Bayesian network.
bn	The Bayesian network writen in the file.

Exceptions

IOError

Raised if an I/O error occurs.

References write().

Here is the call graph for this function:

write() [2/2]

template<typename GUM_SCALAR>

void gum::BNWriter< GUM_SCALAR >::write ( std::ostream & output, const IBayesNet< GUM_SCALAR > & bn )

inherited

Writes a Bayesian network in the output stream.

• If the bn can not be written for syntactical reasons, throw an error or try to correct it (conditioned by the value of allowModification

Parameters

output	The output stream.
bn	The Bayesian network written in output.

Exceptions

IOError	Raised if an I/O error occurs.
SyntaxError	Raised if syntactical errors in the BN

References write().

Referenced by gum::credal::CredalNet< GUM_SCALAR >::saveBNsMinMax(), write(), and write().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_allowModification_

template<typename GUM_SCALAR>

bool gum::BNWriter< GUM_SCALAR >::_allowModification_ = false

privateinherited

}

Definition at line 163 of file BNWriter.h.

---

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

• agrum/BN/io/net/netWriter.h