Regina Calculation Engine
Public Member Functions | List of all members
regina::Dim2VertexEmbedding Class Reference

Details how a vertex in the skeleton of a 2-manifold triangulation forms part of an individual triangle. More...

#include <dim2/dim2vertex.h>

Public Member Functions

 Dim2VertexEmbedding ()
 Default constructor. More...
 
 Dim2VertexEmbedding (Dim2Triangle *tri, int vertex)
 Creates an embedding descriptor containing the given data. More...
 
 Dim2VertexEmbedding (const Dim2VertexEmbedding &cloneMe)
 Creates an embedding descriptor containing the same data as the given embedding descriptor. More...
 
Dim2VertexEmbeddingoperator= (const Dim2VertexEmbedding &cloneMe)
 Assigns to this embedding descriptor the same data as is contained in the given embedding descriptor. More...
 
Dim2TrianglegetTriangle () const
 Returns the triangle in which this vertex is contained. More...
 
int getVertex () const
 Returns the vertex number within getTriangle() that is this vertex. More...
 
NPerm3 getVertices () const
 Returns a permutation that maps 0 to the vertex number within getTriangle() that is this vertex. More...
 
bool operator== (const Dim2VertexEmbedding &rhs) const
 Tests whether this and the given embedding are identical. More...
 
bool operator!= (const Dim2VertexEmbedding &rhs) const
 Tests whether this and the given embedding are different. More...
 

Detailed Description

Details how a vertex in the skeleton of a 2-manifold triangulation forms part of an individual triangle.

Constructor & Destructor Documentation

regina::Dim2VertexEmbedding::Dim2VertexEmbedding ( )
inline

Default constructor.

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

Python:
Not present.
regina::Dim2VertexEmbedding::Dim2VertexEmbedding ( Dim2Triangle tri,
int  vertex 
)
inline

Creates an embedding descriptor containing the given data.

Parameters
trithe triangle in which this vertex is contained.
vertexthe vertex number of tri that is this vertex.
regina::Dim2VertexEmbedding::Dim2VertexEmbedding ( const Dim2VertexEmbedding cloneMe)
inline

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

Parameters
cloneMethe embedding descriptor to clone.

Member Function Documentation

Dim2Triangle * regina::Dim2VertexEmbedding::getTriangle ( ) const
inline

Returns the triangle in which this vertex is contained.

Returns
the triangle.
int regina::Dim2VertexEmbedding::getVertex ( ) const
inline

Returns the vertex number within getTriangle() that is this vertex.

Returns
the vertex number that is this vertex.
NPerm3 regina::Dim2VertexEmbedding::getVertices ( ) const
inline

Returns a permutation that maps 0 to the vertex number within getTriangle() that is this vertex.

This permutation also maps (1,2) to the two remaining triangle vertices in a manner that preserves orientation as you walk around the vertex. See Dim2Triangle::getVertexMapping() for details.

Returns
a permutation that maps 0 to the corresponding vertex number of getTriangle().
bool regina::Dim2VertexEmbedding::operator!= ( const Dim2VertexEmbedding rhs) const
inline

Tests whether this and the given embedding are different.

Here "different" means that they do not refer to the same vertex of the same triangle.

Parameters
rhsthe embedding to compare with this.
Returns
true if and only if both embeddings are identical.
Dim2VertexEmbedding & regina::Dim2VertexEmbedding::operator= ( const Dim2VertexEmbedding cloneMe)
inline

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

Parameters
cloneMethe embedding descriptor to clone.
bool regina::Dim2VertexEmbedding::operator== ( const Dim2VertexEmbedding rhs) const
inline

Tests whether this and the given embedding are identical.

Here "identical" means that they refer to the same vertex of the same triangle.

Parameters
rhsthe embedding to compare with this.
Returns
true if and only if both embeddings are identical.

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

Copyright © 1999-2014, The Regina development team
This software is released under the GNU General Public License, with some additional permissions; see the source code for details.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).