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

Class representing edges of the Tangled Program Graphs. More...

#include <tpgEdge.h>

Inheritance diagram for TPG::TPGEdge:
TPG::TPGEdgeInstrumented

Public Member Functions

virtual ~TPGEdge ()=default
 Default virtual destructor (for polymorphism)
 
 TPGEdge (const TPGVertex *src, const TPGVertex *dest, const std::shared_ptr< Program::Program > prog)
 Main constructor of the TPGEdge class. More...
 
Program::ProgramgetProgram () const
 Get a const reference to the Program of the TPGEdge. More...
 
void setProgram (const std::shared_ptr< Program::Program > prog) const
 Set a new Program for the TPGEdge. More...
 
std::shared_ptr< Program::ProgramgetProgramSharedPointer ()
 Get the shared_pointer to the Program. More...
 
const TPGVertexgetSource () const
 Get the source TPGVertex of the TPGEdge. More...
 
void setSource (TPGVertex *newSource)
 Set a new source TPGVertex to the TPGEdge. More...
 
const TPGVertexgetDestination () const
 Get the destination TPGVertex of the TPGEdge. More...
 
void setDestination (TPGVertex *newDestination)
 Set a new destination TPGVertex to the TPGEdge. More...
 

Protected Member Functions

 TPGEdge ()=delete
 Delete the default constructor.
 

Protected Attributes

const TPGVertexsource
 Pointer to the source TPGVertex of this TPGEdge.
 
const TPGVertexdestination
 Pointer to the destination TPGVertex of this TPGEdge.
 
std::shared_ptr< Program::Programprogram
 

Detailed Description

Class representing edges of the Tangled Program Graphs.

Constructor & Destructor Documentation

◆ TPGEdge()

TPG::TPGEdge::TPGEdge ( const TPGVertex src,
const TPGVertex dest,
const std::shared_ptr< Program::Program prog 
)
inline

Main constructor of the TPGEdge class.

This constructor does not register the created TPGEdge in the list of incoming or outgoing edges of the given TPGVertex.

Parameters
[in]srcpointer to the source TPGVertex of the edge.
[in]destpointer to the destination TPGVertex of the edge.
[in]progthe shared pointer to the Program associated to the edge.

Member Function Documentation

◆ getDestination()

const TPG::TPGVertex * TPG::TPGEdge::getDestination ( ) const

Get the destination TPGVertex of the TPGEdge.

Returns
a const pointer to the destination TPGVertex.

◆ getProgram()

Program::Program & TPG::TPGEdge::getProgram ( ) const

Get a const reference to the Program of the TPGEdge.

Returns
a const reference to the Program of the TPGEdge.

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.

◆ getProgramSharedPointer()

std::shared_ptr< Program::Program > TPG::TPGEdge::getProgramSharedPointer ( )

Get the shared_pointer to the Program.

This method is voluntarily non-const to make sure that only the TPGGraph containing the edge can use it.

Returns
a copy of the program attribute.

◆ getSource()

const TPG::TPGVertex * TPG::TPGEdge::getSource ( ) const

Get the source TPGVertex of the TPGEdge.

Returns
a const pointer to the source TPGVertex.

◆ setDestination()

void TPG::TPGEdge::setDestination ( TPGVertex newDestination)

Set a new destination TPGVertex to the TPGEdge.

Parameters
[in]newDestinationthe new TPGVertex to register as the destination.

◆ setProgram()

void TPG::TPGEdge::setProgram ( const std::shared_ptr< Program::Program prog) const

Set a new Program for the TPGEdge.

This method is const to enable use outside of the TPGGraph which is the only class accessing the non-const TPGEdge. Since the program pointer attribute is mutable, this method can successfully be used to alter the program.

Parameters
[in]progthe new shared pointer to a Program.

◆ setSource()

void TPG::TPGEdge::setSource ( TPGVertex newSource)

Set a new source TPGVertex to the TPGEdge.

Parameters
[in]newSourcethe new TPGVertex to register as the source.

Member Data Documentation

◆ program

std::shared_ptr<Program::Program> TPG::TPGEdge::program
mutableprotected

Shared pointer to the Program to execute when evaluating the bid of this TPGEdge. This attribute is mutable to enable its modification during mutations.


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