Helper class that provides core functionality for a connected component of a dim-manifold triangulation. More...

#include <triangulation/detail/component.h>

Inheritance diagram for regina::detail::ComponentBase< dim >:

Public Member Functions
size_t	index () const
	Returns the index of this component within the underlying triangulation. More...

size_t	size () const
	Returns the number of top-dimensional simplices in this component. More...

const std::vector< Simplex< dim > * > &	simplices () const
	Returns all top-dimensional simplices in this component. More...

Simplex< dim > *	simplex (size_t index) const
	Returns the top-dimensional simplex at the given index in this component. More...

size_t	countBoundaryComponents () const
	Returns the number of boundary components in this component. More...

const std::vector< BoundaryComponent< dim > * > &	boundaryComponents () const
	Returns all boundary components in this component. More...

BoundaryComponent< dim > *	boundaryComponent (size_t index) const
	Returns the boundary component at the given index in this component. More...

bool	isValid () const
	Determines if this component is valid. More...

bool	isOrientable () const
	Determines if this component is orientable. More...

bool	hasBoundaryFacets () const
	Determines if this component has any boundary facets. More...

size_t	countBoundaryFacets () const
	Returns the number of boundary facets in this component. 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...

	ComponentBase (const ComponentBase &)=delete

ComponentBase &	operator= (const ComponentBase &)=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...

size_t	markedIndex () const
	Returns the index at which this object is stored in an MarkedVector. More...

Protected Member Functions
	ComponentBase ()
	Default constructor. More...

Protected Attributes
bool	valid_
	Is this component valid? See Triangulation<dim>::isValid() for details on what this means. More...

Friends
class	Triangulation< dim >

class	TriangulationBase< dim >

Detailed Description

template<int dim>
class regina::detail::ComponentBase< dim >

Helper class that provides core functionality for a connected component of a dim-manifold triangulation.

Each connected component is represented by the class Component<dim>, which uses this as a base class. End users should not need to refer to ComponentBase directly.

See the Component class notes for further information.

Python: This base class is not present, but the "end user" class Component<dim> is.

Template Parameters

dim	the dimension of the underlying triangulation. This must be between 2 and 15 inclusive.

Member Function Documentation

◆ detail()

std::string regina::Output< ComponentBase< dim > , 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< ComponentBase< dim > , 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< ComponentBase< dim > , 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:

triangulation/detail/component.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<int dim> class regina::detail::ComponentBase< dim >

Member Function Documentation

◆ detail()

◆ str()

◆ utf8()

template<int dim>
class regina::detail::ComponentBase< dim >