Regina 7.3 Calculation Engine
Public Member Functions | List of all members
regina::alias::IsomorphismImage< Derived, 4 > Class Template Reference

Helper class that provides dimension-specific aliases for both const and non-const versions of simpImage(size_t). More...

#include <triangulation/alias/isomorphism.h>

Public Member Functions

ssize_t & pentImage (size_t sourceSimp)
 A dimension-specific alias for simpImage(). More...
 
ssize_t pentImage (size_t sourceSimp) const
 A dimension-specific alias for simpImage(). More...
 
void setPentImage (size_t sourceSimp, ssize_t image)
 A dimension-specific alias for setSimpImage(). More...
 

Detailed Description

template<class Derived>
class regina::alias::IsomorphismImage< Derived, 4 >

Helper class that provides dimension-specific aliases for both const and non-const versions of simpImage(size_t).

This is inherited by the class Derived, which must provide functions of the form int& simpImage(size_t) and int simpImage(size_t) const.

Member Function Documentation

◆ pentImage() [1/2]

template<class Derived >
ssize_t & regina::alias::IsomorphismImage< Derived, 4 >::pentImage ( size_t  sourceSimp)
inline

A dimension-specific alias for simpImage().

See simpImage() for further information.

Python
Not present. For Python users, pentImage() is a read-only function that returns by value. For write access, use the Python-only routine setPentImage() instead.

◆ pentImage() [2/2]

template<class Derived >
ssize_t regina::alias::IsomorphismImage< Derived, 4 >::pentImage ( size_t  sourceSimp) const
inline

A dimension-specific alias for simpImage().

See simpImage() for further information.

◆ setPentImage()

template<class Derived >
void regina::alias::IsomorphismImage< Derived, 4 >::setPentImage ( size_t  sourceSimp,
ssize_t  image 
)

A dimension-specific alias for setSimpImage().

See setSimpImage() for further information.

C++
Not present. For C++ users, pentImage() is used for both reading and writing: just write pentImage(sourceSimp) = image.

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

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