Read an O3PRM and transform the gum::prm::PRMSystem into gum::BayesNet. More...

#include <agrum/PRM/o3prm/O3prmBNReader.h>

Inheritance diagram for gum::O3prmBNReader< GUM_SCALAR >:

Collaboration diagram for gum::O3prmBNReader< GUM_SCALAR >:

Public Member Functions
	O3prmBNReader (BayesNet< GUM_SCALAR > *bn, const std::string &filename, const std::string &entityName="", const std::string &classPath="")
	~O3prmBNReader () override
Size	proceed () override
	parse the file

Size	errors ()
	publishing Errors API
Size	warnings ()
Idx	errLine (Idx i)
	publishing Errors API
Idx	errCol (Idx i)
	col of ith error or warning
bool	errIsError (Idx i)
	type of ith error or warning
std::string	errMsg (Idx i)
	message of ith error or warning
void	showElegantErrors (std::ostream &o=std::cerr)
	send on std::cerr the list of errors
void	showElegantErrorsAndWarnings (std::ostream &o=std::cerr)
	send on std::cerr the list of errors or warnings
void	showErrorCounts (std::ostream &o=std::cerr)
	send on std::cerr the number of errors and the number of warnings

Private Member Functions
void	_generateBN_ (prm::PRMSystem< GUM_SCALAR > &system)

Static Private Member Functions
static std::string	_getVariableName_ (std::string_view path, std::string_view type, std::string_view name, std::string_view toRemove="")
static std::string	_getEntityName_ (std::string_view filename)
static std::string	_getInstanceName_ (std::string_view classname)

Private Attributes
std::string	_filename_
std::string	_classpath_
std::string	_entityName_
BayesNet< GUM_SCALAR > *	_bn_
ErrorsContainer	_errors_

Detailed Description

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

Read an O3PRM and transform the gum::prm::PRMSystem into gum::BayesNet.

Template Parameters

GUM_SCALAR The scalar type used both for the gum::prm::PRM and the gum::BayesNet.

Definition at line 75 of file O3prmBNReader.h.

Constructor & Destructor Documentation

◆ O3prmBNReader()

template<GUM_Numeric GUM_SCALAR>

gum::O3prmBNReader< GUM_SCALAR >::O3prmBNReader	(	BayesNet< GUM_SCALAR > *	bn,
		const std::string &	filename,
		const std::string &	entityName = "",
		const std::string &	classPath = "" )

Definition at line 84 of file O3prmBNReader_tpl.h.

                                                                              :
      BNReader< GUM_SCALAR >(bn, filename) {
    GUM_CONSTRUCTOR(O3prmBNReader);
    _bn_         = bn;
    _filename_   = filename;
    _entityName_ = entityName.empty() ? _getEntityName_(filename) : entityName;
    _classpath_  = classpath;
  }

References gum::BNReader< GUM_SCALAR >::BNReader(), O3prmBNReader(), _bn_, _classpath_, _entityName_, _filename_, and _getEntityName_().

Referenced by O3prmBNReader(), and ~O3prmBNReader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~O3prmBNReader()

template<GUM_Numeric GUM_SCALAR>

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

override

Definition at line 97 of file O3prmBNReader_tpl.h.

                                              {
    GUM_DESTRUCTOR(O3prmBNReader);
  }

References O3prmBNReader().

Here is the call graph for this function:

Member Function Documentation

◆ _generateBN_()

template<GUM_Numeric GUM_SCALAR>

void gum::O3prmBNReader< GUM_SCALAR >::_generateBN_ ( prm::PRMSystem< GUM_SCALAR > & system )

private

Definition at line 193 of file O3prmBNReader_tpl.h.

                                                                                   {
    system.instantiate();
    BayesNetFactory< GUM_SCALAR > factory(_bn_);
    system.groundedBN(factory);
    _bn_->setProperty("name", _entityName_);
  }

References _bn_, _entityName_, gum::prm::PRMSystem< GUM_SCALAR >::groundedBN(), and gum::prm::PRMSystem< GUM_SCALAR >::instantiate().

Referenced by proceed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getEntityName_()

template<GUM_Numeric GUM_SCALAR>

std::string gum::O3prmBNReader< GUM_SCALAR >::_getEntityName_ ( std::string_view filename )

staticprivate

Definition at line 76 of file O3prmBNReader_tpl.h.

                                                                                {
    auto b = filename.find_last_of("/\\");
    auto e = filename.find_last_of(".") - 1;
    GUM_ASSERT(e > b);   // we are waiting ../../basename.o3prm
    return std::string{filename.substr(b + 1, e - b)};
  }

Referenced by O3prmBNReader().

Here is the caller graph for this function:

◆ _getInstanceName_()

template<GUM_Numeric GUM_SCALAR>

std::string gum::O3prmBNReader< GUM_SCALAR >::_getInstanceName_ ( std::string_view classname )

staticprivate

Definition at line 69 of file O3prmBNReader_tpl.h.

                                                                                   {
    std::string res{classname.substr(0, 4)};
    std::transform(res.begin(), res.end(), res.begin(), ::tolower);
    return res;
  }

Referenced by proceed().

Here is the caller graph for this function:

◆ _getVariableName_()

template<GUM_Numeric GUM_SCALAR>

std::string gum::O3prmBNReader< GUM_SCALAR >::_getVariableName_	(	std::string_view	path,
		std::string_view	type,
		std::string_view	name,
		std::string_view	toRemove = "" )

staticprivate

Definition at line 56 of file O3prmBNReader_tpl.h.

                                                                                      {
    std::string res(path);
    res.append(name);   // path ends up with a "."
    if (!toRemove.empty()) {
      if (res.substr(0, toRemove.size()) == toRemove) { res = res.substr(toRemove.size()); }
    }
    return res;
  }

Referenced by proceed().

Here is the caller graph for this function:

◆ errCol()

template<GUM_Numeric GUM_SCALAR>

Idx gum::O3prmBNReader< GUM_SCALAR >::errCol ( Idx i )

col of ith error or warning

Definition at line 216 of file O3prmBNReader_tpl.h.

                                               {
    return _errors_.error(i).column;
  }

References _errors_.

◆ errIsError()

template<GUM_Numeric GUM_SCALAR>

bool gum::O3prmBNReader< GUM_SCALAR >::errIsError ( Idx i )

type of ith error or warning

Definition at line 221 of file O3prmBNReader_tpl.h.

                                                    {
    return _errors_.error(i).is_error;
  }

References _errors_.

◆ errLine()

template<GUM_Numeric GUM_SCALAR>

Idx gum::O3prmBNReader< GUM_SCALAR >::errLine ( Idx i )

publishing Errors API

of errors

Definition at line 211 of file O3prmBNReader_tpl.h.

                                                {
    return _errors_.error(i).line;
  }

References _errors_.

◆ errMsg()

template<GUM_Numeric GUM_SCALAR>

std::string gum::O3prmBNReader< GUM_SCALAR >::errMsg ( Idx i )

message of ith error or warning

Definition at line 226 of file O3prmBNReader_tpl.h.

                                                     {
    return _errors_.error(i).msg;
  }

References _errors_.

◆ errors()

template<GUM_Numeric GUM_SCALAR>

Size gum::O3prmBNReader< GUM_SCALAR >::errors ( )

publishing Errors API

of errors

Definition at line 201 of file O3prmBNReader_tpl.h.

                                           {
    return _errors_.error_count;
  }

References _errors_.

Referenced by proceed().

Here is the caller graph for this function:

◆ proceed()

template<GUM_Numeric GUM_SCALAR>

Size gum::O3prmBNReader< GUM_SCALAR >::proceed ( )

override

parse the file

parse.

Returns: the number of detected errors and warnings

Exceptions

IOError if file not exists

Returns: the number of detected errors

Exceptions

IOError if file not exists

Definition at line 105 of file O3prmBNReader_tpl.h.

                                            {
    prm::o3prm::O3prmReader< GUM_SCALAR > reader;
    if (_classpath_ != "") { reader.addClassPath(_classpath_); }
    reader.readFile(_filename_);
    gum::prm::PRM< GUM_SCALAR >* prm = reader.prm();
    _errors_                         = reader.errorsContainer();
 
 
    if (errors() == 0) {
      std::string instanceName = "";
      if (prm->isSystem(_entityName_)) {
        _generateBN_(prm->getSystem(_entityName_));
      } else if (prm->isClass(_entityName_)) {
        _errors_.addWarning("No system '" + _entityName_
                                + "' found but class found. Generating unnamed instance.",
                            _filename_,
                            0,
                            0);
        gum::prm::PRMSystem< GUM_SCALAR > s("S_" + _entityName_);
        instanceName = _getInstanceName_(_entityName_);
        auto i = new gum::prm::PRMInstance< GUM_SCALAR >(instanceName, prm->getClass(_entityName_));
        s.add(i);
        _generateBN_(s);
        instanceName += ".";   // to be removed in  _getVariableName_
      } else if (prm->classes().size() == 1) {
        const std::string& entityName = (*prm->classes().begin())->name();
        ParseError warn(false,
                        "Unique class '" + entityName + "' found. Generating unnamed instance.",
                        _filename_,
                        0);
        _errors_.add(warn);
 
        gum::prm::PRMSystem< GUM_SCALAR > s("S_" + entityName);
        instanceName = _getInstanceName_(entityName);
        auto i = new gum::prm::PRMInstance< GUM_SCALAR >(instanceName, prm->getClass(entityName));
        s.add(i);
        _generateBN_(s);
 
        // force the name of the BN to be the name of the class instead of the name
        // of the file
        _bn_->setProperty("name", entityName);
        instanceName += ".";   // to be removed in  _getVariableName_
      } else {
        _errors_.addError("Neither system nor class '" + _entityName_
                              + "' and more than one class.",
                          _filename_,
                          0,
                          0);
      }
 
      // renaming variables in th BN
      gum::Set< std::string > names;
      for (auto node: _bn_->nodes()) {
        // keeping the complete name in description
        const std::string& nn = _bn_->variable(node).name();
        _bn_->variable(node).setDescription(nn);
 
        // trying to simplify the
        auto start = nn.find_first_of('(');
        auto end   = nn.find_first_of(')');
        if (0 < start && start < end && end < nn.size()) {
          auto path = nn.substr(0, start);
          auto type = nn.substr(start + 1, end - start - 1);
          auto name = nn.substr(end + 1, std::string::npos);
 
          std::string newNameRadical = _getVariableName_(path, type, name, instanceName);
 
          std::string newName = newNameRadical;
          // forcing newName to be unique
          int num = 0;
          while (names.contains(newName)) {
            newName = newNameRadical + std::to_string(++num);
          }
 
          names.insert(newName);
          _bn_->changeVariableName(node, newName);
        } else {
          _errors_.addError("Name " + nn + " cannot be simplified.", _filename_, 0, 0);
        }
      }
    }
 
    delete prm;
 
    return errors();
  }

References _bn_, _classpath_, _entityName_, _errors_, _filename_, _generateBN_(), _getInstanceName_(), _getVariableName_(), gum::prm::PRMSystem< GUM_SCALAR >::add(), gum::prm::o3prm::O3prmReader< GUM_SCALAR >::addClassPath(), gum::Set< Key >::contains(), errors(), gum::prm::o3prm::O3prmReader< GUM_SCALAR >::errorsContainer(), gum::Set< Key >::insert(), gum::prm::o3prm::O3prmReader< GUM_SCALAR >::prm(), and gum::prm::o3prm::O3prmReader< GUM_SCALAR >::readFile().

Here is the call graph for this function:

◆ showElegantErrors()

template<GUM_Numeric GUM_SCALAR>

void gum::O3prmBNReader< GUM_SCALAR >::showElegantErrors ( std::ostream & o = std::cerr )

send on std::cerr the list of errors

Definition at line 231 of file O3prmBNReader_tpl.h.

                                                                   {
    _errors_.elegantErrors(o);
  }

References _errors_.

◆ showElegantErrorsAndWarnings()

template<GUM_Numeric GUM_SCALAR>

void gum::O3prmBNReader< GUM_SCALAR >::showElegantErrorsAndWarnings ( std::ostream & o = std::cerr )

send on std::cerr the list of errors or warnings

Definition at line 236 of file O3prmBNReader_tpl.h.

                                                                              {
    _errors_.elegantErrorsAndWarnings(o);
  }

References _errors_.

◆ showErrorCounts()

template<GUM_Numeric GUM_SCALAR>

void gum::O3prmBNReader< GUM_SCALAR >::showErrorCounts ( std::ostream & o = std::cerr )

send on std::cerr the number of errors and the number of warnings

Definition at line 241 of file O3prmBNReader_tpl.h.

                                                                 {
    _errors_.syntheticResults(o);
  }

References _errors_.

◆ warnings()

template<GUM_Numeric GUM_SCALAR>

Size gum::O3prmBNReader< GUM_SCALAR >::warnings ( )

of errors

Definition at line 206 of file O3prmBNReader_tpl.h.

                                             {
    return _errors_.warning_count;
  }

References _errors_.

Member Data Documentation

◆ _bn_

template<GUM_Numeric GUM_SCALAR>

BayesNet< GUM_SCALAR >* gum::O3prmBNReader< GUM_SCALAR >::_bn_

private

Definition at line 126 of file O3prmBNReader.h.

Referenced by O3prmBNReader(), _generateBN_(), and proceed().

◆ _classpath_

template<GUM_Numeric GUM_SCALAR>

std::string gum::O3prmBNReader< GUM_SCALAR >::_classpath_

private

Definition at line 123 of file O3prmBNReader.h.

Referenced by O3prmBNReader(), and proceed().

◆ _entityName_

template<GUM_Numeric GUM_SCALAR>

std::string gum::O3prmBNReader< GUM_SCALAR >::_entityName_

private

Definition at line 124 of file O3prmBNReader.h.

Referenced by O3prmBNReader(), _generateBN_(), and proceed().

◆ _errors_

template<GUM_Numeric GUM_SCALAR>

ErrorsContainer gum::O3prmBNReader< GUM_SCALAR >::_errors_

private

Definition at line 127 of file O3prmBNReader.h.

Referenced by errCol(), errIsError(), errLine(), errMsg(), errors(), proceed(), showElegantErrors(), showElegantErrorsAndWarnings(), showErrorCounts(), and warnings().

◆ _filename_

template<GUM_Numeric GUM_SCALAR>

std::string gum::O3prmBNReader< GUM_SCALAR >::_filename_

private

Definition at line 121 of file O3prmBNReader.h.

Referenced by O3prmBNReader(), and proceed().

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

agrum/PRM/o3prm/O3prmBNReader.h
agrum/PRM/o3prm/O3prmBNReader_tpl.h

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ O3prmBNReader()

◆ ~O3prmBNReader()

Member Function Documentation

◆ _generateBN_()

◆ _getEntityName_()

◆ _getInstanceName_()

◆ _getVariableName_()

◆ errCol()

◆ errIsError()

◆ errLine()

of errors

◆ errMsg()

◆ errors()

of errors

◆ proceed()

◆ showElegantErrors()

◆ showElegantErrorsAndWarnings()

◆ showErrorCounts()

◆ warnings()

of errors

Member Data Documentation

◆ _bn_

◆ _classpath_

◆ _entityName_

◆ _errors_

◆ _filename_