Regina 7.4 Calculation Engine
regina-core.h File Reference

Core definitions that must be included in every Regina header file. More...

#include "regina-config.h"

Classes

struct  regina::Unprotected
 An empty type that can be used to disable in-built safety checks in some specific circumstances. More...
 

Namespaces

namespace  regina
 Contains the entire Regina calculation engine.
 

Enumerations

enum class  regina::Algorithm { regina::Algorithm::Default = 0 , regina::Algorithm::Backtrack = 1 , regina::Algorithm::Treewidth = 2 , regina::Algorithm::Naive = 3 }
 Represents various classes of algorithms that Regina can use for computations. More...
 
enum class  regina::Language { regina::Language::Cxx = 1 , regina::Language::Python = 2 , regina::Language::Current = Cxx }
 Represents different programming languages that Regina supports. More...
 
enum class  regina::ChangeType { regina::General = 0 , regina::PreserveTopology = 1 , regina::Cosmetic = 2 }
 Indicates different ways in which code could change a topological object, such as a link or triangulation. More...
 

Functions

constexpr bool regina::standardDim (int dim)
 Indicates whether the given dimension is one of Regina's standard dimensions.
 
constexpr int regina::maxDim ()
 Indicates that largest dimension of triangulation that Regina can work with.
 

Variables

constexpr Algorithm regina::ALG_DEFAULT = Algorithm::Default
 A deprecated constant indicating one of the available classes of algorithm.
 
constexpr Algorithm regina::ALG_BACKTRACK = Algorithm::Backtrack
 A deprecated constant indicating one of the available classes of algorithm.
 
constexpr Algorithm regina::ALG_TREEWIDTH = Algorithm::Treewidth
 A deprecated constant indicating one of the available classes of algorithm.
 
constexpr Algorithm regina::ALG_NAIVE = Algorithm::Naive
 A deprecated constant indicating one of the available classes of algorithm.
 
constexpr Unprotected regina::unprotected
 An empty object that can be used to disable Regina's in-built safety checks in some specific circumstances.
 

Detailed Description

Core definitions that must be included in every Regina header file.