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

regina::NKnot Class Reference
[Knots and Links]

Represents knots and links in S^3 and allows the construction of triangulations from them. More...

#include <nknot.h>

List of all members.

Public Member Functions

 NKnot ()
 Creates the empty link.
 NKnot (const std::string &s)
 Creates a knot using its Dowker notation or a spanning surface representation.
bool isValid () const
 Returns true if a valid knot or link was created.
NTriangulationgetTriang (bool ideal=true)
 Creates a triangulation of the knot complement.


Detailed Description

Represents knots and links in S^3 and allows the construction of triangulations from them.

A knot/link can be presented in one of two ways: Dowker notation which works for knots only, or using an embedded of a sign planar graph in a plane which works for both knots and links.

Once a knot or link is created ideal and finite triangulations of the complement can be constructed.

Warning:
This class is incomplete and at the present time should not be used!
Python:
Will not be present until this class is functional.
Author:
David Letscher


Constructor & Destructor Documentation

regina::NKnot::NKnot  ) 
 

Creates the empty link.

regina::NKnot::NKnot const std::string &  s  ) 
 

Creates a knot using its Dowker notation or a spanning surface representation.

Parameters:
s a string storing the Dowker notation for the knot or the spanning surface representation of a link.


Member Function Documentation

NTriangulation* regina::NKnot::getTriang bool  ideal = true  ) 
 

Creates a triangulation of the knot complement.

Both ideal and finite triangulations are possible.

Parameters:
ideal is true if an ideal triangulation should be constructed (default to /c true).
Returns:
the triangulation of the knot complement.

bool regina::NKnot::isValid  )  const
 

Returns true if a valid knot or link was created.

Returns:
the validity of the knot.


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).