gum::prm::gspan::DFSCode Class Reference

Reprensent a Depth First Search coding of a graph. More...

#include <agrum/PRM/gspan/DFSCode.h>

Public Attributes
std::vector< EdgeCode *>	codes
	The vector containing the EdgeCode composing this DFSCode. More...

Public Member Functions
	DFSCode ()
	Default constructor. More...
	DFSCode (const DFSCode &source)
	Copy constructor. More...
	~DFSCode ()
	Destructor. More...
DFSCode &	operator= (const DFSCode &source)
	Copy operator. More...
bool	operator== (const DFSCode &code) const
	Equality operator. More...
bool	operator!= (const DFSCode &code) const
	Difference operator. More...
bool	operator< (const DFSCode &code) const
	Lesser than operator. More...
bool	operator<= (const DFSCode &code) const
	Lesser or equal than operator. More...

Static Public Member Functions
static bool	validNeighbors (EdgeCode *e1, EdgeCode *e2)
	Returns true of e2 is a valid neighbor for e1 (i.e. More...

Public Types
typedef std::vector< EdgeCode *>::iterator	iterator
	Code alias. More...
typedef std::vector< EdgeCode *>::const_iterator	const_iterator
	Code alias. More...

Detailed Description

Reprensent a Depth First Search coding of a graph.

A DFSCode is composed of EdgeCode. Each EdgeCode is either a forward edge or a backward edge.

Regarding memory allocation EdgeCode are shared between related DFSCode, so delete DFSCode in a bottom up fashion.

Definition at line 52 of file DFSCode.h.

Member Typedef Documentation

const_iterator

typedef std::vector< EdgeCode* >::const_iterator gum::prm::gspan::DFSCode::const_iterator

Code alias.

Definition at line 130 of file DFSCode.h.

iterator

typedef std::vector< EdgeCode* >::iterator gum::prm::gspan::DFSCode::iterator

Code alias.

Definition at line 127 of file DFSCode.h.

Constructor & Destructor Documentation

DFSCode() [1/2]

INLINE gum::prm::gspan::DFSCode::DFSCode

(

)

Default constructor.

Create an empty DFSCode.

Definition at line 34 of file DFSCode_inl.h.

References gum::prm::gspan::operator<<().

                       {
        GUM_CONSTRUCTOR(DFSCode);
        ;
      }

Here is the call graph for this function:

DFSCode() [2/2]

INLINE gum::prm::gspan::DFSCode::DFSCode

(

const DFSCode &

source

)

Copy constructor.

Proceeds with a deep copy.

Definition at line 40 of file DFSCode_inl.h.

References gum::prm::gspan::operator<<().

                                            {
        GUM_CONS_CPY(DFSCode);

        for (const auto code: source.codes)
          codes.push_back(new EdgeCode(*code));
      }

Here is the call graph for this function:

~DFSCode()

INLINE gum::prm::gspan::DFSCode::~DFSCode

(

)

Destructor.

This will delete all children of this DFSCode, with their respective EdgeCode.

Definition at line 48 of file DFSCode_inl.h.

References gum::prm::gspan::operator<<().

                        {
        GUM_DESTRUCTOR(DFSCode);

        for (const auto item: codes)
          delete item;
      }

Here is the call graph for this function:

Member Function Documentation

operator!=()

INLINE bool gum::prm::gspan::DFSCode::operator!=

(

const DFSCode &

code

)

const

Difference operator.

Parameters

code	The code tested for difference with this.

Returns

Returns true if this and code are different.

Definition at line 80 of file DFSCode_inl.h.

References gum::prm::gspan::operator<<().

                                                        {
        if (codes.size() == from.codes.size()) {
          for (size_t idx = 0; idx < codes.size(); ++idx) {
            if ((*codes[idx]) != (*codes[idx])) { return true; }
          }

          return false;
        } else {
          return true;
        }
      }

Here is the call graph for this function:

operator<()

INLINE bool gum::prm::gspan::DFSCode::operator<

(

const DFSCode &

code

)

const

Lesser than operator.

Parameters

code	The code on which the test is made.

Returns

Returns true if this is lesser than code.

Definition at line 93 of file DFSCode_inl.h.

References gum::prm::gspan::operator<<().

                                                       {
        DFSCode::const_iterator iter = codes.begin();
        DFSCode::const_iterator jter = from.codes.begin();

        for (; (iter != codes.end()) && (jter != from.codes.end()); ++iter, ++jter) {
          if ((**iter) != (**jter)) {
            EdgeCode& alpha = **iter;
            EdgeCode& beta  = **jter;

            if (alpha.isBackward()) {
              if (beta.isForward()) {
                return true;
              } else if (alpha.j < beta.j) {
                // beta is a backward edge
                return true;
              } else if ((alpha.j == beta.j) && (alpha.l_ij < beta.l_ij)) {
                return true;
              }

              return false;
            } else {
              // alpha is a forward edge
              if (beta.isBackward()) {
                return false;
              } else if (beta.i < alpha.i) {
                // Beta is a forward edge
                return true;
              } else if (beta.i == alpha.i) {
                if (alpha.l_i < beta.l_i) {
                  return true;
                } else if (alpha.l_i == beta.l_i) {
                  if (alpha.l_ij < beta.l_ij) {
                    return true;
                  } else if (alpha.l_ij == beta.l_ij) {
                    return alpha.l_j < beta.l_j;
                  }
                }
              }

              return false;
            }

            return (**iter) < (**jter);
          }
        }

        return false;
      }

Here is the call graph for this function:

operator<=()

INLINE bool gum::prm::gspan::DFSCode::operator<=

(

const DFSCode &

code

)

const

Lesser or equal than operator.

Parameters

code	The code on which the test is made.

Returns

Returns true if this is lesser than code.

Definition at line 143 of file DFSCode_inl.h.

References gum::prm::gspan::operator<<().

                                                        {
        DFSCode::const_iterator iter = codes.begin();
        DFSCode::const_iterator jter = from.codes.begin();

        for (; (iter != codes.end()) && (jter != from.codes.end()); ++iter, ++jter) {
          if ((**iter) != (**jter)) { return (**iter) < (**jter); }
        }

        return codes.size() <= from.codes.size();
      }

Here is the call graph for this function:

operator=()

INLINE DFSCode & gum::prm::gspan::DFSCode::operator=

(

const DFSCode &

source

)

Copy operator.

Proceeds with a deep copy.

Definition at line 56 of file DFSCode_inl.h.

References gum::prm::gspan::operator<<().

                                                       {
        for (const auto item: codes)
          delete item;

        for (const auto srcitem: source.codes)
          codes.push_back(new EdgeCode(*srcitem));

        return *this;
      }

Here is the call graph for this function:

operator==()

INLINE bool gum::prm::gspan::DFSCode::operator==

(

const DFSCode &

code

)

const

Equality operator.

Parameters

code	The code tested for equality with this.

Returns

Returns true if this and code are equal.

Definition at line 67 of file DFSCode_inl.h.

References gum::prm::gspan::operator<<().

                                                        {
        if (codes.size() == from.codes.size()) {
          for (size_t idx = 0; idx < codes.size(); ++idx) {
            if ((*codes[idx]) != (*codes[idx])) { return false; }
          }

          return true;
        } else {
          return false;
        }
      }

Here is the call graph for this function:

validNeighbors()

bool gum::prm::gspan::DFSCode::validNeighbors ( EdgeCode *  e1, EdgeCode *  e2  )

inlinestatic

Returns true of e2 is a valid neighbor for e1 (i.e.

it respect the neighborhood restriction) if e1 precedes e2 in a DFSCode.

Parameters

e1	An EdgeCode.
e2	Another EdgeCode.

Returns

Returns true of e2 is a valid neighbor for e1 (i.e. it respect the neighborhood restriction) if e1 precedes e2 in a DFSCode.

Definition at line 141 of file DFSCode.h.

                                                                    {
        if (e1->isBackward()) {
          if (e2->isForward()) {
            return (e2->i <= e1->i) && (e2->j = (e1->i + 1));
          } else {
            return (e2->i == e1->i) && (e1->j < e2->j);
          }
        } else {
          // e1 is a forward edge
          if (e2->isForward()) {
            return (e2->i <= e1->j) && (e2->j == (e1->j + 1));
          } else {
            return (e2->i == e1->j) && (e2->j < e1->i);
          }
        }
      }

Member Data Documentation

codes

std::vector< EdgeCode* > gum::prm::gspan::DFSCode::codes

The vector containing the EdgeCode composing this DFSCode.

Definition at line 89 of file DFSCode.h.

---

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

• agrum/PRM/gspan/DFSCode.h
• agrum/PRM/gspan/DFSCode_inl.h