GEGELATI
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TPG::TPGVertex Class Reference

Abstract class representing the vertices of a TPGGraph. More...

#include <tpgVertex.h>

Inheritance diagram for TPG::TPGVertex:
TPG::TPGAction TPG::TPGTeam TPG::TPGActionInstrumented TPG::TPGTeamInstrumented

Public Member Functions

virtual ~TPGVertex ()=default
 Default polymorphic destructor.
 
const std::list< TPGEdge * > & getIncomingEdges () const
 Get a const reference to incoming edges of this TPGVertex. More...
 
const std::list< TPGEdge * > & getOutgoingEdges () const
 Get a const reference to incoming edges of this TPGVertex.
 
virtual void addIncomingEdge (TPG::TPGEdge *edge)
 Method to add an incoming TPGEdge to the TPGVertex. More...
 
virtual void removeIncomingEdge (TPG::TPGEdge *edge)
 Removes the given incoming edge from the TPGVertex. More...
 
virtual void addOutgoingEdge (TPG::TPGEdge *edge)
 Method to add an outgoing TPGEdge to the TPGVertex. More...
 
virtual void removeOutgoingEdge (TPG::TPGEdge *edge)
 Removes the given outgoing edge from the TPGVertex. More...
 

Protected Member Functions

 TPGVertex ()
 Protected default constructor to forbid the instanciation of object of this abstract class.
 

Protected Attributes

std::list< TPG::TPGEdge * > incomingEdges
 Set of incoming TPGEdge of the TPGVertex.
 
std::list< TPG::TPGEdge * > outgoingEdges
 Set of outgoing TPGEdge of the TPGVertex.
 

Detailed Description

Abstract class representing the vertices of a TPGGraph.

Member Function Documentation

◆ addIncomingEdge()

void TPG::TPGVertex::addIncomingEdge ( TPG::TPGEdge edge)
virtual

Method to add an incoming TPGEdge to the TPGVertex.

Since the incomingEdges set is a std::set, the same TPGEdge pointer can not be added twice to the set. This method does not register the TPGVertex as the destination of the TPGEdge.

Parameters
[in]edgethe TPGEdge pointer to be added to the incomingEdges Set.

◆ addOutgoingEdge()

void TPG::TPGVertex::addOutgoingEdge ( TPG::TPGEdge edge)
virtual

Method to add an outgoing TPGEdge to the TPGVertex.

Since the outgoingEdges set is a std::set, the same TPGEdge pointer can not be added twice to the set. This method does not register the TPGVertex as the spource of the TPGEdge.

Parameters
[in]edgethe TPGEdge pointer to be added to the outgoingEdges Set.

Reimplemented in TPG::TPGAction.

◆ getIncomingEdges()

const std::list< TPG::TPGEdge * > & TPG::TPGVertex::getIncomingEdges ( ) const

Get a const reference to incoming edges of this TPGVertex.

Copyright or © or Copr. IETR/INSA - Rennes (2019) :

Karol Desnos kdesn.nosp@m.os@i.nosp@m.nsa-r.nosp@m.enne.nosp@m.s.fr (2019)

GEGELATI is an open-source reinforcement learning framework for training artificial intelligence based on Tangled Program Graphs (TPGs).

This software is governed by the CeCILL-C license under French law and abiding by the rules of distribution of free software. You can use, modify and/ or redistribute the software under the terms of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".

As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the successive licensors have only limited liability.

In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or developing or reproducing the software by the user in light of its specific status of free software, that may mean that it is complicated to manipulate, and that also therefore means that it is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the software's suitability as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions as regards security.

The fact that you are presently reading this means that you have had knowledge of the CeCILL-C license and that you accept its terms.

◆ removeIncomingEdge()

void TPG::TPGVertex::removeIncomingEdge ( TPG::TPGEdge edge)
virtual

Removes the given incoming edge from the TPGVertex.

If the given pointer is NULL or if the given edge is not in the set of the TPGVertex, nothing happens. Otherwise, the edge is removed.

Parameters
[in]edgethe TPGEdge to remove.

◆ removeOutgoingEdge()

void TPG::TPGVertex::removeOutgoingEdge ( TPG::TPGEdge edge)
virtual

Removes the given outgoing edge from the TPGVertex.

If the given pointer is NULL or if the given edge is not in the set of the TPGVertex, nothing happens. Otherwise, the edge is removed.

Parameters
[in]edgethe TPGEdge to remove.

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