regina::HyperInfo Class Reference

A class used to query general information about different normal hypersurface coordinate systems. More...

#include <hypersurface/hypercoords.h>

Static Public Member Functions
static constexpr const char *	name (HyperCoords coordSystem)
	Returns the human-readable name of the given coordinate system. More...

Detailed Description

A class used to query general information about different normal hypersurface coordinate systems.

This class has become much simpler and more stripped-down since Regina 7.0. Much of the functionality that was available in this class in Regina 6.0.1 and earlier can now be accessed through the new HyperEncoding class.

Member Function Documentation

name()

static constexpr const char * regina::HyperInfo::name ( HyperCoords  coordSystem )

inlinestaticconstexpr

Returns the human-readable name of the given coordinate system.

The first letter of the returned string will be upper-case, and all subsequent letters will be lower-case.

This routine is guaranteed to return a non-null string, even if coordSystem is not one of the HyperCoords enum values.

Parameters

coordSystem

the coordinate system being queried; this may be any of the HyperCoords enumeration values.

Returns

the name of the given coordinate system.

---

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

• hypersurface/hypercoords.h