utility::Edge Class Reference

A helper class that is used to store edges as pairs of vertex indices. More...

#include <WGeometryFunctions.h>

Inheritance diagram for utility::Edge:

Collaboration diagram for utility::Edge:

Public Member Functions
	Edge (unsigned int i, unsigned int j)
	Constructor that sorts the input indices. More...
bool	operator< (Edge const &e) const
	Compare two edges. More...
bool	operator== (Edge const &e) const
	Compare two edges for equality. More...

Detailed Description

A helper class that is used to store edges as pairs of vertex indices.

The indices are sorted.

Definition at line 42 of file WGeometryFunctions.h.

Constructor & Destructor Documentation

Edge()

utility::Edge::Edge ( unsigned int  i, unsigned int  j  )

inline

Constructor that sorts the input indices.

Parameters

i	the first index.
j	The second index.

Definition at line 51 of file WGeometryFunctions.h.

Member Function Documentation

operator<()

bool utility::Edge::operator< ( Edge const &  e ) const

inline

Compare two edges.

This operator defines a weak ordering on the edges.

Parameters

e	The edge to compare to.

Returns

True, iff this edge is 'smaller' than the given edge.

Definition at line 62 of file WGeometryFunctions.h.

operator==()

bool utility::Edge::operator== ( Edge const &  e ) const

inline

Compare two edges for equality.

Parameters

e	The edge to compare to.

Returns

True, iff this edge has the same vertex indices as the given edge.

Definition at line 73 of file WGeometryFunctions.h.

---

The documentation for this class was generated from the following file:

• WGeometryFunctions.h