SkelGIS  3.0
skelgis::DPMap_Edges< DD, T *, node_access > Struct Template Reference

third specialization of DPMap_Edges More...

#include <dpmap_edges.hpp>

List of all members.

Public Types

typedef DPMap_Edges_impl< DD,
T *, node_access > 
impl_type

Public Member Functions

 DPMap_Edges (DD &dag, const char *file, unsigned int size)
 constructor of DPMap_Edges from a file
 DPMap_Edges (DD &dag, T val, unsigned int size)
 constructor of DPMap_Edges from a value
 DPMap_Edges (DPMap_Edges_impl< DD, T *, node_access > *p)
 constructor from a DPMap_Edges_impl pointer
 ~DPMap_Edges ()
 destructor of DPMap_Edges
DPMap_Edges_impl< DD, T
*, node_access > * 
getDPMap ()
 to get the pointer on dpmap_impl
iterator_dag begin ()
 to get the begin iterator on edges
iterator_dag end ()
 to get the end iterator on edges
T * operator[] (iterator_dag it)
 to get the value of the property map at the iterator position
iterator_dag getSrcNode (iterator_dag it)
 to get an iterator on the source node of the edge
iterator_dag getDstNode (iterator_dag it)
 to get an iterator on the destination node of the edge
void start_communications ()
 start the communication process for the dpmap_edges property
void end_communications ()
 end the communication process for the dpmap_edges property

Protected Attributes

bool ptr_const
DPMap_Edges_impl< DD, T
*, node_access > * 
dpmap

Detailed Description

template<class DD, class T, int node_access>
struct skelgis::DPMap_Edges< DD, T *, node_access >

third specialization of DPMap_Edges

Template Parameters:
DDis the type of the DDAG
Tis the type of data in the property map
node_accessindicates if nodes have to have access to this property during calculation (>=1) or not (=0)

In the case of a basic type T, node_access can't be >1 In the case of a pointer type T*, if node_access>0 then it indicates the number of elements to shared at the end and at the beginning of the pointer

The type T is specialized with a specific pointer type in this case as float*, double*, int* etc. The node_access is not specialized and is [0,...,size] size is precised at constructor call The size is not specialized, it is the number of elements in the pointer table to map

Definition at line 277 of file dpmap_edges.hpp.


Constructor & Destructor Documentation

template<class DD , class T , int node_access>
skelgis::DPMap_Edges< DD, T *, node_access >::DPMap_Edges ( DD &  dag,
const char *  file,
unsigned int  size 
) [inline]

constructor of DPMap_Edges from a file

Parameters:
dagis the DDAG object associated to this map
fileis the file with initial values of edges wanted (each line is the value of the node "number of this line" associated in the .dot file)
sizeis the size of the pointer table mapped on edges

Definition at line 294 of file dpmap_edges.hpp.

template<class DD , class T , int node_access>
skelgis::DPMap_Edges< DD, T *, node_access >::DPMap_Edges ( DD &  dag,
val,
unsigned int  size 
) [inline]

constructor of DPMap_Edges from a value

Parameters:
dagis the DDAG object associated to this map
valis the default value of edges for the map
sizeis the size of the pointer table mapped on edges

Definition at line 307 of file dpmap_edges.hpp.

template<class DD , class T , int node_access>
skelgis::DPMap_Edges< DD, T *, node_access >::DPMap_Edges ( DPMap_Edges_impl< DD, T *, node_access > *  p) [inline]

constructor from a DPMap_Edges_impl pointer

Parameters:
pointerto a DPMap_Edges_impl

Definition at line 318 of file dpmap_edges.hpp.


Member Function Documentation

template<class DD , class T , int node_access>
iterator_dag skelgis::DPMap_Edges< DD, T *, node_access >::begin ( ) [inline]

to get the begin iterator on edges

Returns:
the begin iterator on edges

Definition at line 347 of file dpmap_edges.hpp.

template<class DD , class T , int node_access>
iterator_dag skelgis::DPMap_Edges< DD, T *, node_access >::end ( ) [inline]

to get the end iterator on edges

Returns:
the end iterator on edges

Definition at line 354 of file dpmap_edges.hpp.

template<class DD , class T , int node_access>
void skelgis::DPMap_Edges< DD, T *, node_access >::end_communications ( ) [inline]

end the communication process for the dpmap_edges property

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

Definition at line 391 of file dpmap_edges.hpp.

template<class DD , class T , int node_access>
DPMap_Edges_impl<DD,T*,node_access>* skelgis::DPMap_Edges< DD, T *, node_access >::getDPMap ( ) [inline]

to get the pointer on dpmap_impl

Returns:
the dpmap implementation pointer

Definition at line 340 of file dpmap_edges.hpp.

template<class DD , class T , int node_access>
iterator_dag skelgis::DPMap_Edges< DD, T *, node_access >::getDstNode ( iterator_dag  it) [inline]

to get an iterator on the destination node of the edge

Returns:
the iterator on the destination node

Definition at line 375 of file dpmap_edges.hpp.

template<class DD , class T , int node_access>
iterator_dag skelgis::DPMap_Edges< DD, T *, node_access >::getSrcNode ( iterator_dag  it) [inline]

to get an iterator on the source node of the edge

Returns:
the iterator on the source node

Definition at line 368 of file dpmap_edges.hpp.

template<class DD , class T , int node_access>
T* skelgis::DPMap_Edges< DD, T *, node_access >::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 361 of file dpmap_edges.hpp.

template<class DD , class T , int node_access>
void skelgis::DPMap_Edges< DD, T *, node_access >::start_communications ( ) [inline]

start the communication process for the dpmap_edges property

prepare data to send launch non blocking MPI communications

Definition at line 383 of file dpmap_edges.hpp.


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