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

Describes the cellular decomposition of the sphere that is induced by a given planar 4-valent graph. More...

#include <link/modellinkgraph.h>

Inheritance diagram for regina::ModelLinkGraphCells:
regina::Output< ModelLinkGraphCells >

Public Member Functions

 ~ModelLinkGraphCells ()
 Destroys this cellular decomposition. More...
 
bool isValid () const
 Determines whether the underlying graph is non-empty with a planar embedding, assuming that it is already known to be connected. More...
 
size_t countCells () const
 Returns the number of 2-cells in this cellular decomposition. More...
 
const ModelLinkGraphArcarc (size_t cell, size_t which) const
 Returns the given arc along the boundary of the given 2-cell. More...
 
size_t size (size_t cell) const
 Returns the number of arcs aloung the boundary of the given 2-cell. More...
 
const ModelLinkGraphArcbegin (size_t cell) const
 Returns the beginning of an iterator range for walking around the boundary of the given 2-cell. More...
 
const ModelLinkGraphArcend (size_t cell) const
 Returns the end of an iterator range for walking around the boundary of the given 2-cell. More...
 
size_t cell (const ModelLinkGraphArc &arc) const
 Returns the 2-cell that lies to the left of the given arc. More...
 
size_t cellPos (const ModelLinkGraphArc &arc) const
 Returns where the given arc appears along the boundary of the 2-cell to its left. More...
 
void writeTextShort (std::ostream &out) const
 Writes a short text representation of this object to the given output stream. More...
 
void writeTextLong (std::ostream &out) const
 Writes a detailed text representation of this object to the given output stream. More...
 
ModelLinkGraphCellsoperator= (const ModelLinkGraphCells &)=delete
 
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...
 

Friends

class ModelLinkGraph
 

Detailed Description

Describes the cellular decomposition of the sphere that is induced by a given planar 4-valent graph.

The graph is represented by an object of type ModelLinkGraph, which also encodes a specific planar embedding of the graph. The nodes and arcs of this graph then form the vertices and edges of a cellular decomposition; the main purpose of this class is to deduce and describe the resulting 2-cells.

At present, this class insists that each 2-cell is a topological disc. As a consequence, this class cannot work with empty or disconnected graphs.

Member Function Documentation

◆ detail()

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

◆ str()

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

Returns a short text representation of this object.

This text should be human-readable, should fit on a single line, and should not end with a newline. Where possible, it should use plain ASCII characters.

Python
In addition to str(), this is also used as the Python "stringification" function str().
Returns
a short text representation of this object.

◆ utf8()

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

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

Like str(), this text should be human-readable, should fit on a single line, and should not end with a newline. In addition, it may use unicode characters to make the output more pleasant to read. This string will be encoded in UTF-8.

Returns
a short text representation of this object.

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

Copyright © 1999-2021, 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@maths.uq.edu.au).