Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
regina::NEdgeEmbedding

regina::NEdgeEmbedding Class Reference
[Triangulations]

Details how an edge in the skeleton forms part of an individual tetrahedron. More...

#include <nedge.h>

List of all members.

Public Member Functions

 NEdgeEmbedding ()
 Default constructor.
 NEdgeEmbedding (NTetrahedron *newTet, int newEdge)
 Creates an embedding descriptor containing the given data.
 NEdgeEmbedding (const NEdgeEmbedding &cloneMe)
 Creates an embedding descriptor containing the same data as the given embedding descriptor.
NEdgeEmbedding & operator= (const NEdgeEmbedding &cloneMe)
 Assigns to this embedding descriptor the same data as is contained in the given embedding descriptor.
NTetrahedron * getTetrahedron () const
 Returns the tetrahedron in which this edge is contained.
int getEdge () const
 Returns the edge number within getTetrahedron() that is this edge.
NPerm getVertices () const
 Returns a mapping from vertices (0,1) of this edge to the corresponding vertex numbers in getTetrahedron(), as described in NTetrahedron::getEdgeMapping().

Detailed Description

Details how an edge in the skeleton forms part of an individual tetrahedron.

Constructor & Destructor Documentation

regina::NEdgeEmbedding::NEdgeEmbedding (   )  [inline]
 

Default constructor.

The embedding descriptor created is unusable until it has some data assigned to it using operator =.

Python:
Not present.

regina::NEdgeEmbedding::NEdgeEmbedding (  NTetrahedron *  newTet,
int  newEdge
)  [inline]
 

Creates an embedding descriptor containing the given data.

Parameters:
newTet the tetrahedron in which this edge is contained.
newEdge the edge number of newTet that is this edge.

regina::NEdgeEmbedding::NEdgeEmbedding (  const NEdgeEmbedding &  cloneMe  )  [inline]
 

Creates an embedding descriptor containing the same data as the given embedding descriptor.

Parameters:
cloneMe the embedding descriptor to clone.

Member Function Documentation

int regina::NEdgeEmbedding::getEdge (   )  const [inline]
 

Returns the edge number within getTetrahedron() that is this edge.

Returns:
the edge number that is this edge.

NTetrahedron * regina::NEdgeEmbedding::getTetrahedron (   )  const [inline]
 

Returns the tetrahedron in which this edge is contained.

Returns:
the tetrahedron.

NPerm regina::NEdgeEmbedding::getVertices (   )  const [inline]
 

Returns a mapping from vertices (0,1) of this edge to the corresponding vertex numbers in getTetrahedron(), as described in NTetrahedron::getEdgeMapping().

Returns:
a mapping from the vertices of this edge to the vertices of getTetrahedron().

NEdgeEmbedding & regina::NEdgeEmbedding::operator= (  const NEdgeEmbedding &  cloneMe  )  [inline]
 

Assigns to this embedding descriptor the same data as is contained in the given embedding descriptor.

Parameters:
cloneMe the embedding descriptor to clone.

The documentation for this class was generated from the following file:
Copyright © 1999-2004, Ben Burton
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).