Writes a Bayes net in a text file with UAI format. More...

#include <agrum/BN/io/UAI/UAIBNWriter.h>

Inheritance diagram for gum::UAIBNWriter< GUM_SCALAR >:

Collaboration diagram for gum::UAIBNWriter< GUM_SCALAR >:

Public Member Functions
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)
Constructor & destructor
	UAIBNWriter ()
	Default constructor.
	~UAIBNWriter () override
	Destructor.
	UAIBNWriter (const UAIBNWriter &)=default
	Default constructor.
	UAIBNWriter (UAIBNWriter &&) noexcept=default
	Default constructor.
UAIBNWriter &	operator= (const UAIBNWriter &)=default
	Default constructor.
UAIBNWriter &	operator= (UAIBNWriter &&) noexcept=default
	Default constructor.

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

Private Member Functions
std::string	_preambule_ (const IBayesNet< GUM_SCALAR > &bn)
	Returns the header of the BIF file.
std::string	_cptBloc_ (const IBayesNet< GUM_SCALAR > &bn, NodeId node)
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)
	}
bool	_allowModification_ = false
	}

Detailed Description

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

Writes a Bayes net in a text file with UAI format.

This class export a bayes net into an text file, using UAI format cf. http://www.cs.huji.ac.il/project/PASCAL/fileFormat.php

Definition at line 74 of file UAIBNWriter.h.

Constructor & Destructor Documentation

◆ UAIBNWriter() [1/3]

template<GUM_Numeric GUM_SCALAR>

gum::UAIBNWriter< GUM_SCALAR >::UAIBNWriter ( )

Default constructor.

Referenced by UAIBNWriter(), UAIBNWriter(), _cptBloc_(), operator=(), and operator=().

Here is the caller graph for this function:

◆ ~UAIBNWriter()

template<GUM_Numeric GUM_SCALAR>

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

override

Destructor.

◆ UAIBNWriter() [2/3]

template<GUM_Numeric GUM_SCALAR>

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

default

Default constructor.

References UAIBNWriter().

Here is the call graph for this function:

◆ UAIBNWriter() [3/3]

template<GUM_Numeric GUM_SCALAR>

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

defaultnoexcept

Default constructor.

References UAIBNWriter().

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 )

protectedinherited

}

References _buildNameWithOnlyValidChars().

Referenced by _buildNameWithOnlyValidChars().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _cptBloc_()

template<GUM_Numeric GUM_SCALAR>

std::string gum::UAIBNWriter< GUM_SCALAR >::_cptBloc_	(	const IBayesNet< GUM_SCALAR > &	bn,
		NodeId	node )

private

References UAIBNWriter(), and _cptBloc_().

Referenced by _cptBloc_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _doWrite() [1/2]

template<GUM_Numeric GUM_SCALAR>

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

finalprotectedvirtual

Writes a Bayes net in the given output stream.

Parameters

output	The output stream.
bn	The bayes net written to 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:

◆ _doWrite() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

finalprotectedvirtual

Writes a 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.
bn	The bayes net written to 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:

◆ _onlyValidCharsInName()

template<GUM_Numeric GUM_SCALAR>

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

protectedinherited

}

References _onlyValidCharsInName().

Referenced by _onlyValidCharsInName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _preambule_()

template<GUM_Numeric GUM_SCALAR>

std::string gum::UAIBNWriter< GUM_SCALAR >::_preambule_ ( const IBayesNet< GUM_SCALAR > & bn )

private

Returns the header of the BIF file.

References _preambule_().

Referenced by _preambule_().

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 )

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

◆ isModificationAllowed()

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

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

default

Default constructor.

References UAIBNWriter().

Here is the call graph for this function:

◆ operator=() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

defaultnoexcept

Default constructor.

References UAIBNWriter().

Here is the call graph for this function:

◆ setAllowModification()

template<GUM_Numeric 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:

◆ toString()

template<GUM_Numeric GUM_SCALAR>

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

inherited

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 )

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 (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 )

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

privateinherited

}

Definition at line 167 of file BNWriter.h.

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

agrum/BN/io/UAI/UAIBNWriter.h

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ UAIBNWriter() [1/3]

◆ ~UAIBNWriter()

◆ UAIBNWriter() [2/3]

◆ UAIBNWriter() [3/3]

Member Function Documentation

◆ _buildNameWithOnlyValidChars()

◆ _cptBloc_()

◆ _doWrite() [1/2]

◆ _doWrite() [2/2]

◆ _onlyValidCharsInName()

◆ _preambule_()

◆ _syntacticalCheck()

◆ _validCharInNamesCheck()

◆ isModificationAllowed()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setAllowModification()

◆ toString()

◆ write() [1/2]

◆ write() [2/2]

Member Data Documentation

◆ _allowModification_