<agrum/BN/io/cnf/ContextualDependenciesCNFWriter.h> More...

#include <ContextualDependenciesCNFWriter.h>

Inheritance diagram for gum::ContextualDependenciesCNFWriter< GUM_SCALAR, IApproximationPolicy >:

Collaboration diagram for gum::ContextualDependenciesCNFWriter< GUM_SCALAR, IApproximationPolicy >:

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
	ContextualDependenciesCNFWriter ()
	Default constructor.
	~ContextualDependenciesCNFWriter () override
	Destructor.
Accessors/Modifiers
INLINE GUM_SCALAR	fromExact (const GUM_SCALAR &value) const override
	Convert value to approximation representation.
void	combineAdd (const ApproximationPolicy< GUM_SCALAR > *ap) override
	Combine using addition with the given gum::ApproximationPolicy.
void	combineSub (const ApproximationPolicy< GUM_SCALAR > *ap) override
	Combine using subtraction with the given gum::ApproximationPolicy.
void	combineMult (const ApproximationPolicy< GUM_SCALAR > *ap) override
	Combine using multiplication with the given gum::ApproximationPolicy.
void	combineDiv (const ApproximationPolicy< GUM_SCALAR > *ap) override
	Combine using division with the given gum::ApproximationPolicy.
void	combineMax (const ApproximationPolicy< GUM_SCALAR > *ap) override
	Combine using max with the given gum::ApproximationPolicy.
void	combineMin (const ApproximationPolicy< GUM_SCALAR > *ap) override
	Combine using min with the given gum::ApproximationPolicy.

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 (std::string_view filePath, const IBayesNet< GUM_SCALAR > &bn) final
	Writes a Bayesian network in the referenced file using the BN format.
GUM_SCALAR	fromExact (const GUM_SCALAR &value) const override
	Convert value to his approximation.
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_
	}

Detailed Description

template<GUM_Numeric GUM_SCALAR, template< typename > class IApproximationPolicy = ExactPolicy>
class gum::ContextualDependenciesCNFWriter< GUM_SCALAR, IApproximationPolicy >

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 80 of file ContextualDependenciesCNFWriter.h.

Constructor & Destructor Documentation

◆ ContextualDependenciesCNFWriter()

template<GUM_Numeric GUM_SCALAR, template< typename > class IApproximationPolicy = ExactPolicy>

gum::ContextualDependenciesCNFWriter< GUM_SCALAR, IApproximationPolicy >::ContextualDependenciesCNFWriter ( )

Default constructor.

◆ ~ContextualDependenciesCNFWriter()

template<GUM_Numeric GUM_SCALAR, template< typename > class IApproximationPolicy = ExactPolicy>

gum::ContextualDependenciesCNFWriter< GUM_SCALAR, IApproximationPolicy >::~ContextualDependenciesCNFWriter ( )

override

Destructor.

Member Function Documentation

◆ _buildNameWithOnlyValidChars()

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

protectedinherited

}

◆ _doWrite() [1/2]

template<GUM_Numeric GUM_SCALAR, template< typename > class IApproximationPolicy = ExactPolicy>

void gum::ContextualDependenciesCNFWriter< GUM_SCALAR, IApproximationPolicy >::_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 written to output.

Exceptions

IOError Raised if and I/O error occurs.

Implements gum::CNFWriter< GUM_SCALAR, ExactPolicy >.

◆ _doWrite() [2/2]

template<GUM_Numeric GUM_SCALAR, template< typename > class IApproximationPolicy = ExactPolicy>

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

finalprotectedvirtual

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

If the files doesn't exists, it is created.

Parameters

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

Exceptions

IOError Raised if and I/O error occurs.

Implements gum::BNWriter< GUM_SCALAR >.

◆ _onlyValidCharsInName()

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

protectedinherited

}

◆ _syntacticalCheck()

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.

◆ _validCharInNamesCheck()

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

protectedinherited

}

◆ combineAdd()

void gum::ExactPolicy< GUM_SCALAR >::combineAdd ( const ApproximationPolicy< GUM_SCALAR > * ap )

overrideinherited

Combine using addition with the given gum::ApproximationPolicy.

Parameters

ap	The policy to combine with.

Definition at line 97 of file exactPolicy_tpl.h.

69{}

◆ combineDiv()

void gum::ExactPolicy< GUM_SCALAR >::combineDiv ( const ApproximationPolicy< GUM_SCALAR > * ap )

overrideinherited

Combine using division with the given gum::ApproximationPolicy.

Parameters

ap	The policy to combine with.

Definition at line 117 of file exactPolicy_tpl.h.

83{}

◆ combineMax()

void gum::ExactPolicy< GUM_SCALAR >::combineMax ( const ApproximationPolicy< GUM_SCALAR > * ap )

overrideinherited

Combine using max with the given gum::ApproximationPolicy.

Parameters

ap	The policy to combine with.

Definition at line 123 of file exactPolicy_tpl.h.

87{}

◆ combineMin()

void gum::ExactPolicy< GUM_SCALAR >::combineMin ( const ApproximationPolicy< GUM_SCALAR > * ap )

overrideinherited

Combine using min with the given gum::ApproximationPolicy.

Parameters

ap	The policy to combine with.

Definition at line 129 of file exactPolicy_tpl.h.

91{}

◆ combineMult()

void gum::ExactPolicy< GUM_SCALAR >::combineMult ( const ApproximationPolicy< GUM_SCALAR > * ap )

overrideinherited

Combine using multiplication with the given gum::ApproximationPolicy.

Parameters

ap	The policy to combine with.

Definition at line 111 of file exactPolicy_tpl.h.

79{}

◆ combineSub()

void gum::ExactPolicy< GUM_SCALAR >::combineSub ( const ApproximationPolicy< GUM_SCALAR > * ap )

overrideinherited

Combine using subtraction with the given gum::ApproximationPolicy.

Parameters

ap	The policy to combine with.

Definition at line 104 of file exactPolicy_tpl.h.

74{}

◆ fromExact() [1/2]

GUM_SCALAR gum::ExactPolicy< GUM_SCALAR >::fromExact ( const GUM_SCALAR & value ) const

overrideinherited

Convert value to approximation representation.

Parameters

value The converted value.

Returns: The value approximation representation.

Definition at line 91 of file exactPolicy_tpl.h.

                                                                                  {
    return value;
  }

◆ fromExact() [2/2]

GUM_SCALAR gum::CNFWriter< GUM_SCALAR, ExactPolicy >::fromExact ( const GUM_SCALAR & value ) const

overrideprotectedvirtualinherited

Convert value to his approximation.

This method, at least in release mode, should not verify the limits

Parameters

value The converted value.

Returns: The value approximation representation.

Implements gum::ApproximationPolicy< GUM_SCALAR >.

◆ isModificationAllowed()

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

inherited

◆ setAllowModification()

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

inherited

◆ toString()

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

inherited

◆ write() [1/2]

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

◆ write() [2/2]

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.

Member Data Documentation

◆ _allowModification_

bool gum::BNWriter< GUM_SCALAR >::_allowModification_

privateinherited

}

Definition at line 167 of file BNWriter.h.

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

agrum/BN/io/cnf/ContextualDependenciesCNFWriter.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ContextualDependenciesCNFWriter()

◆ ~ContextualDependenciesCNFWriter()

Member Function Documentation

◆ _buildNameWithOnlyValidChars()

◆ _doWrite() [1/2]

◆ _doWrite() [2/2]

◆ _onlyValidCharsInName()

◆ _syntacticalCheck()

◆ _validCharInNamesCheck()

◆ combineAdd()

◆ combineDiv()

◆ combineMax()

◆ combineMin()

◆ combineMult()

◆ combineSub()

◆ fromExact() [1/2]

◆ fromExact() [2/2]

◆ isModificationAllowed()

◆ setAllowModification()

◆ toString()

◆ write() [1/2]

◆ write() [2/2]

Member Data Documentation

◆ _allowModification_