Regina Calculation Engine
Namespaces | Macros | Typedefs | Enumerations | Functions | Variables
regina-core.h File Reference

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

Namespaces

 regina
 Contains the entire Regina calculation engine.
 

Macros

#define REGINA_INLINE_REQUIRED   inline
 A synonym for inline, used in some special cases to avoid noisy warnings under Windows. More...
 
#define REGINA_API
 All non-templated, non-static functions, classes and global variables that are part of Regina's public interface must be declared with REGINA_API. More...
 
#define REGINA_LOCAL
 Classes and functions that are local to the current compilation unit and should not be publicly exported may be declared with REGINA_LOCAL. More...
 

Typedefs

typedef Algorithm regina::TuraevViroAlg
 Deprecated alias for Algorithm. More...
 

Enumerations

enum  regina::Algorithm { regina::ALG_DEFAULT = 0, regina::ALG_BACKTRACK = 1, regina::ALG_TREEWIDTH = 2, regina::ALG_NAIVE = 3 }
 Represents various classes of algorithms that Regina can use for computations. More...
 

Functions

constexpr bool regina::standardDim (int dim)
 Indicates whether the given dimension is one of Regina's standard dimensions. More...
 

Variables

constexpr Algorithm regina::TV_DEFAULT = ALG_DEFAULT
 Deprecated alias for ALG_DEFAULT. More...
 
constexpr Algorithm regina::TV_BACKTRACK = ALG_BACKTRACK
 Deprecated alias for ALG_BACKTRACK. More...
 
constexpr Algorithm regina::TV_TREEWIDTH = ALG_TREEWIDTH
 Deprecated alias for ALG_TREEWIDTH. More...
 
constexpr Algorithm regina::TV_NAIVE = ALG_NAIVE
 Deprecated alias for ALG_NAIVE. More...
 

Detailed Description

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


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