<agrum/BN/io/BIFXML/BIFXMLBNWriter.h> More...

#include <BIFXMLBNWriter.h>

Inheritance diagram for gum::BIFXMLBNWriter< GUM_SCALAR >:

Collaboration diagram for gum::BIFXMLBNWriter< 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
	BIFXMLBNWriter ()
	Default constructor.
	~BIFXMLBNWriter () override
	Destructor.
	BIFXMLBNWriter (const BIFXMLBNWriter &)=default
	Default constructor.
	BIFXMLBNWriter (BIFXMLBNWriter &&) noexcept=default
	Default constructor.
BIFXMLBNWriter &	operator= (const BIFXMLBNWriter &)=default
	Default constructor.
BIFXMLBNWriter &	operator= (BIFXMLBNWriter &&) noexcept=default
	Default constructor.

Protected Member Functions
void	_doWrite (std::ostream &output, const IBayesNet< GUM_SCALAR > &bn) final
	Writes an bayes net in the given ouput stream.
void	_doWrite (const std::string &filePath, const IBayesNet< GUM_SCALAR > &bn) final
	Writes an bayes net in the file referenced by filePath.

Private Member Functions
std::string	_heading_ (const IBayesNet< GUM_SCALAR > &bn)
	Returns the header of the BIF file.
std::string	_documentend_ ()
	Returns the end of the BIF file.
std::string	_variableBloc_ (const DiscreteVariable &var)
	Returns a bloc defining a variable in the BIF format.
std::string	_variableDefinition_ (const NodeId &varNodeId, const IBayesNet< GUM_SCALAR > &bn)
	Returns a bloc defining a variable's table (if she has) in the BIF format.
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::BIFXMLBNWriter< GUM_SCALAR >

Writes an bayes net in a XML file with BIF format

This class export a bayes net into an XML files, using BIF format See http://www-2.cs.cmu.edu/afs/cs/user/fgcozman/www/Research/InterchangeFormat/ for information about this format.

Definition at line 81 of file BIFXMLBNWriter.h.

Constructor & Destructor Documentation

◆ BIFXMLBNWriter() [1/3]

template<typename GUM_SCALAR>

gum::BIFXMLBNWriter< GUM_SCALAR >::BIFXMLBNWriter ( )

Default constructor.

Referenced by BIFXMLBNWriter(), BIFXMLBNWriter(), _variableDefinition_(), operator=(), and operator=().

Here is the caller graph for this function:

◆ ~BIFXMLBNWriter()

template<typename GUM_SCALAR>

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

override

Destructor.

◆ BIFXMLBNWriter() [2/3]

template<typename GUM_SCALAR>

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

default

Default constructor.

References BIFXMLBNWriter().

Here is the call graph for this function:

◆ BIFXMLBNWriter() [3/3]

template<typename GUM_SCALAR>

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

defaultnoexcept

Default constructor.

References BIFXMLBNWriter().

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:

◆ _documentend_()

template<typename GUM_SCALAR>

std::string gum::BIFXMLBNWriter< GUM_SCALAR >::_documentend_ ( )

private

Returns the end of the BIF file.

References _documentend_().

Referenced by _documentend_().

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::BIFXMLBNWriter< GUM_SCALAR >::_doWrite	(	const std::string &	filePath,
		const IBayesNet< GUM_SCALAR > &	bn )

finalprotectedvirtual

Writes an bayes net 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 bayes net.
infdiag	The bayes net writen in the file.

Exceptions

IOError Raised if an 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::BIFXMLBNWriter< GUM_SCALAR >::_doWrite	(	std::ostream &	output,
		const IBayesNet< GUM_SCALAR > &	bn )

finalprotectedvirtual

Writes an bayes net in the given ouput stream.

Parameters

output	The output stream.
infdiag	The bayes net writen in the stream.

Exceptions

IOError Raised if an 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:

◆ _heading_()

template<typename GUM_SCALAR>

std::string gum::BIFXMLBNWriter< GUM_SCALAR >::_heading_ ( const IBayesNet< GUM_SCALAR > & bn )

private

Returns the header of the BIF file.

References _heading_().

Referenced by _heading_().

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::BIFXMLBNWriter< GUM_SCALAR >::_variableBloc_ ( const DiscreteVariable & var )

private

Returns a bloc defining a variable in the BIF format.

References _variableBloc_().

Referenced by _variableBloc_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _variableDefinition_()

template<typename GUM_SCALAR>

std::string gum::BIFXMLBNWriter< GUM_SCALAR >::_variableDefinition_	(	const NodeId &	varNodeId,
		const IBayesNet< GUM_SCALAR > &	bn )

private

Returns a bloc defining a variable's table (if she has) in the BIF format.

References BIFXMLBNWriter(), and _variableDefinition_().

Referenced by _variableDefinition_().

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>

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

defaultnoexcept

Default constructor.

References BIFXMLBNWriter().

Here is the call graph for this function:

◆ operator=() [2/2]

template<typename GUM_SCALAR>

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

default

Default constructor.

References BIFXMLBNWriter().

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/BIFXML/BIFXMLBNWriter.h

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BIFXMLBNWriter() [1/3]

◆ ~BIFXMLBNWriter()

◆ BIFXMLBNWriter() [2/3]

◆ BIFXMLBNWriter() [3/3]

Member Function Documentation

◆ _buildNameWithOnlyValidChars()

◆ _documentend_()

◆ _doWrite() [1/2]

◆ _doWrite() [2/2]

◆ _heading_()

◆ _onlyValidCharsInName()

◆ _syntacticalCheck()

◆ _validCharInNamesCheck()

◆ _variableBloc_()

◆ _variableDefinition_()

◆ isModificationAllowed()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setAllowModification()

◆ write() [1/2]

◆ write() [2/2]

Member Data Documentation

◆ _allowModification_