Represents a layered chain pair component of a triangulation. More...

#include <subcomplex/layeredchainpair.h>

Inheritance diagram for regina::LayeredChainPair:

Public Member Functions
	LayeredChainPair (const LayeredChainPair &)=default
	Creates a new copy of this structure. More...

LayeredChainPair &	operator= (const LayeredChainPair &)=default
	Sets this to be a copy of the given structure. More...

LayeredChainPair *	clone () const
	Deprecated routine that returns a new copy of this structure. More...

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

const LayeredChain &	chain (int which) const
	Returns the requested layered chain used to form this structure. More...

bool	operator== (const LayeredChainPair &other) const
	Determines whether this and the given structure represent the same type of layered chain pair. More...

bool	operator!= (const LayeredChainPair &other) const
	Determines whether this and the given structure represent different types of layered chain pair. More...

std::unique_ptr< Manifold >	manifold () const override
	Returns the 3-manifold represented by this triangulation, if such a recognition routine has been implemented. More...

AbelianGroup	homology () const override
	Returns the expected first homology group of this triangulation, if such a routine has been implemented. More...

std::ostream &	writeName (std::ostream &out) const override
	Writes the name of this triangulation as a human-readable string to the given output stream. More...

std::ostream &	writeTeXName (std::ostream &out) const override
	Writes the name of this triangulation in TeX format to the given output stream. More...

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

std::string	name () const
	Returns the name of this specific triangulation as a human-readable string. More...

std::string	texName () const
	Returns the name of this specific triangulation in TeX format. More...

std::string	TeXName () const
	Deprecated routine that returns the name of this specific triangulation in TeX format. More...

AbelianGroup	homologyH1 () const
	A deprecated alias for homology(). More...

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

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

Static Public Member Functions
static std::unique_ptr< LayeredChainPair >	recognise (const Component< 3 > *comp)
	Determines if the given triangulation component is a layered chain pair. More...

static std::unique_ptr< LayeredChainPair >	isLayeredChainPair (const Component< 3 > *comp)
	A deprecated alias to recognise if a component is a layered chain pair. More...

static std::unique_ptr< StandardTriangulation >	recognise (Component< 3 > *component)
	Determines whether the given component represents one of the standard triangulations understood by Regina. More...

static std::unique_ptr< StandardTriangulation >	recognise (const Triangulation< 3 > &tri)
	Determines whether the given triangulation represents one of the standard triangulations understood by Regina. More...

static std::unique_ptr< StandardTriangulation >	isStandardTriangulation (Component< 3 > *component)
	A deprecated alias to determine whether a component represents one of the standard triangulations understood by Regina. More...

static std::unique_ptr< StandardTriangulation >	isStandardTriangulation (const Triangulation< 3 > &tri)
	A deprecated alias to determine whether a triangulation represents one of the standard triangulations understood by Regina. More...

Detailed Description

Represents a layered chain pair component of a triangulation.

A layered chain pair consists of two layered chains (as described by class LayeredChain) glued together in a particular way.

Orient the hinge edges and diagonals of each chain so they all point in the same direction around the solid tori formed by each layered chain (a diagonal is an edge between the two top triangular faces or an edge between the two bottom triangular faces of a layered chain).

The two top faces of the first chain are glued to a top and bottom face of the second chain, and the two bottom faces of the first chain are glued to a top and bottom face of the second chain.

The four oriented diagonals are all identified as a single edge. Of the remaining unglued edges (two hinge edges and two non-hinge edges per chain), each hinge edge of one chain must be identified to a non-hinge edge of the other chain and vice versa. From here the face identifications are uniquely determined.

Note that a layered chain pair in which one of the chains contains only one tetrahedron is in fact a layered loop with a twist (see class LayeredLoop).

All optional StandardTriangulation routines are implemented for this class.

This class supports copying but does not implement separate move operations, since its internal data is so small that copying is just as efficient. It implements the C++ Swappable requirement via its own member and global swap() functions, for consistency with the other StandardTriangulation subclasses. Note that the only way to create these objects (aside from copying or moving) is via the static member function recognise().

Constructor & Destructor Documentation

◆ LayeredChainPair()

regina::LayeredChainPair::LayeredChainPair ( const LayeredChainPair & )

default

Creates a new copy of this structure.

Member Function Documentation

◆ chain()

const LayeredChain & regina::LayeredChainPair::chain ( int which ) const

inline

Returns the requested layered chain used to form this structure.

If the two chains have different lengths, the shorter chain will be chain 0 and the longer chain will be chain 1.

Parameters

which specifies which chain to return; this must be 0 or 1.

Returns: the requested layered chain.

◆ clone()

LayeredChainPair * regina::LayeredChainPair::clone ( ) const

inline

Deprecated routine that returns a new copy of this structure.

Deprecated:: Just use the copy constructor instead.

Returns: a newly created clone.

◆ detail()

std::string regina::Output< StandardTriangulation , 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.

◆ homology()

AbelianGroup regina::LayeredChainPair::homology ( ) const

overridevirtual

Returns the expected first homology group of this triangulation, if such a routine has been implemented.

This routine does not work by calling Triangulation<3>::homology() on the associated real triangulation. Instead the homology is calculated directly from the known properties of this standard triangulation.

This means that homology() needs to be implemented separately for each class of standard triangulation. See the class notes for each subclass of StandardTriangulation for details on whether homology has been implemented for that particular subclass. The default implementation of this routine just throws a NotImplemented exception.

Most users will not need this routine, since presumably you already have an explicit Triangulation<3> available and so you can just call Triangulation<3>::homology() instead (which, unlike this routine, is always implemented). This StandardTriangulation::homology() routine should be seen as more of a verification/validation tool for the Regina developers.

If this StandardTriangulation describes an entire Triangulation<3> (and not just a part thereof) then the results of this routine should be identical to the homology group obtained by calling Triangulation<3>::homology() upon the associated real triangulation.

Exceptions

NotImplemented	homology calculation has not yet been implemented for this particular type of standard triangulation.
FileError	the homology needs to be read from file (as opposed to computed), but the file is inaccessible or its contents cannot be read and parsed correctly. Currently this can only happen for the subclass SnapPeaCensusTri, which reads its results from the SnapPea census databases that are installed with Regina.

Returns: the first homology group of this triangulation, if this functionality has been implemented.

Reimplemented from regina::StandardTriangulation.

◆ homologyH1()

AbelianGroup regina::StandardTriangulation::homologyH1 ( ) const

inlineinherited

A deprecated alias for homology().

Deprecated:: This routine can be accessed by the simpler name homology().

Exceptions

NotImplemented homology calculation has not yet been implemented for this particular type of standard triangulation.

Returns: the first homology group of this triangulation, if this functionality has been implemented.

◆ isLayeredChainPair()

std::unique_ptr< LayeredChainPair > regina::LayeredChainPair::isLayeredChainPair ( const Component< 3 > * comp )

inlinestatic

A deprecated alias to recognise if a component is a layered chain pair.

Deprecated:: This function has been renamed to recognise(). See recognise() for details on the parameters and return value.

◆ isStandardTriangulation() [1/2]

std::unique_ptr< StandardTriangulation > regina::StandardTriangulation::isStandardTriangulation ( Component< 3 > * component )

inlinestaticinherited

A deprecated alias to determine whether a component represents one of the standard triangulations understood by Regina.

Deprecated:: This function has been renamed to recognise(). See recognise() for details on the parameters and return value.

◆ isStandardTriangulation() [2/2]

std::unique_ptr< StandardTriangulation > regina::StandardTriangulation::isStandardTriangulation ( const Triangulation< 3 > & tri )

inlinestaticinherited

A deprecated alias to determine whether a triangulation represents one of the standard triangulations understood by Regina.

Deprecated:: This function has been renamed to recognise(). See recognise() for details on the parameters and return value.

◆ manifold()

std::unique_ptr< Manifold > regina::LayeredChainPair::manifold ( ) const

overridevirtual

Returns the 3-manifold represented by this triangulation, if such a recognition routine has been implemented.

If the 3-manifold cannot be recognised then this routine will return null.

The details of which standard triangulations have 3-manifold recognition routines can be found in the notes for the corresponding subclasses of StandardTriangulation. The default implementation of this routine returns null.

It is expected that the number of triangulations whose underlying 3-manifolds can be recognised will grow between releases.

Returns: the underlying 3-manifold.

Reimplemented from regina::StandardTriangulation.

◆ name()

std::string regina::StandardTriangulation::name ( ) const

inherited

Returns the name of this specific triangulation as a human-readable string.

Returns: the name of this triangulation.

◆ operator!=()

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

inline

Determines whether this and the given structure represent different types of layered chain pair.

Specifically, two layered chain pairs will compare as equal if and only if they their constituent layered chains each have the same respective lengths, and appear in the same order.

This test follows the general rule for most subclasses of StandardTriangulation (excluding fixed structures such as SnappedBall and TriSolidTorus): two objects compare as equal if and only if they have the same combinatorial parameters (which for this subclass is more specific than combinatorial isomorphism, due to the ordering requirement).

Parameters

other the structure with which this will be compared.

Returns: true if and only if this and the given structure represent different types of layered chain pair.

◆ operator=()

LayeredChainPair & regina::LayeredChainPair::operator= ( const LayeredChainPair & )

default

Sets this to be a copy of the given structure.

Returns: a reference to this structure.

◆ operator==()

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

inline

Determines whether this and the given structure represent the same type of layered chain pair.

Specifically, two layered chain pairs will compare as equal if and only if they their constituent layered chains each have the same respective lengths, and appear in the same order.

This test follows the general rule for most subclasses of StandardTriangulation (excluding fixed structures such as SnappedBall and TriSolidTorus): two objects compare as equal if and only if they have the same combinatorial parameters (which for this subclass is more specific than combinatorial isomorphism, due to the ordering requirement).

Parameters

other the structure with which this will be compared.

Returns: true if and only if this and the given structure represent the same type of layered chain pair.

◆ recognise() [1/3]

static std::unique_ptr< StandardTriangulation > regina::StandardTriangulation::recognise ( Component< 3 > * component )

staticinherited

Determines whether the given component represents one of the standard triangulations understood by Regina.

The list of recognised triangulations is expected to grow between releases.

If the standard triangulation returned has boundary triangles then the given component must have the same corresponding boundary triangles, i.e., the component cannot have any further identifications of these boundary triangles with each other.

Note that the triangulation-based routine recognise(const Triangulation<3>&) may recognise more triangulations than this routine, since passing an entire triangulation allows access to more information.

Parameters

component the triangulation component under examination.

Returns: the details of the standard triangulation if the given component is recognised, or null otherwise.

◆ recognise() [2/3]

static std::unique_ptr< LayeredChainPair > regina::LayeredChainPair::recognise ( const Component< 3 > * comp )

static

Determines if the given triangulation component is a layered chain pair.

This function returns by (smart) pointer for consistency with StandardTriangulation::recognise(), which makes use of the polymorphic nature of the StandardTriangulation class hierarchy.

Parameters

comp	the triangulation component to examine.

Returns: a structure containing details of the layered chain pair, or null if the given component is not a layered chain pair.

◆ recognise() [3/3]

static std::unique_ptr< StandardTriangulation > regina::StandardTriangulation::recognise ( const Triangulation< 3 > & tri )

staticinherited

Determines whether the given triangulation represents one of the standard triangulations understood by Regina.

The list of recognised triangulations is expected to grow between releases.

If the standard triangulation returned has boundary triangles then the given triangulation must have the same corresponding boundary triangles, i.e., the triangulation cannot have any further identifications of these boundary triangles with each other.

This routine may recognise more triangulations than the component-based recognise(Component<3>*), since passing an entire triangulation allows access to more information.

Parameters

tri	the triangulation under examination.

Returns: the details of the standard triangualation if the given triangulation is recognised, or null otherwise.

◆ str()

std::string regina::Output< StandardTriangulation , 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::LayeredChainPair::swap ( LayeredChainPair & other )

inlinenoexcept

Swaps the contents of this and the given structure.

Parameters

other the structure whose contents should be swapped with this.

◆ texName()

std::string regina::StandardTriangulation::texName ( ) const

inherited

Returns the name of this specific triangulation in TeX format.

No leading or trailing dollar signs will be included.

Warning: The behaviour of this routine has changed as of Regina 4.3; in earlier versions, leading and trailing dollar signs were provided.

Returns: the name of this triangulation in TeX format.

◆ TeXName()

std::string regina::StandardTriangulation::TeXName ( ) const

inlineinherited

Deprecated routine that returns the name of this specific triangulation in TeX format.

Deprecated:: This routine has been renamed to texName().

Returns: the name of this triangulation in TeX format.

◆ utf8()

std::string regina::Output< StandardTriangulation , 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.

◆ writeName()

std::ostream & regina::LayeredChainPair::writeName ( std::ostream & out ) const

inlineoverridevirtual

Writes the name of this triangulation as a human-readable string to the given output stream.

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

Parameters

out	the output stream to which to write.

Returns: a reference to the given output stream.

Implements regina::StandardTriangulation.

◆ writeTeXName()

std::ostream & regina::LayeredChainPair::writeTeXName ( std::ostream & out ) const

inlineoverridevirtual

Writes the name of this triangulation in TeX format to the given output stream.

No leading or trailing dollar signs will be included.

Warning: The behaviour of this routine has changed as of Regina 4.3; in earlier versions, leading and trailing dollar signs were provided.

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

Parameters

out	the output stream to which to write.

Returns: a reference to the given output stream.

Implements regina::StandardTriangulation.

◆ writeTextLong()

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

inlineoverridevirtual

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

This may be reimplemented by subclasses, but the parent StandardTriangulation class offers a reasonable default implementation based on writeTextShort().

Python: Not present; use detail() instead.

Parameters

out	the output stream to which to write.

Reimplemented from regina::StandardTriangulation.

◆ writeTextShort()

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

inlinevirtualinherited

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

This may be reimplemented by subclasses, but the parent StandardTriangulation class offers a reasonable default implementation based on writeName().

Python: Not present; use str() instead.

Parameters

out	the output stream to which to write.

Reimplemented in regina::LayeredChain, regina::LayeredSolidTorus, regina::SnappedBall, regina::SpiralSolidTorus, and regina::TriSolidTorus.

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

subcomplex/layeredchainpair.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LayeredChainPair()

Member Function Documentation

◆ chain()

◆ clone()

◆ detail()

◆ homology()

◆ homologyH1()

◆ isLayeredChainPair()

◆ isStandardTriangulation() [1/2]

◆ isStandardTriangulation() [2/2]

◆ manifold()

◆ name()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ recognise() [1/3]

◆ recognise() [2/3]

◆ recognise() [3/3]

◆ str()

◆ swap()

◆ texName()

◆ TeXName()

◆ utf8()

◆ writeName()

◆ writeTeXName()

◆ writeTextLong()

◆ writeTextShort()