gum::O3prmBNReader< GUM_SCALAR > Class Template Reference

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 ()
Size	proceed ()
	parse the file More...
Size	errors ()
	publishing Errors API More...
Size	warnings ()
	of errors More...
Idx	errLine (Idx i)
	publishing Errors API More...
Idx	errCol (Idx i)
	col of ith error or warning More...
bool	errIsError (Idx i)
	type of ith error or warning More...
std::string	errMsg (Idx i)
	message of ith error or warning More...
void	showElegantErrors (std::ostream &o=std::cerr)
	send on std::cerr the list of errors More...
void	showElegantErrorsAndWarnings (std::ostream &o=std::cerr)
	send on std::cerr the list of errors or warnings More...
void	showErrorCounts (std::ostream &o=std::cerr)
	send on std::cerr the number of errors and the number of warnings More...

Detailed Description

template<typename 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 57 of file O3prmBNReader.h.

Constructor & Destructor Documentation

O3prmBNReader()

template<typename 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 67 of file O3prmBNReader_tpl.h.

References gum::O3prmBNReader< GUM_SCALAR >::__bn, gum::O3prmBNReader< GUM_SCALAR >::__classpath, gum::O3prmBNReader< GUM_SCALAR >::__entityName, gum::O3prmBNReader< GUM_SCALAR >::__filename, and gum::O3prmBNReader< GUM_SCALAR >::__getEntityName().

                                                                              :
      BNReader< GUM_SCALAR >(bn, filename) {
    GUM_CONSTRUCTOR(O3prmBNReader);
    __bn = bn;
    __filename = filename;
    __entityName = entityName == "" ? __getEntityName(filename) : entityName;
    __classpath = classpath;
  }

Here is the call graph for this function:

~O3prmBNReader()

template<typename GUM_SCALAR >

gum::O3prmBNReader< GUM_SCALAR >::~O3prmBNReader

(

)

Definition at line 80 of file O3prmBNReader_tpl.h.

                                              {
    GUM_DESTRUCTOR(O3prmBNReader);
  }

Member Function Documentation

__generateBN()

template<typename GUM_SCALAR >

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

private

Definition at line 186 of file O3prmBNReader_tpl.h.

References gum::O3prmBNReader< GUM_SCALAR >::__bn, gum::O3prmBNReader< GUM_SCALAR >::__entityName, gum::prm::PRMSystem< GUM_SCALAR >::groundedBN(), and gum::prm::PRMSystem< GUM_SCALAR >::instantiate().

Referenced by gum::O3prmBNReader< GUM_SCALAR >::proceed().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__getEntityName()

template<typename GUM_SCALAR >

std::string gum::O3prmBNReader< GUM_SCALAR >::__getEntityName ( const std::string &  filename )

staticprivate

Definition at line 59 of file O3prmBNReader_tpl.h.

Referenced by gum::O3prmBNReader< GUM_SCALAR >::O3prmBNReader().

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

Here is the caller graph for this function:

__getInstanceName()

template<typename GUM_SCALAR >

std::string gum::O3prmBNReader< GUM_SCALAR >::__getInstanceName ( const std::string &  classname )

staticprivate

Definition at line 51 of file O3prmBNReader_tpl.h.

Referenced by gum::O3prmBNReader< GUM_SCALAR >::proceed().

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

Here is the caller graph for this function:

__getVariableName()

template<typename GUM_SCALAR >

INLINE std::string gum::O3prmBNReader< GUM_SCALAR >::__getVariableName ( const std::string &  path, const std::string &  type, const std::string &  name, const std::string &  toRemove = ""  )

staticprivate

Definition at line 36 of file O3prmBNReader_tpl.h.

Referenced by gum::O3prmBNReader< GUM_SCALAR >::proceed().

                                                                               {
    auto res = path + name;   // path ends up with a "."
    if (toRemove != "") {
      if (res.substr(0, toRemove.size()) == toRemove) {
        res = res.substr(toRemove.size());
      }
    }
    return res;
  }

Here is the caller graph for this function:

errCol()

template<typename GUM_SCALAR >

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

inline

col of ith error or warning

Definition at line 81 of file O3prmBNReader.h.

References gum::O3prmBNReader< GUM_SCALAR >::__errors, gum::ParseError::column, and gum::ErrorsContainer::error().

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

Here is the call graph for this function:

errIsError()

template<typename GUM_SCALAR >

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

inline

type of ith error or warning

Definition at line 83 of file O3prmBNReader.h.

References gum::O3prmBNReader< GUM_SCALAR >::__errors, gum::ErrorsContainer::error(), and gum::ParseError::is_error.

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

Here is the call graph for this function:

errLine()

template<typename GUM_SCALAR >

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

inline

publishing Errors API

of errors

Definition at line 79 of file O3prmBNReader.h.

References gum::O3prmBNReader< GUM_SCALAR >::__errors, gum::ErrorsContainer::error(), and gum::ParseError::line.

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

Here is the call graph for this function:

errMsg()

template<typename GUM_SCALAR >

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

inline

message of ith error or warning

Definition at line 85 of file O3prmBNReader.h.

References gum::O3prmBNReader< GUM_SCALAR >::__errors, gum::ErrorsContainer::error(), and gum::ParseError::msg.

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

Here is the call graph for this function:

errors()

template<typename GUM_SCALAR >

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

inline

publishing Errors API

of errors

Definition at line 75 of file O3prmBNReader.h.

References gum::O3prmBNReader< GUM_SCALAR >::__errors, and gum::ErrorsContainer::error_count.

Referenced by gum::O3prmBNReader< GUM_SCALAR >::proceed().

{ return __errors.error_count; }

Here is the caller graph for this function:

proceed()

template<typename GUM_SCALAR >

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

virtual

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

Implements gum::BNReader< GUM_SCALAR >.

Definition at line 88 of file O3prmBNReader_tpl.h.

References gum::O3prmBNReader< GUM_SCALAR >::__bn, gum::O3prmBNReader< GUM_SCALAR >::__classpath, gum::O3prmBNReader< GUM_SCALAR >::__entityName, gum::O3prmBNReader< GUM_SCALAR >::__errors, gum::O3prmBNReader< GUM_SCALAR >::__filename, gum::O3prmBNReader< GUM_SCALAR >::__generateBN(), gum::O3prmBNReader< GUM_SCALAR >::__getInstanceName(), gum::O3prmBNReader< GUM_SCALAR >::__getVariableName(), gum::prm::PRMSystem< GUM_SCALAR >::add(), gum::ErrorsContainer::add(), gum::prm::o3prm::O3prmReader< GUM_SCALAR >::addClassPath(), gum::prm::PRM< GUM_SCALAR >::classes(), gum::Set< Key, Alloc >::contains(), gum::O3prmBNReader< GUM_SCALAR >::errors(), gum::prm::o3prm::O3prmReader< GUM_SCALAR >::errorsContainer(), gum::prm::PRM< GUM_SCALAR >::getClass(), gum::prm::PRM< GUM_SCALAR >::getSystem(), gum::Set< Key, Alloc >::insert(), gum::prm::PRM< GUM_SCALAR >::isClass(), gum::prm::PRM< GUM_SCALAR >::isSystem(), gum::prm::o3prm::O3prmReader< GUM_SCALAR >::prm(), gum::prm::o3prm::O3prmReader< GUM_SCALAR >::readFile(), and gum::to_string().

                                            {
    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)) {
        ParseError warn(
           false,
           "No system '" + __entityName
              + "' found but class 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);
        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 {
        ParseError err(true,
                       "Neither system nor class '" + __entityName
                          + "' and more than one class.",
                       __filename,
                       0);
        __errors.add(err);
      }

      // 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 {
          ParseError warn(
             false, "Name " + nn + " cannot be simplified.", __filename, 0);
          __errors.add(warn);
        }
      }
    }

    delete prm;

    return errors();
  }

Here is the call graph for this function:

showElegantErrors()

template<typename GUM_SCALAR >

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

inline

send on std::cerr the list of errors

Definition at line 88 of file O3prmBNReader.h.

References gum::O3prmBNReader< GUM_SCALAR >::__errors, and gum::ErrorsContainer::elegantErrors().

                                                    {
      __errors.elegantErrors(o);
    }

Here is the call graph for this function:

showElegantErrorsAndWarnings()

template<typename GUM_SCALAR >

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

inline

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

Definition at line 93 of file O3prmBNReader.h.

References gum::O3prmBNReader< GUM_SCALAR >::__errors, and gum::ErrorsContainer::elegantErrorsAndWarnings().

                                                               {
      __errors.elegantErrorsAndWarnings(o);
    }

Here is the call graph for this function:

showErrorCounts()

template<typename GUM_SCALAR >

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

inline

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

Definition at line 98 of file O3prmBNReader.h.

References gum::O3prmBNReader< GUM_SCALAR >::__errors, and gum::ErrorsContainer::syntheticResults().

                                                  {
      __errors.syntheticResults(o);
    }

Here is the call graph for this function:

warnings()

template<typename GUM_SCALAR >

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

inline

of errors

Definition at line 77 of file O3prmBNReader.h.

References gum::O3prmBNReader< GUM_SCALAR >::__errors, and gum::ErrorsContainer::warning_count.

{ return __errors.warning_count; }

Member Data Documentation

__bn

template<typename GUM_SCALAR >

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

private

Definition at line 109 of file O3prmBNReader.h.

Referenced by gum::O3prmBNReader< GUM_SCALAR >::__generateBN(), gum::O3prmBNReader< GUM_SCALAR >::O3prmBNReader(), and gum::O3prmBNReader< GUM_SCALAR >::proceed().

__classpath

template<typename GUM_SCALAR >

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

private

Definition at line 106 of file O3prmBNReader.h.

Referenced by gum::O3prmBNReader< GUM_SCALAR >::O3prmBNReader(), and gum::O3prmBNReader< GUM_SCALAR >::proceed().

__entityName

template<typename GUM_SCALAR >

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

private

Definition at line 107 of file O3prmBNReader.h.

Referenced by gum::O3prmBNReader< GUM_SCALAR >::__generateBN(), gum::O3prmBNReader< GUM_SCALAR >::O3prmBNReader(), and gum::O3prmBNReader< GUM_SCALAR >::proceed().

__errors

template<typename GUM_SCALAR >

ErrorsContainer gum::O3prmBNReader< GUM_SCALAR >::__errors

private

Definition at line 110 of file O3prmBNReader.h.

Referenced by gum::O3prmBNReader< GUM_SCALAR >::errCol(), gum::O3prmBNReader< GUM_SCALAR >::errIsError(), gum::O3prmBNReader< GUM_SCALAR >::errLine(), gum::O3prmBNReader< GUM_SCALAR >::errMsg(), gum::O3prmBNReader< GUM_SCALAR >::errors(), gum::O3prmBNReader< GUM_SCALAR >::proceed(), gum::O3prmBNReader< GUM_SCALAR >::showElegantErrors(), gum::O3prmBNReader< GUM_SCALAR >::showElegantErrorsAndWarnings(), gum::O3prmBNReader< GUM_SCALAR >::showErrorCounts(), and gum::O3prmBNReader< GUM_SCALAR >::warnings().

__filename

template<typename GUM_SCALAR >

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

private

Definition at line 104 of file O3prmBNReader.h.

Referenced by gum::O3prmBNReader< GUM_SCALAR >::O3prmBNReader(), and gum::O3prmBNReader< GUM_SCALAR >::proceed().

---

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

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