SkelGIS  3.0
skelgis::DPMap_Nodes< nodes, edges, T, 1 > Struct Template Reference

first specialization of DPMap_Nodes More...

#include <dpmap_nodes.hpp>

List of all members.

Public Member Functions

 DPMap_Nodes (DDAG< nodes, edges > &dag, const char *file)
 constructor of DPMap_Nodes
 DPMap_Nodes (DDAG< nodes, edges > &dag, T val)
 constructor of DPMap_Nodes
 ~DPMap_Nodes ()
 destructor of DPMap_Nodes
iterator_dag begin_roots ()
 to get the begin iterator on roots nodes
iterator_dag end_roots ()
 to get the end iterator on roots nodes
iterator_dag begin_leafs ()
 to get the begin iterator on leafs nodes
iterator_dag end_leafs ()
 to get the end iterator on leafs nodes
iterator_dag begin_comm ()
 to get the begin iterator on nodes with communication with other processors
iterator_dag end_comm ()
 to get the end iterator on nodes with communication with other processors
iterator_dag begin_loc ()
 to get the begin iterator on nodes without communication with other processors
iterator_dag end_loc ()
 to get the end iterator on nodes without communication with other processors
iterator_dag begin_in ()
 to get the begin iterator on inside nodes (i.e. nodes that are not roots or leafs = loc and comm nodes)
iterator_dag end_in ()
 to get the end iterator on inside nodes (i.e. nodes that are not roots or leafs = loc and comm nodes)
iterator_dag begin_all ()
 to get the begin iterator on all nodes (roots, leafs, comm and loc)
iterator_dag end_all ()
 to get the end iterator on all nodes (roots, leafs, comm and loc)
T & operator[] (iterator_dag it)
 to get the value of the property map at the iterator position
std::vector< iterator_daggetInEdges (iterator_dag it)
 to get a vector of iterator on input edges for the node it
std::vector< iterator_daggetOutEdges (iterator_dag it)
 to get a vector of iterator on output edges for the node it
std::vector< iterator_daggetInNodes (iterator_dag it)
 to get a vector of iterator on input nodes for the node it
std::vector< iterator_daggetOutNodes (iterator_dag it)
 to get a vector of iterator on output nodes for the node it

Protected Attributes

DPMap_Nodes_impl< nodes, edges,
T, 1 > * 
dpmap

Detailed Description

template<bool nodes, bool edges, class T>
struct skelgis::DPMap_Nodes< nodes, edges, T, 1 >

first specialization of DPMap_Nodes

Template Parameters:
nodesis inheritate from DDAG and needed as a DDAG is gonna be referenced
edgesis inheritate from DDAG and needed as a DDAG is gonna be referenced
Tis the type of data in the property map

The type T is a simple type in this case as float, double, int etc. The overlap is specialized to the value 1 The size is used with its default value 1

Definition at line 38 of file dpmap_nodes.hpp.


Constructor & Destructor Documentation

template<bool nodes, bool edges, class T >
skelgis::DPMap_Nodes< nodes, edges, T, 1 >::DPMap_Nodes ( DDAG< nodes, edges > &  dag,
const char *  file 
) [inline]

constructor of DPMap_Nodes

Parameters:
dagis the DDAG object associated to this map
fileis the file with initial values of nodes wanted (each line is the value of the node "number of this line" associated in the .dot file)

Definition at line 52 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
skelgis::DPMap_Nodes< nodes, edges, T, 1 >::DPMap_Nodes ( DDAG< nodes, edges > &  dag,
val 
) [inline]

constructor of DPMap_Nodes

Parameters:
dagis the DDAG object associated to this map
valis the default value of nodes for the map

Definition at line 63 of file dpmap_nodes.hpp.


Member Function Documentation

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::begin_all ( ) [inline]

to get the begin iterator on all nodes (roots, leafs, comm and loc)

Returns:
the begin iterator on all nodes

Definition at line 150 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::begin_comm ( ) [inline]

to get the begin iterator on nodes with communication with other processors

Returns:
the begin iterator on communication nodes

Definition at line 108 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::begin_in ( ) [inline]

to get the begin iterator on inside nodes (i.e. nodes that are not roots or leafs = loc and comm nodes)

Returns:
the begin iterator on inside nodes

Definition at line 136 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::begin_leafs ( ) [inline]

to get the begin iterator on leafs nodes

Returns:
the begin iterator on leafs nodes

Definition at line 94 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::begin_loc ( ) [inline]

to get the begin iterator on nodes without communication with other processors

Returns:
the begin iterator on local nodes

Definition at line 122 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::begin_roots ( ) [inline]

to get the begin iterator on roots nodes

Returns:
the begin iterator on roots nodes

Definition at line 80 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::end_all ( ) [inline]

to get the end iterator on all nodes (roots, leafs, comm and loc)

Returns:
the end iterator on all nodes

Definition at line 157 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::end_comm ( ) [inline]

to get the end iterator on nodes with communication with other processors

Returns:
the end iterator on communication nodes

Definition at line 115 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::end_in ( ) [inline]

to get the end iterator on inside nodes (i.e. nodes that are not roots or leafs = loc and comm nodes)

Returns:
the end iterator on inside nodes

Definition at line 143 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::end_leafs ( ) [inline]

to get the end iterator on leafs nodes

Returns:
the end iterator on leafs nodes

Definition at line 101 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::end_loc ( ) [inline]

to get the end iterator on nodes without communication with other processors

Returns:
the end iterator on local nodes

Definition at line 129 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
iterator_dag skelgis::DPMap_Nodes< nodes, edges, T, 1 >::end_roots ( ) [inline]

to get the end iterator on roots nodes

Returns:
the end iterator on roots nodes

Definition at line 87 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
std::vector<iterator_dag> skelgis::DPMap_Nodes< nodes, edges, T, 1 >::getInEdges ( iterator_dag  it) [inline]

to get a vector of iterator on input edges for the node it

Parameters:
itis the iterator on the node to get input edges
Returns:
a vector of iterator

Definition at line 172 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
std::vector<iterator_dag> skelgis::DPMap_Nodes< nodes, edges, T, 1 >::getInNodes ( iterator_dag  it) [inline]

to get a vector of iterator on input nodes for the node it

Parameters:
itis the iterator on the node to get input nodes
Returns:
a vector of iterator

Definition at line 188 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
std::vector<iterator_dag> skelgis::DPMap_Nodes< nodes, edges, T, 1 >::getOutEdges ( iterator_dag  it) [inline]

to get a vector of iterator on output edges for the node it

Parameters:
itis the iterator on the node to get output edges
Returns:
a vector of iterator

Definition at line 180 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
std::vector<iterator_dag> skelgis::DPMap_Nodes< nodes, edges, T, 1 >::getOutNodes ( iterator_dag  it) [inline]

to get a vector of iterator on output nodes for the node it

Parameters:
itis the iterator on the node to get output nodes
Returns:
a vector of iterator

Definition at line 196 of file dpmap_nodes.hpp.

template<bool nodes, bool edges, class T >
T& skelgis::DPMap_Nodes< nodes, edges, T, 1 >::operator[] ( iterator_dag  it) [inline]

to get the value of the property map at the iterator position

Returns:
a reference on the value (to be modified)

Definition at line 164 of file dpmap_nodes.hpp.


The documentation for this struct was generated from the following file:
 All Classes Files Functions Variables Defines