OpenWalnut  1.4.0
Public Member Functions
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:

List of all members.

Public Member Functions

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

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

utility::Edge::Edge ( unsigned int  i,
unsigned int  j 
) [inline]

Constructor that sorts the input indices.

Parameters:
ithe first index.
jThe second index.

Definition at line 51 of file WGeometryFunctions.h.


Member Function Documentation

bool utility::Edge::operator< ( Edge const &  e) const [inline]

Compare two edges.

This operator defines a weak ordering on the edges.

Parameters:
eThe edge to compare to.
Returns:
True, iff this edge is 'smaller' than the given edge.

Definition at line 62 of file WGeometryFunctions.h.

bool utility::Edge::operator== ( Edge const &  e) const [inline]

Compare two edges for equality.

Parameters:
eThe 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: