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

Contains a triangulation of a saturated block along with the accompanying saturated block description. More...

#include <subcomplex/satblockstarter.h>

Inheritance diagram for regina::SatBlockStarter:

Public Member Functions

 ~SatBlockStarter ()
 Destroys both the internal triangulation and block structure. More...
 
const Triangulation< 3 > & triangulation () const
 Returns a reference to the triangulation of the saturated block. More...
 
const SatBlockblock () const
 Returns details that describe the structure of the saturated block. More...
 

Friends

class SatBlockStarterSet
 

Detailed Description

Contains a triangulation of a saturated block along with the accompanying saturated block description.

Different objects of this class will correspond to different types of saturated block.

This is a support class for SatBlockStarterSet, and as such it is a read-only class to the rest of the world.

This class is well-suited for subcomplex testing: if the triangulation here is found to be a subcomplex of some larger triangulation (see Triangulation<3>::isContainedIn()), then the corresponding isomorphism can be used to copy this block structure and transform it to describe the corresponding block in the larger triangulation.

As such, one of the core uses of this class is as a starting point for identifying regions within triangulations that are formed by joining saturated blocks together along their boundary annuli. See the routines SatBlockStarterSearcher::findStarterBlocks() and SatRegion::expand() for implementations of this.

Python:
Not present.

Constructor & Destructor Documentation

§ ~SatBlockStarter()

regina::SatBlockStarter::~SatBlockStarter ( )
inline

Destroys both the internal triangulation and block structure.

Member Function Documentation

§ block()

const SatBlock * regina::SatBlockStarter::block ( ) const
inline

Returns details that describe the structure of the saturated block.

Returns
the block structure.

§ triangulation()

const Triangulation< 3 > & regina::SatBlockStarter::triangulation ( ) const
inline

Returns a reference to the triangulation of the saturated block.

Returns
the block triangulation.

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

Copyright © 1999-2016, 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).