andres::graph::GridGraph< D, VISITOR >::EdgeCoordinate Class Reference

Describes an edge as the integer index of the minimum of the two endpoints and the direction along which it is drawn. More...

#include <grid-graph.hxx>

Public Member Functions
	EdgeCoordinate (const VertexCoordinate &, const size_type, bool=false)
	Initialize an edge coordinate.
	EdgeCoordinate ()
	Default non-initializing constructor.

Public Attributes
VertexCoordinate	pivotCoordinate_
	The minimum of the two endpoints of the edge is specified as an integer and accessed by the pivot member.
size_type	dimension_
	The dimension along which the edge is drawn.

Detailed Description

template<unsigned char D = 2, class VISITOR = IdleGraphVisitor<std::size_t>>
class andres::graph::GridGraph< D, VISITOR >::EdgeCoordinate

Describes an edge as the integer index of the minimum of the two endpoints and the direction along which it is drawn.

Definition at line 35 of file grid-graph.hxx.

Constructor & Destructor Documentation

template<unsigned char D, class VISITOR >

andres::graph::GridGraph< D, VISITOR >::EdgeCoordinate::EdgeCoordinate ( const VertexCoordinate &  pivotCoordinate, const size_type  dimension, bool  isSmaller = false  )

inline

Initialize an edge coordinate.

Parameters

pivotCoordinate	coordinate of the reference vertex.
dimension	dimension along which the edge is drawn.
isSmaller	relative position of specified endpoint. A value of true results in an object corresponding to the edge of which the smallest endpoint has a GridGraph::VertexCoordinate equal to pivotCoordinate. Similarly, a value of false results in an object corresponding to the edge of which the largest endpoint has a GridGraph::VertexCoordinate equal to pivotCoordinate.

Definition at line 1024 of file grid-graph.hxx.

template<unsigned char D, class VISITOR >

andres::graph::GridGraph< D, VISITOR >::EdgeCoordinate::EdgeCoordinate ( )

inline

Default non-initializing constructor.

Warning

this constructor will NOT set the pivotCoordinate_ membr variable to zero.

Definition at line 1041 of file grid-graph.hxx.

Member Data Documentation

template<unsigned char D = 2, class VISITOR = IdleGraphVisitor<std::size_t>>

size_type andres::graph::GridGraph< D, VISITOR >::EdgeCoordinate::dimension_

The dimension along which the edge is drawn.

Definition at line 46 of file grid-graph.hxx.

template<unsigned char D = 2, class VISITOR = IdleGraphVisitor<std::size_t>>

VertexCoordinate andres::graph::GridGraph< D, VISITOR >::EdgeCoordinate::pivotCoordinate_

The minimum of the two endpoints of the edge is specified as an integer and accessed by the pivot member.

This specifies the origin of the edge, in a direction towards the positive orthant. (i.e.: in specifying the pivot of an edge, an isSmaller of false is implied.)

Definition at line 44 of file grid-graph.hxx.