virtual class for writing a BN to a file. More...

#include <agrum/BN/io/BNWriter.h>

Inheritance diagram for gum::BNWriter< GUM_SCALAR >:

Collaboration diagram for gum::BNWriter< GUM_SCALAR >:

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

Protected Member Functions
virtual void	_doWrite (std::ostream &output, const IBayesNet< GUM_SCALAR > &bn)=0
	Writes a Bayesian network in the output stream.
virtual void	_doWrite (std::string_view filePath, const IBayesNet< GUM_SCALAR > &bn)=0
	Writes a Bayesian network in the file referenced by filePath.
bool	_allowModification_ = false
	}
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 (std::string_view name)
	}
std::string	_buildNameWithOnlyValidChars (std::string_view name)
	}

Detailed Description

template<GUM_Numeric GUM_SCALAR>
class gum::BNWriter< GUM_SCALAR >

virtual class for writing a BN to a file.

Every class used to write the content of a Bayesian network in a stream, or a file must be a subclass of BNWriter.

Definition at line 79 of file BNWriter.h.

Constructor & Destructor Documentation

◆ BNWriter() [1/3]

template<GUM_Numeric GUM_SCALAR>

gum::BNWriter< GUM_SCALAR >::BNWriter ( )

explicit

Default constructor.

Referenced by BNWriter(), BNWriter(), operator=(), and operator=().

Here is the caller graph for this function:

◆ ~BNWriter()

template<GUM_Numeric GUM_SCALAR>

virtual gum::BNWriter< GUM_SCALAR >::~BNWriter ( )

virtual

Default destructor.

◆ BNWriter() [2/3]

template<GUM_Numeric GUM_SCALAR>

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

default

References BNWriter().

Here is the call graph for this function:

◆ BNWriter() [3/3]

template<GUM_Numeric GUM_SCALAR>

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

defaultnoexcept

References BNWriter().

Here is the call graph for this function:

Member Function Documentation

◆ _buildNameWithOnlyValidChars()

template<GUM_Numeric GUM_SCALAR>

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

protected

}

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<GUM_Numeric GUM_SCALAR>

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

protectedpure virtual

Writes a Bayesian network in the output stream.

Parameters

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

Exceptions

IOError Raised if an I/O error occurs.

Implemented in gum::BIFWriter< GUM_SCALAR >, gum::BIFXMLBNWriter< GUM_SCALAR >, gum::CNFWriter< GUM_SCALAR, IApproximationPolicy >, gum::CNFWriter< GUM_SCALAR, ExactPolicy >, gum::ContextualDependenciesCNFWriter< GUM_SCALAR, IApproximationPolicy >, gum::DSLWriter< GUM_SCALAR >, gum::FactorisedValuesCNFWriter< GUM_SCALAR, IApproximationPolicy >, gum::GeneralizedCNFWriter< GUM_SCALAR, IApproximationPolicy >, gum::GumBNWriter< GUM_SCALAR >, gum::NetWriter< GUM_SCALAR >, gum::O3prmBNWriter< GUM_SCALAR >, gum::UAIBNWriter< GUM_SCALAR >, and gum::XDSLBNWriter< 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:

◆ _doWrite() [2/2]

template<GUM_Numeric GUM_SCALAR>

virtual void gum::BNWriter< GUM_SCALAR >::_doWrite	(	std::string_view	filePath,
		const IBayesNet< GUM_SCALAR > &	bn )

protectedpure virtual

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.

Parameters

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

Exceptions

IOError Raised if an I/O error occurs.

Implemented in gum::BIFWriter< GUM_SCALAR >, gum::BIFXMLBNWriter< GUM_SCALAR >, gum::CNFWriter< GUM_SCALAR, IApproximationPolicy >, gum::ContextualDependenciesCNFWriter< GUM_SCALAR, IApproximationPolicy >, gum::DSLWriter< GUM_SCALAR >, gum::FactorisedValuesCNFWriter< GUM_SCALAR, IApproximationPolicy >, gum::GeneralizedCNFWriter< GUM_SCALAR, IApproximationPolicy >, gum::GumBNWriter< GUM_SCALAR >, gum::NetWriter< GUM_SCALAR >, gum::O3prmBNWriter< GUM_SCALAR >, gum::UAIBNWriter< GUM_SCALAR >, and gum::XDSLBNWriter< GUM_SCALAR >.

References _doWrite().

Here is the call graph for this function:

◆ _onlyValidCharsInName()

template<GUM_Numeric GUM_SCALAR>

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

protected

}

References _onlyValidCharsInName().

Referenced by _onlyValidCharsInName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _syntacticalCheck()

template<GUM_Numeric GUM_SCALAR>

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

protectedvirtual

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<GUM_Numeric GUM_SCALAR>

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

protected

}

References _validCharInNamesCheck().

Referenced by _validCharInNamesCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isModificationAllowed()

template<GUM_Numeric GUM_SCALAR>

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

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<GUM_Numeric GUM_SCALAR>

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

defaultnoexcept

References BNWriter().

Here is the call graph for this function:

◆ operator=() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

default

References BNWriter().

Here is the call graph for this function:

◆ setAllowModification()

template<GUM_Numeric GUM_SCALAR>

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

References setAllowModification().

Referenced by setAllowModification().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

template<GUM_Numeric GUM_SCALAR>

std::string gum::BNWriter< GUM_SCALAR >::toString ( const IBayesNet< GUM_SCALAR > & bn )

References toString().

Referenced by toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [1/2]

template<GUM_Numeric GUM_SCALAR>

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

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 (not const since updateMetaData).

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:

◆ write() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

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 written to the file (not const since updateMetaData).

Exceptions

IOError Raised if an I/O error occurs.

References write().

Here is the call graph for this function:

Member Data Documentation

◆ _allowModification_

template<GUM_Numeric GUM_SCALAR>

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

private

}

Definition at line 167 of file BNWriter.h.

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

agrum/BN/io/BNWriter.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BNWriter() [1/3]

◆ ~BNWriter()

◆ BNWriter() [2/3]

◆ BNWriter() [3/3]

Member Function Documentation

◆ _buildNameWithOnlyValidChars()

◆ _doWrite() [1/2]

◆ _doWrite() [2/2]

◆ _onlyValidCharsInName()

◆ _syntacticalCheck()

◆ _validCharInNamesCheck()

◆ isModificationAllowed()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setAllowModification()

◆ toString()

◆ write() [1/2]

◆ write() [2/2]

Member Data Documentation

◆ _allowModification_