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

first specialization of DPMap_Nodes More...

#include <dpmap_nodes.hpp>

List of all members.

Public Types

typedef DPMap_Nodes_impl< DD,
T, 1 > 
impl_type

Public Member Functions

 DPMap_Nodes (DD &dag, const char *file)
 constructor of DPMap_Nodes
 DPMap_Nodes (DD &dag, T val)
 constructor of DPMap_Nodes
 DPMap_Nodes (DPMap_Nodes_impl< DD, T, 1 > *p)
 constructor from a DPMap_Nodes_impl pointer
 ~DPMap_Nodes ()
 destructor of DPMap_Nodes
DPMap_Nodes_impl< DD, T, 1 > * getDPMap ()
 to get the pointer on dpmap_impl
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 ()
 to get the begin iterator on inside nodes (i.e. nodes that are not roots or leafs = loc and comm nodes)
iterator_dag end ()
 to get the end iterator on inside nodes (i.e. nodes that are not roots or leafs = loc and comm nodes)
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
void start_communications ()
 start the communication process for the dpmap_nodes property
void end_communications ()
 end the communication process for the dpmap_nodes property

Protected Attributes

bool ptr_const
DPMap_Nodes_impl< DD, T, 1 > * dpmap

Detailed Description

template<class DD, class T>
struct skelgis::DPMap_Nodes< DD, T, 1 >

first specialization of DPMap_Nodes

Template Parameters:
DDis the type of the DDAG
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 node_access is specialized to the value 1

Definition at line 35 of file dpmap_nodes.hpp.


Constructor & Destructor Documentation

template<class DD , class T >
skelgis::DPMap_Nodes< DD, T, 1 >::DPMap_Nodes ( DD &  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 53 of file dpmap_nodes.hpp.

template<class DD , class T >
skelgis::DPMap_Nodes< DD, T, 1 >::DPMap_Nodes ( DD &  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 65 of file dpmap_nodes.hpp.

template<class DD , class T >
skelgis::DPMap_Nodes< DD, T, 1 >::DPMap_Nodes ( DPMap_Nodes_impl< DD, T, 1 > *  p) [inline]

constructor from a DPMap_Nodes_impl pointer

Parameters:
pointerto a DPMap_Nodes_impl

Definition at line 76 of file dpmap_nodes.hpp.


Member Function Documentation

template<class DD , class T >
iterator_dag skelgis::DPMap_Nodes< DD, T, 1 >::begin ( ) [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 160 of file dpmap_nodes.hpp.

template<class DD , class T >
iterator_dag skelgis::DPMap_Nodes< DD, 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 132 of file dpmap_nodes.hpp.

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

to get the begin iterator on leafs nodes

Returns:
the begin iterator on leafs nodes

Definition at line 118 of file dpmap_nodes.hpp.

template<class DD , class T >
iterator_dag skelgis::DPMap_Nodes< DD, 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 146 of file dpmap_nodes.hpp.

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

to get the begin iterator on roots nodes

Returns:
the begin iterator on roots nodes

Definition at line 104 of file dpmap_nodes.hpp.

template<class DD , class T >
iterator_dag skelgis::DPMap_Nodes< DD, T, 1 >::end ( ) [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 167 of file dpmap_nodes.hpp.

template<class DD , class T >
iterator_dag skelgis::DPMap_Nodes< DD, 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 139 of file dpmap_nodes.hpp.

template<class DD , class T >
void skelgis::DPMap_Nodes< DD, T, 1 >::end_communications ( ) [inline]

end the communication process for the dpmap_nodes property

wait for the end of non-blocking communications put received values in the dpmap_nodes property

Definition at line 222 of file dpmap_nodes.hpp.

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

to get the end iterator on leafs nodes

Returns:
the end iterator on leafs nodes

Definition at line 125 of file dpmap_nodes.hpp.

template<class DD , class T >
iterator_dag skelgis::DPMap_Nodes< DD, 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 153 of file dpmap_nodes.hpp.

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

to get the end iterator on roots nodes

Returns:
the end iterator on roots nodes

Definition at line 111 of file dpmap_nodes.hpp.

template<class DD , class T >
DPMap_Nodes_impl<DD,T,1>* skelgis::DPMap_Nodes< DD, T, 1 >::getDPMap ( ) [inline]

to get the pointer on dpmap_impl

Returns:
the dpmap implementation pointer

Definition at line 97 of file dpmap_nodes.hpp.

template<class DD , class T >
std::vector<iterator_dag> skelgis::DPMap_Nodes< DD, 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 182 of file dpmap_nodes.hpp.

template<class DD , class T >
std::vector<iterator_dag> skelgis::DPMap_Nodes< DD, 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 198 of file dpmap_nodes.hpp.

template<class DD , class T >
std::vector<iterator_dag> skelgis::DPMap_Nodes< DD, 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 190 of file dpmap_nodes.hpp.

template<class DD , class T >
std::vector<iterator_dag> skelgis::DPMap_Nodes< DD, 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 206 of file dpmap_nodes.hpp.

template<class DD , class T >
T& skelgis::DPMap_Nodes< DD, 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 174 of file dpmap_nodes.hpp.

template<class DD , class T >
void skelgis::DPMap_Nodes< DD, T, 1 >::start_communications ( ) [inline]

start the communication process for the dpmap_nodes property

prepare data to send launch non blocking MPI communications

Definition at line 214 of file dpmap_nodes.hpp.


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