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

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

#include <triangulation/alias/isomorphism.h>

Public Member Functions

ssize_t & triImage (size_t sourceSimp)
 A dimension-specific alias for simpImage(). More...
 
ssize_t triImage (size_t sourceSimp) const
 A dimension-specific alias for simpImage(). More...
 
void setTriImage (size_t sourceSimp, ssize_t image)
 A dimension-specific alias for setSimpImage(). More...
 
Perm< 3 > & edgePerm (size_t sourceSimp)
 A dimension-specific alias for facetPerm(). More...
 
Perm< 3 > edgePerm (size_t sourceSimp) const
 A dimension-specific alias for facetPerm(). More...
 
void setEdgePerm (size_t sourceSimp, Perm< 3 > perm)
 A dimension-specific alias for setFacetPerm(). More...
 

Detailed Description

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

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

This is inherited by the class Derived, which must provide functions of the form int& simpImage(size_t), int simpImage(size_t) const, Perm<dim+1>& facetPerm(size_t) and Perm<dim+1> facetPerm(size_t) const.

Member Function Documentation

◆ edgePerm() [1/2]

template<class Derived >
Perm< 3 > & regina::alias::IsomorphismImage< Derived, 2 >::edgePerm ( size_t  sourceSimp)
inline

A dimension-specific alias for facetPerm().

See facetPerm() for further information.

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

◆ edgePerm() [2/2]

template<class Derived >
Perm< 3 > regina::alias::IsomorphismImage< Derived, 2 >::edgePerm ( size_t  sourceSimp) const
inline

A dimension-specific alias for facetPerm().

See facetPerm() for further information.

◆ setEdgePerm()

template<class Derived >
void regina::alias::IsomorphismImage< Derived, 2 >::setEdgePerm ( size_t  sourceSimp,
Perm< 3 >  perm 
)

A dimension-specific alias for setFacetPerm().

See setFacetPerm() for further information.

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

◆ setTriImage()

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

A dimension-specific alias for setSimpImage().

See setSimpImage() for further information.

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

◆ triImage() [1/2]

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

A dimension-specific alias for simpImage().

See simpImage() for further information.

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

◆ triImage() [2/2]

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

A dimension-specific alias for simpImage().

See simpImage() for further information.


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