SkelGIS  3.0
skelgis::DPMap_Edges< DD, T *, 1 > 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 *, 1 > 
impl_type

Public Member Functions

 DPMap_Edges (DD &dag, const char *file, unsigned int size)
 constructor of DPMap_Edges
 DPMap_Edges (DD &dag, T val, unsigned int size)
 constructor of DPMap_Edges
 DPMap_Edges (DPMap_Edges_impl< DD, T *, 1 > *p)
 constructor from a DPMap_Edges_impl pointer
 ~DPMap_Edges ()
 destructor of DPMap_Edges
DPMap_Edges_impl< DD, T *, 1 > * 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 *, 1 > * dpmap

Detailed Description

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

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 construction The size is not specialized, it is the number of elements in the pointer table to map

Definition at line 410 of file dpmap_edges.hpp.


Constructor & Destructor Documentation

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

constructor of DPMap_Edges

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)

Definition at line 426 of file dpmap_edges.hpp.

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

constructor of DPMap_Edges

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

Definition at line 438 of file dpmap_edges.hpp.

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

constructor from a DPMap_Edges_impl pointer

Parameters:
pointerto a DPMap_Edges_impl

Definition at line 449 of file dpmap_edges.hpp.


Member Function Documentation

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

to get the begin iterator on edges

Returns:
the begin iterator on edges

Definition at line 478 of file dpmap_edges.hpp.

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

to get the end iterator on edges

Returns:
the end iterator on edges

Definition at line 485 of file dpmap_edges.hpp.

template<class DD , class T >
void skelgis::DPMap_Edges< DD, T *, 1 >::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 522 of file dpmap_edges.hpp.

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

to get the pointer on dpmap_impl

Returns:
the dpmap implementation pointer

Definition at line 471 of file dpmap_edges.hpp.

template<class DD , class T >
iterator_dag skelgis::DPMap_Edges< DD, T *, 1 >::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 506 of file dpmap_edges.hpp.

template<class DD , class T >
iterator_dag skelgis::DPMap_Edges< DD, T *, 1 >::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 499 of file dpmap_edges.hpp.

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

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

start the communication process for the dpmap_edges property

prepare data to send launch non blocking MPI communications

Definition at line 514 of file dpmap_edges.hpp.


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