gum::learning::GraphChange Class Reference

#include <graphChange.h>

Inheritance diagram for gum::learning::GraphChange:

Public Member Functions
Constructors / Destructors
	GraphChange (GraphChangeType type, NodeId node1, NodeId node2) noexcept
	default constructor More...
	GraphChange (const GraphChange &from) noexcept
	copy constructor More...
	GraphChange (GraphChange &&from) noexcept
	move constructor More...
	~GraphChange () noexcept
	destructor More...
Operators
GraphChange &	operator= (const GraphChange &from) noexcept
	copy constructor More...
GraphChange &	operator= (GraphChange &&from) noexcept
	move operator More...
bool	operator== (const GraphChange &from) const noexcept
	returns whether two graph changes are identical or not More...
bool	operator!= (const GraphChange &from) const noexcept
	returns whether two graph changes are different or not More...
Accessors/Modifiers
GraphChangeType	type () const noexcept
	returns the type of the operation More...
NodeId	node1 () const noexcept
	returns the first node involved in the modification More...
NodeId	node2 () const noexcept
	returns the second node involved in the modification More...
virtual std::string	toString () const
	put the content of the graph change into a string More...

Detailed Description

Definition at line 65 of file graphChange.h.

Constructor & Destructor Documentation

GraphChange() [1/3]

gum::learning::GraphChange::GraphChange ( GraphChangeType  type, NodeId  node1, NodeId  node2  )

noexcept

default constructor

GraphChange() [2/3]

gum::learning::GraphChange::GraphChange ( const GraphChange &  from )

noexcept

copy constructor

GraphChange() [3/3]

gum::learning::GraphChange::GraphChange ( GraphChange &&  from )

noexcept

move constructor

~GraphChange()

gum::learning::GraphChange::~GraphChange ( )

noexcept

destructor

Member Function Documentation

node1()

NodeId gum::learning::GraphChange::node1 ( ) const

noexcept

returns the first node involved in the modification

Referenced by gum::learning::GreedyHillClimbing::learnStructure(), gum::learning::LocalSearchWithTabuList::learnStructure(), toString(), gum::learning::ArcAddition::toString(), gum::learning::ArcDeletion::toString(), gum::learning::ArcReversal::toString(), gum::learning::EdgeAddition::toString(), and gum::learning::EdgeDeletion::toString().

Here is the caller graph for this function:

node2()

NodeId gum::learning::GraphChange::node2 ( ) const

noexcept

returns the second node involved in the modification

Referenced by gum::learning::GreedyHillClimbing::learnStructure(), gum::learning::LocalSearchWithTabuList::learnStructure(), toString(), gum::learning::ArcAddition::toString(), gum::learning::ArcDeletion::toString(), gum::learning::ArcReversal::toString(), gum::learning::EdgeAddition::toString(), and gum::learning::EdgeDeletion::toString().

Here is the caller graph for this function:

operator!=()

bool gum::learning::GraphChange::operator!= ( const GraphChange &  from ) const

noexcept

returns whether two graph changes are different or not

operator=() [1/2]

GraphChange& gum::learning::GraphChange::operator= ( const GraphChange &  from )

noexcept

copy constructor

operator=() [2/2]

GraphChange& gum::learning::GraphChange::operator= ( GraphChange &&  from )

noexcept

move operator

operator==()

bool gum::learning::GraphChange::operator== ( const GraphChange &  from ) const

noexcept

returns whether two graph changes are identical or not

toString()

std::string gum::learning::GraphChange::toString ( ) const

virtual

put the content of the graph change into a string

put the content of the GraphChange into a string

Reimplemented in gum::learning::EdgeDeletion, gum::learning::EdgeAddition, gum::learning::ArcReversal, gum::learning::ArcDeletion, and gum::learning::ArcAddition.

Definition at line 43 of file graphChange.cpp.

References gum::learning::ARC_ADDITION, gum::learning::ARC_DELETION, gum::learning::ARC_REVERSAL, gum::learning::EDGE_ADDITION, gum::learning::EDGE_DELETION, GUM_ERROR, node1(), node2(), and type().

Referenced by gum::learning::operator<<().

                                          {
      std::stringstream stream;
      switch (type()) {
        case GraphChangeType::ARC_ADDITION:
          stream << "ArcAddition ( " << node1() << " , " << node2() << " )";
          return stream.str();

        case GraphChangeType::ARC_DELETION:
          stream << "ArcDeletion ( " << node1() << " , " << node2() << " )";
          return stream.str();

        case GraphChangeType::ARC_REVERSAL:
          stream << "ArcReversal ( " << node1() << " , " << node2() << " )";
          return stream.str();

        case GraphChangeType::EDGE_ADDITION:
          stream << "EdgeAddition ( " << node1() << " , " << node2() << " )";
          return stream.str();

        case GraphChangeType::EDGE_DELETION:
          stream << "EdgeDeletion ( " << node1() << " , " << node2() << " )";
          return stream.str();

        default:
          GUM_ERROR(OperationNotAllowed,
                    "this graph modification is not supported yet");
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

type()

GraphChangeType gum::learning::GraphChange::type ( ) const

noexcept

returns the type of the operation

Referenced by gum::learning::GreedyHillClimbing::learnStructure(), gum::learning::LocalSearchWithTabuList::learnStructure(), and toString().

Here is the caller graph for this function:

Member Data Documentation

__node1

NodeId gum::learning::GraphChange::__node1

private

the first node in the edge or arc to be modified

Definition at line 129 of file graphChange.h.

__node2

NodeId gum::learning::GraphChange::__node2

private

the second node in the edge or arc to be modified

Definition at line 132 of file graphChange.h.

__type

GraphChangeType gum::learning::GraphChange::__type

private

the type of modification

Definition at line 126 of file graphChange.h.

---

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

• agrum/learning/structureUtils/graphChange.h
• agrum/learning/structureUtils/graphChange.cpp