Represents a 2-tangle in the 3-ball. More...

#include <link/tangle.h>

Inheritance diagram for regina::Tangle:

Public Member Functions
std::string	str () const
	Returns a short text representation of this object. More...

std::string	utf8 () const
	Returns a short text representation of this object using unicode characters. More...

std::string	detail () const
	Returns a detailed text representation of this object. More...

Constructors and Destructors
	Tangle ()
	Constructs the zero tangle. More...

	Tangle (int twists)
	Constructs a tangle from the given number of twists. More...

	Tangle (int num, int den)
	Constructs a rational tangle with the given parameters. More...

	Tangle (const Link &knot)
	Creates a tangle from two parallel copies of the given knot. More...

	Tangle (const Tangle &copy)
	Constructs a new copy of the given tangle. More...

	Tangle (Tangle &&src) noexcept
	Moves the given tangle into this new tangle. More...

	~Tangle ()
	Destroys this tangle. More...

Crossings and Strings
char	type () const
	Returns the type of this tangle. More...

size_t	size () const
	Returns the number of crossings in this tangle. More...

Crossing *	crossing (size_t index) const
	Returns a pointer to the crossing at the given index within this tangle. More...

auto	crossings () const
	Returns an object that allows iteration through and random access to all crossings within this tangle. More...

StrandRef	begin (int string) const
	Returns the crossing closest to the beginning of the given string. More...

StrandRef	end (int string) const
	Returns the crossing closest to the end of the given string. More...

bool	operator== (const Tangle &other) const
	Determines if this tangle is combinatorially identical to the given tangle. More...

bool	operator!= (const Tangle &other) const
	Determines if this tangle is not combinatorially identical to the given tangle. More...

StrandRef	translate (const StrandRef &other) const
	Translates a strand reference for some other tangle into the corresponding strand reference for this tangle. More...

Editing
Tangle &	operator= (const Tangle &src)
	Sets this to be a (deep) copy of the given tangle. More...

Tangle &	operator= (Tangle &&src) noexcept
	Moves the contents of the given tangle into this tangle. More...

void	swap (Tangle &other) noexcept
	Swaps the contents of this and the given tangle. More...

void	swapContents (Tangle &other) noexcept
	Deprecated routine that swaps the contents of this and the given tangle. More...

void	twist (int sign=1)
	Adds a twist to the right-hand end of this tangle. More...

void	turn (int direction=1)
	Rotates this tangle by 90 degrees. More...

void	changeAll ()
	Switches the upper and lower strands of every crossing in the tangle. More...

bool	r1 (Crossing *crossing, bool check=true, bool perform=true)
	Tests for and/or performs a type I Reidemeister move to remove a crossing. More...

bool	r2 (StrandRef arc, bool check=true, bool perform=true)
	Tests for and/or performs a type II Reidemeister move to remove two crossings. More...

bool	r2 (Crossing *crossing, bool check=true, bool perform=true)
	Tests for and/or performs a type II Reidemeister move to remove two crossings. More...

bool	simplifyToLocalMinimum (bool perform=true)
	Uses type I and II Reidemeister moves to reduce the tangle monotonically to some local minimum number of crossings. More...

Algebra on Tangles
void	add (const Tangle &other)
	Adds the given tangle to the right-hand side of this tangle. More...

void	negate ()
	Reflects this tangle through the diagonal axis running from the top-left to bottom-right corners of the diagram. More...

void	box (const Tangle &topLeft, const Tangle &topRight, const Tangle &bottomLeft, const Tangle &bottomRight)
	Encloses this tangle with the four given tangles in a box configuration. More...

Link	numClosure () const
	Forms the numerator closure of this tangle. More...

Link	denClosure () const
	Forms the denominator closure of this tangle. More...

Output
void	writeTextShort (std::ostream &out) const
	Writes a short text representation of this tangle to the given output stream. More...

void	writeTextLong (std::ostream &out) const
	Writes a detailed text representation of this tangle to the given output stream. More...

Exporting Tangles
std::string	brief () const
	Outputs this tangle in Regina's own brief write-only format. More...

void	brief (std::ostream &out) const
	Writes this tangle in Regina's own brief format to the given output stream. More...

std::string	orientedGauss () const
	Outputs an oriented Gauss code for this tangle. More...

void	orientedGauss (std::ostream &out) const
	Writes an oriented Gauss code for this tangle to the given output stream. More...

Building Tangles
static Tangle	fromOrientedGauss (const std::string &str)
	Creates a new tangle from an oriented Gauss code. More...

template<typename Iterator >
static Tangle	fromOrientedGauss (Iterator begin, Iterator end)
	Creates a new tangle from an oriented Gauss code. More...

Detailed Description

Represents a 2-tangle in the 3-ball.

Regina does not allow closed components in a tangle; in other words, a tangle in Regina is a proper embedding of exactly two arcs in the 3-ball with the corresponding four endpoints attached to four marked points on the 3-ball boundary.

Regina stores tangles as projections, with the four endpoints fixed at the top-left, top-right, bottom-left and bottom-right corners of the diagram.

Each tangles has a type, indicating how the four endpoints are connected. The three possible types are:

horizontal, indicating that the two top endpoints are connected, and the two bottom endpoints are connected;
vertical, indicating that the two left endpoints are connected, and the two right endpoints are connected;
diagonal, indicating that the top-left and bottom-right endpoints are connected, and the bottom-left and top-right endpoints are connected.

Internally, Regina numbers the two strings 0 and 1: string 0 will always be the one attached to the top-left endpoint. Regina also assigns each string an orientation: for a horizontal or diagonal tangle this will always be from left to right, and for a vertical tangle this will always be from top to bottom.

When traversing a tangle, if you reach one of the endpoints of a string then the corresponding return value of Crossing::next() or Crossing::prev() (whichever is relevant) will be a null strand reference.

This class implements C++ move semantics and adheres to the C++ Swappable requirement. It is designed to avoid deep copies wherever possible, even when passing or returning objects by value.

Constructor & Destructor Documentation

◆ Tangle() [1/6]

regina::Tangle::Tangle ( )

inline

Constructs the zero tangle.

This is the horizontal tangle with no crossings.

◆ Tangle() [2/6]

regina::Tangle::Tangle ( int twists )

Constructs a tangle from the given number of twists.

If twists is positive, then the new tangle will consist of twists positive twists, stacked from left to right. If twists is negative, then the new tangle will consist of -(twists) negative twists, likewise stacked from left to right. If twists is zero, then the new tangle will be a horizontal tangle with no crossings at all.

In all cases, this is equivalent to calling the rational tangle constructor Tangle(twists, 1).

Parameters

twists the number of twists to perform; this may be positive, negative or zero.

◆ Tangle() [3/6]

regina::Tangle::Tangle	(	int	num,
		int	den
	)

Constructs a rational tangle with the given parameters.

Here we use the following convention (following the description that Adams gives in The Knot Book):

the zero tangle is horizontal with no crossings;
the infinity tangle is vertical with no crossings;
the +1 tangle is diagonal with one crossing, where the upper string runs from bottom-left to top-right.

Precondition: The given arguments are coprime.

Parameters

num	the numerator of the rational number that describes this tangle.
den	the denominator of the rational number that describes this tangle; this may be 0 (representing the infinity tangle).

◆ Tangle() [4/6]

regina::Tangle::Tangle ( const Link & knot )

Creates a tangle from two parallel copies of the given knot.

Specifically, the tangle will consist of two parallel copies of the given knot diagram, which will be broken just before the starting strand as returned by knot.component(0).

The two resulting endpoints that appear just before the starting strand will form the top-left and bottom-left endpoints of this tangle, and the endpoints on the other side of the break (which will be just after the parallel copies of the final strand knot.component(0).prev()) will form the top-right and bottom-right endpoints of this tangle.

The tangle will contain 4 * knot.size() crossings in total.

Precondition: The argument contains exactly one component (i.e., it is actually a knot, and not empty or a multiple-component link).

Parameters

knot	the knot to break and duplicate to form this tangle.

◆ Tangle() [5/6]

regina::Tangle::Tangle ( const Tangle & copy )

Constructs a new copy of the given tangle.

Parameters

copy	the tangle to copy.

◆ Tangle() [6/6]

regina::Tangle::Tangle ( Tangle && src )

noexcept

Moves the given tangle into this new tangle.

This is a fast (constant time) operation.

All crossings that belong to src will be moved into this tangle, and so any Crossing pointers or StrandRef object will remain valid. Likewise, all cached properties will be moved into this tangle.

The tangle that is passed (src) will no longer be usable.

Parameters

src	the tangle to move.

◆ ~Tangle()

regina::Tangle::~Tangle ( )

inline

Destroys this tangle.

The Crossing objects contained in this tangle will also be destroyed.

Member Function Documentation

◆ add()

void regina::Tangle::add ( const Tangle & other )

Adds the given tangle to the right-hand side of this tangle.

In Conway's notation, if this tangle is t, then this routine converts this into (t + other).

Specifically: this routine will attach the two right-hand endpoints of this tangle to the two left-hand endpoints of a copy of other.

This tangle will be changed directly. The tangle other (passed as the argumet) will be left unchanged.

It is allowed to pass this tangle as other.

Precondition: It is not the case that both this and other are vertical tangles (which would cause the addition to create a closed link component).

Parameters

other the tangle to add to this.

◆ begin()

StrandRef regina::Tangle::begin ( int string ) const

inline

Returns the crossing closest to the beginning of the given string.

Recall from the class notes that string 0 is always attached to the top-left endpoint. Recall also that strings are oriented from left-to-right for a horizontal or diagonal tangle, and from top-to-bottom for a vertical tangle.

Parameters

string indicates which of the two strings in this tangle to query; this must be either 0 or 1.

Returns: the crossing closest to the beginning of the given string, or a null reference if the given string contains no crossings.

◆ box()

void regina::Tangle::box	(	const Tangle &	topLeft,
		const Tangle &	topRight,
		const Tangle &	bottomLeft,
		const Tangle &	bottomRight
	)

Encloses this tangle with the four given tangles in a box configuration.

The five tangles will be connected as shown, with this tangle in the centre:

 \     /
  O---O
 / \ / \
 |  O  |
 \ / \ /
  O---O
 /     \

The top-left corner of the argument topLeft will become the top-left corner of the resulting tangle, and so on for the other three corners.

This tangle will be changed directly. The other four other tangles (passed as arguments) will be left unchanged.

You may use the same tangle for multiple arguments, and you may even use this tangle for one or more arguments.

Precondition: Every string in all five tangles (the four arguments and this) has at least one crossing.; None of the five tangles (the four arguments and this) have types that would result in a closed link component after this operation is performed.

Parameters

topLeft	the tangle to connect to the top-left corner of this.
topRight	the tangle to connect to the top-right corner of this.
bottomLeft	the tangle to connect to the bottom-left corner of this.
bottomRight	the tangle to connect to the bottom-right corner of this.

◆ brief() [1/2]

std::string regina::Tangle::brief ( ) const

Outputs this tangle in Regina's own brief write-only format.

This format is concise, but contains enough information to manually reconstruct the complete tangle.

This format cannot (yet) be used to read tangles back into Regina, and so it is not good for external storage, or for passing tangles between different programs (or even different instances of Regina). It was originally designed for use with the test suite, where it was used to ensure that tangles with being created and/or manipulated correctly.

The output will contain the following elements, separated by single spaces:

one of the symbols -, | or x, indicating that the tangle is of horizontal, vertical or diagonal type respectively (as described in the class notes);
a sequence of signs (+ or -), concatenated together, giving the signs of the crossings in order from crossing 0 to crossing size()-1;
a description of string 0 and then string 1. Each string will be written in the form ( a b c ... ), indicating the crossings that are encountered as we follow the string in the forward direction from its starting endpoint. Each element a, b, c and so on will be written in the format used by the StrandRef class: either ^n when passing over crossing n, or _n when passing under crossing n.

For example, the rational tangle 3/2 as returned by Tangle(3,2) will give the following brief output:

| --+ ( _0 ^1 ) ( ^2 _1 ^0 _2 )

As a special case, if the tangle contains no crossings then the output will contain just one space, not two consecutive spaces, between the type symbol and the string descriptions (since the sequence of crossing signs that would normally sit between them will be empty).

The string will not end in a newline.

There is also a variant of brief() that writes directly to an output stream.

Returns: a description of this tangle in Regina's brief format.

◆ brief() [2/2]

void regina::Tangle::brief ( std::ostream & out ) const

Writes this tangle in Regina's own brief format to the given output stream.

See brief() for a full description of Regina's brief format, as well as its limitations.

The output from this routine is precisely the string that would be returned by brief(). In particular, the output does not contain any newlines.

See also brief(), which returns the brief format as a string.

Python: Not present; instead use the variant brief() that takes no arguments and returns a string.

Parameters

out	the output stream to which to write.

◆ changeAll()

void regina::Tangle::changeAll ( )

Switches the upper and lower strands of every crossing in the tangle.

This operation corresponds to reflecting the tangle through the plane on which the diagram is drawn.

◆ crossing()

Crossing * regina::Tangle::crossing ( size_t index ) const

inline

Returns a pointer to the crossing at the given index within this tangle.

For a tangle with n crossings, the crossings are numbered from 0 to n-1 inclusive.

Warning: If some crossings are added or removed then the indices of other crossings might change. If you wish to track a particular crossing through such operations then you should use the pointer to the relevant Crossing object instead.

Parameters

index the index of the requested crossing. This must be between 0 and size()-1 inclusive.

Returns: the crossing at the given index.

◆ crossings()

auto regina::Tangle::crossings ( ) const

inline

Returns an object that allows iteration through and random access to all crossings within this tangle.

The object that is returned is lightweight, and can be happily copied by value. The C++ type of the object is subject to change, so C++ users should use auto (just like this declaration does).

The returned object is guaranteed to be an instance of ListView, which means it offers basic container-like functions and supports C++11 range-based for loops. Note that the elements of the list will be pointers, so your code might look like:

for (Crossing* c : tangle.crossings()) { ... }

The object that is returned will remain up-to-date and valid for as long as the tangle exists: even as crossings are added and/or removed, it will always reflect the crossings that are currently in the tangle. Nevertheless, it is recommended to treat this object as temporary only, and to call crossings() again each time you need it.

Returns: access to the list of all crossings.

◆ denClosure()

Link regina::Tangle::denClosure ( ) const

Forms the denominator closure of this tangle.

This is the link created by joining the two left endpoints of this tangle, and also joining the two right endpoints.

Returns: the denominator closure of this tangle.

◆ detail()

std::string regina::Output< Tangle , false >::detail ( ) const

inherited

Returns a detailed text representation of this object.

This text may span many lines, and should provide the user with all the information they could want. It should be human-readable, should not contain extremely long lines (which cause problems for users reading the output in a terminal), and should end with a final newline. There are no restrictions on the underlying character set.

Returns: a detailed text representation of this object.

◆ end()

StrandRef regina::Tangle::end ( int string ) const

inline

Returns the crossing closest to the end of the given string.

Recall from the class notes that string 0 is always attached to the top-left endpoint. Recall also that strings are oriented from left-to-right for a horizontal or diagonal tangle, and from top-to-bottom for a vertical tangle.

Parameters

string indicates which of the two strings in this tangle to query; this must be either 0 or 1.

Returns: the crossing closest to the end of the given string, or a null reference if the given string contains no crossings.

◆ fromOrientedGauss() [1/2]

static Tangle regina::Tangle::fromOrientedGauss ( const std::string & str )

static

Creates a new tangle from an oriented Gauss code.

Oriented Gauss codes for tangles are an extension of oriented Gauss codes for knots. Whilst oriented Gauss codes for knots are used elsewhere (they are based on a format used by Andreeva et al.), these codes for tangles are specific to Regina (so you should not expect other software to understand them).

The format works as follows:

Label the crossings arbitrarily as 1, 2, ..., n.
Write one of the tokens -, | or x to represent a horizontal, vertical or diagonal tangle respectively.
Start at the top-left endpoint and follow this string to its other endpoint. At every crossing that you pass, write a token of the form +<k, -<k, +>k or ->k, where:
- the symbol + indicates that you are passing over the crossing labelled k, and the symbol - indicates that you are passing under the crossing labelled k;
- the symbol < indicates that the other strand of the crossing passes from right to left, and > indicates that the other strand passes from left to right.
Write the token _ to indicate that the first string has finished.
Start at the beginning of the other string (for horizontal or diagonal tangles, this is the bottom-left endpoint, and for vertical tangles this is the top-right endpoint). As before, follow this string to its other endpoint, writing a token of the form +<k, -<k, +>k or ->k at every crossing that you pass.

Be aware that, once the tangle has been constructed, the crossings 1, ..., n will have been reindexed as 0, ..., n-1 (since every Tangle object numbers its crossings starting from 0).

As an example, you can construct the rational tangle -3/4 using the following code:

| -<1 +>2 -<3 +>4 _ -<5 -<4 +>3 -<2 +>1 +>5

There are two variants of this routine. This variant takes a single string, where the tokens have been combined together and separated by whitespace. The other variant takes a sequence of tokens, defined by a pair of iterators.

In this variant (the string variant), the given string may contain additional leading or trailing whitespace.

Warning: While this routine does some error checking on the input, these checks are not exhaustive. In particular, it does not test for the viability of the diagram (i.e., whether the given crossings with the given signs actually produce a tangle of the given type with the correct endpoints). Of course non-viable inputs are not allowed, and it is currently up to the user to enforce this.

Exceptions

InvalidArgument the input was not a valid oriented Gauss code. As noted above, the checks performed here are not exhaustive.

Parameters

str	an oriented Gauss code for a tangle, as described above.

Returns: the resulting tangle.

◆ fromOrientedGauss() [2/2]

template<typename Iterator >

static Tangle regina::Tangle::fromOrientedGauss	(	Iterator	begin,
		Iterator	end
	)

static

Creates a new tangle from an oriented Gauss code.

Oriented Gauss codes for tangles are an extension of oriented Gauss codes for knots. Whilst oriented Gauss codes for knots are used elsewhere (they are based on a format used by Andreeva et al.), these codes for tangles are specific to Regina (so you should not expect other software to understand them).

See fromOrientedGauss(const std::string&) for a detailed description of this format as it is used in Regina.

There are two variants of this routine. The other variant (fromOrientedGauss(const std::string&), which offers more detailed documentation) takes a single string, where the tokens have been combined together and separated by whitespace. This variant takes a sequence of tokens, defined by a pair of iterators.

Precondition: Iterator is a random access iterator type.; Dereferencing such an iterator produces either a C-style string (which can be cast to const char*) or a C++-style string (which can be cast to const std::string&).; The tokens in the input sequence do not contain any whitespace.

Warning: While this routine does some error checking on the input, these checks are not exhaustive. In particular, it does not test for the viability of the diagram (i.e., whether the given crossings with the given signs actually produce a tangle of the given type with the correct endpoints). Of course non-viable inputs are not allowed, and it is currently up to the user to enforce this.

Exceptions

InvalidArgument the input did not describe a valid oriented Gauss code. As noted above, the checks performed here are not exhaustive.

Python: Instead of a pair of begin and past-the-end iterators, this routine takes a Python list of strings.

Parameters

begin	an iterator that points to the beginning of the sequence of tokens for an oriented Gauss code.
end	an iterator that points past the end of the sequence of tokens for an oriented Gauss code.

Returns: the resulting tangle.

◆ negate()

void regina::Tangle::negate ( )

Reflects this tangle through the diagonal axis running from the top-left to bottom-right corners of the diagram.

In Conway's notation, this negates the tangle.

◆ numClosure()

Link regina::Tangle::numClosure ( ) const

Forms the numerator closure of this tangle.

This is the link created by joining the two top endpoints of this tangle, and also joining the two bottom endpoints.

Returns: the numerator closure of this tangle.

◆ operator!=()

bool regina::Tangle::operator!= ( const Tangle & other ) const

inline

Determines if this tangle is not combinatorially identical to the given tangle.

Here "identical" means that:

the tangles are of the same type and have the same number of crossings;
the same numbered crossings are positive and negative in both tangles;
the corresponding strings in each tangle pass through the same under/over-strands of the same numbered crossings in the same order.

Parameters

other the tangle to compare with this.

Returns: true if and only if the two tangles are not combinatorially identical.

◆ operator=() [1/2]

Tangle & regina::Tangle::operator= ( const Tangle & src )

Sets this to be a (deep) copy of the given tangle.

Parameters

src	the tangle to copy.

Returns: a reference to this tangle.

◆ operator=() [2/2]

Tangle & regina::Tangle::operator= ( Tangle && src )

noexcept

Moves the contents of the given tangle into this tangle.

This is a fast (constant time) operation.

All crossings that belong to src will be moved into this tangle, and so any Crossing pointers or StrandRef object will remain valid. Likewise, all cached properties will be moved into this tangle.

The tangle that is passed (src) will no longer be usable.

Parameters

src	the tangle to move.

Returns: a reference to this tangle.

◆ operator==()

bool regina::Tangle::operator== ( const Tangle & other ) const

Determines if this tangle is combinatorially identical to the given tangle.

Here "identical" means that:

the tangles are of the same type and have the same number of crossings;
the same numbered crossings are positive and negative in both tangles;
the corresponding strings in each tangle pass through the same under/over-strands of the same numbered crossings in the same order.

Parameters

other the tangle to compare with this.

Returns: true if and only if the two tangles are combinatorially identical.

◆ orientedGauss() [1/2]

std::string regina::Tangle::orientedGauss ( ) const

Outputs an oriented Gauss code for this tangle.

Oriented Gauss codes for tangles are an extension of oriented Gauss codes for knots. Whilst oriented Gauss codes for knots are used elsewhere (they are based on a format used by Andreeva et al.), these codes for tangles are specific to Regina (so you should not expect other software to understand them).

For a full explanation of how oriented Gauss codes work for tangles, see the documentation for fromOrientedGauss(const std::string&), which imports tangles in this format.

The string that is returned will not contain any newlines.

Note: There is another variant of this routine that, instead of returning a string, writes directly to an output stream.

Returns: an oriented Gauss code for this tangle.

◆ orientedGauss() [2/2]

void regina::Tangle::orientedGauss ( std::ostream & out ) const

Writes an oriented Gauss code for this tangle to the given output stream.

Oriented Gauss codes for tangles are an extension of oriented Gauss codes for knots. Whilst oriented Gauss codes for knots are used elsewhere (they are based on a format used by Andreeva et al.), these codes for tangles are specific to Regina (so you should not expect other software to understand them).

For a full explanation of how oriented Gauss codes work for tangles, see the documentation for fromOrientedGauss(const std::string&), which imports tangles in this format.

The output will not contain any newlines.

Note: There is another variant of this routine that, instead of using an output stream, simply returns a string.

Python: This routine is not available in Python. Instead, Python users can use the variant orientedGauss(), which takes no arguments and returns the output as a string.

Parameters

out	the output stream to which to write.

◆ r1()

bool regina::Tangle::r1	(	Crossing *	crossing,
		bool	check = `true`,
		bool	perform = `true`
	)

Tests for and/or performs a type I Reidemeister move to remove a crossing.

Unlike links, which implement the full suite of Reidemeister moves, tangles (at present) only offer the simplifying versions of Reidemeister moves I and II.

The behaviour of this routine is identical to the r1() routine in the Link class; see Link::r1() for further details.

Precondition: If perform is true but check is false, then it must be known in advance that this move can be performed at the given location.; The given crossing is either a null pointer, or else some crossing in this tangle.

Parameters

crossing	identifies the crossing to be removed.
check	`true` if we are to check whether the move can be performed at the given location.
perform	`true` if we should actually perform the move.

Returns: If check is true, this function returns true if and only if the move can be performed. If check is false, this function always returns true.

◆ r2() [1/2]

bool regina::Tangle::r2	(	Crossing *	crossing,
		bool	check = `true`,
		bool	perform = `true`
	)

inline

Tests for and/or performs a type II Reidemeister move to remove two crossings.

Unlike links, which implement the full suite of Reidemeister moves, tangles (at present) only offer the simplifying versions of Reidemeister moves I and II.

The behaviour of this routine is identical to the r2() routine in the Link class; see Link::r2() for further details.

Precondition: If perform is true but check is false, then it must be known in advance that this move can be performed at the given location.; The given crossing is either a null pointer, or else some crossing in this tangle.

Parameters

crossing	identifies the crossing at the beginning of the "upper" arc that features in this move.
check	`true` if we are to check whether the move is legal.
perform	`true` if we should actually perform the move.

Returns: If check is true, this function returns true if and only if the requested move is legal. If check is false, this function always returns true.

◆ r2() [2/2]

bool regina::Tangle::r2	(	StrandRef	arc,
		bool	check = `true`,
		bool	perform = `true`
	)

Tests for and/or performs a type II Reidemeister move to remove two crossings.

Unlike links, which implement the full suite of Reidemeister moves, tangles (at present) only offer the simplifying versions of Reidemeister moves I and II.

The behaviour of this routine is identical to the r2() routine in the Link class; see Link::r2() for further details.

Precondition: If perform is true but check is false, then it must be known in advance that this move can be performed at the given location.; The given strand reference is either a null reference, or else refers to some strand of some crossing in this tangle.

Parameters

arc	identifies one of the arcs of the bigon about which the move will be performed.
check	`true` if we are to check whether the move is legal.
perform	`true` if we should actually perform the move.

Returns: If check is true, this function returns true if and only if the requested move is legal. If check is false, this function always returns true.

◆ simplifyToLocalMinimum()

bool regina::Tangle::simplifyToLocalMinimum ( bool perform = true )

Uses type I and II Reidemeister moves to reduce the tangle monotonically to some local minimum number of crossings.

Type III Reidemeister moves (which do not reduce the number of crossings) are not used in this routine.

Unlike links, tangle do not (at present) offer stronger simplification routines (such as the much better Link::intelligentSimplify() and Link::simplifyExhaustive()).

Warning: The implementation of this routine (and therefore its results) may change between different releases of Regina.

Parameters

perform true if we are to perform the simplifications, or false if we are only to investigate whether simplifications are possible (defaults to true).

Returns: if perform is true, this routine returns true if and only if the link was changed to reduce the number of crossings; if perform is false, this routine returns true if and only if it determines that it is capable of performing such a change.

◆ size()

size_t regina::Tangle::size ( ) const

inline

Returns the number of crossings in this tangle.

Returns: the number of crossings.

◆ str()

std::string regina::Output< Tangle , false >::str ( ) const

inherited

Returns a short text representation of this object.

This text should be human-readable, should use plain ASCII characters where possible, and should not contain any newlines.

Within these limits, this short text ouptut should be as information-rich as possible, since in most cases this forms the basis for the Python str() and repr() functions.

Python: The Python "stringification" function str() will use precisely this function, and for most classes the Python repr() function will incorporate this into its output.

Returns: a short text representation of this object.

◆ swap()

void regina::Tangle::swap ( Tangle & other )

noexcept

Swaps the contents of this and the given tangle.

All crossings that belong to this tangle will be moved to other, and all crossings that belong to other will be moved to this tangle. Likewise, all cached properties will be swapped.

In particular, any Crossing pointers or references and any StrandRef objects will remain valid.

This routine will behave correctly if other is in fact this tangle.

Parameters

other the tangle whose contents should be swapped with this.

◆ swapContents()

void regina::Tangle::swapContents ( Tangle & other )

inlinenoexcept

Deprecated routine that swaps the contents of this and the given tangle.

Deprecated:: Use swap() instead.

Parameters

other the tangle whose contents should be swapped with this.

◆ translate()

StrandRef regina::Tangle::translate ( const StrandRef & other ) const

inline

Translates a strand reference for some other tangle into the corresponding strand reference for this tangle.

Specifically: if other refers to some strand (upper or lower) of crossing number k of some other tangle, then the return value will refer to the same strand (upper or lower) of crossing number k of this tangle.

This routine behaves correctly even if other is a null reference.

Parameters

other the strand reference to translate.

Returns: the corresponding strand reference for this tangle.

◆ turn()

void regina::Tangle::turn ( int direction = 1 )

Rotates this tangle by 90 degrees.

Parameters

direction either 1 if the tangle should be rotated clockwise, or -1 if the tangle should be rotated anticlockwise.

◆ twist()

void regina::Tangle::twist ( int sign = 1 )

Adds a twist to the right-hand end of this tangle.

Parameters

sign	either 1 if we should perform a positive twist (dragging the bottom-right endpoint up over the top-right endpoint), or -1 if we should perform a negative twist (dragging the bottom-right endpoint up beneath the top-right endpoint).

◆ type()

char regina::Tangle::type ( ) const

inline

Returns the type of this tangle.

This will be one of the characters -, | or x, indicating a horizontal, vertical or diagonal type as described in the class notes.

Returns: the type of this crossing.

◆ utf8()

std::string regina::Output< Tangle , false >::utf8 ( ) const

inherited

Returns a short text representation of this object using unicode characters.

Like str(), this text should be human-readable, should not contain any newlines, and (within these constraints) should be as information-rich as is reasonable.

Unlike str(), this function may use unicode characters to make the output more pleasant to read. The string that is returned will be encoded in UTF-8.

Returns: a short text representation of this object.

◆ writeTextLong()

void regina::Tangle::writeTextLong ( std::ostream & out ) const

Writes a detailed text representation of this tangle to the given output stream.

Python: Not present; use detail() instead.

Parameters

out	the output stream to which to write.

◆ writeTextShort()

void regina::Tangle::writeTextShort ( std::ostream & out ) const

Writes a short text representation of this tangle to the given output stream.

Python: Not present; use str() instead.

Parameters

out	the output stream to which to write.

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

link/tangle.h

Public Member Functions

Building Tangles

Detailed Description

Constructor & Destructor Documentation

◆ Tangle() [1/6]

◆ Tangle() [2/6]

◆ Tangle() [3/6]

◆ Tangle() [4/6]

◆ Tangle() [5/6]

◆ Tangle() [6/6]

◆ ~Tangle()

Member Function Documentation

◆ add()

◆ begin()

◆ box()

◆ brief() [1/2]

◆ brief() [2/2]

◆ changeAll()

◆ crossing()

◆ crossings()

◆ denClosure()

◆ detail()

◆ end()

◆ fromOrientedGauss() [1/2]

◆ fromOrientedGauss() [2/2]

◆ negate()

◆ numClosure()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ orientedGauss() [1/2]

◆ orientedGauss() [2/2]

◆ r1()

◆ r2() [1/2]

◆ r2() [2/2]

◆ simplifyToLocalMinimum()

◆ size()

◆ str()

◆ swap()

◆ swapContents()

◆ translate()

◆ turn()

◆ twist()

◆ type()

◆ utf8()

◆ writeTextLong()

◆ writeTextShort()