Regina Calculation Engine
Public Member Functions | Protected Member Functions | List of all members
regina::detail::FaceValidity< false, testLinks > Class Template Reference

Helper class that stores whether a face is valid. More...

#include <triangulation/detail/face.h>

Public Member Functions

bool isValid () const
 Always returns true. More...
 

Protected Member Functions

void markBadIdentification ()
 Marks this face as having a non-identity self-identification. More...
 
void markBadLink ()
 Marks this face as having a bad link. More...
 

Detailed Description

template<bool testLinks>
class regina::detail::FaceValidity< false, testLinks >

Helper class that stores whether a face is valid.

See the general FaceValidity template notes for further details.

This specialisation is used for dimensions in which faces are never invalid. It optimises away all the implementation details (since there is nothing to store and nothing to compute).

Member Function Documentation

◆ isValid()

template<bool testLinks>
bool regina::detail::FaceValidity< false, testLinks >::isValid ( ) const
inline

Always returns true.

In general, this routine determines whether a face is valid. However, this particular class is used for dimensions in which faces are always valid, and so this routine returns true always.

See FaceValidity<true, true>::isValid() for a general discussion on what it means for a face to be valid.

Returns
true.

◆ markBadIdentification()

template<bool testLinks>
void regina::detail::FaceValidity< false, testLinks >::markBadIdentification ( )
inlineprotected

Marks this face as having a non-identity self-identification.

This routine should never be called, since this specialisation of FaceValidity is for dimensions in which faces are always valid.

It is provided to support dimension-agnostic code, but its implementation does nothing.

◆ markBadLink()

template<bool testLinks>
void regina::detail::FaceValidity< false, testLinks >::markBadLink ( )
inlineprotected

Marks this face as having a bad link.

This routine should never be called, since this specialisation of FaceValidity is for dimensions in which faces are always valid.

It is provided to support dimension-agnostic code, but its implementation does nothing.


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