A do-nothing class that imposes no additional linear constraints on the tableaux of normal surface or angle structure matching equations. More...
#include <enumerate/treeconstraint.h>
Public Types | |
| using | Coefficient = int |
Static Public Member Functions | |
| static void | addRows (LPCol< regina::LPConstraintNone > *, const LPInitialTableaux< LPConstraintNone > &init) |
| template<typename IntType > | |
| static void | constrain (LPData< regina::LPConstraintNone, IntType > &, unsigned) |
| static bool | verify (const NormalSurface &) |
| static bool | verify (const AngleStructure &) |
| static bool | supported (NormalEncoding enc) |
| static void | addRows (LPCol< LPConstraintBase > *col, const LPInitialTableaux< LPConstraintBase > &init) |
| Explicitly constructs equations for the linear function(s) constrained by this class. More... | |
Static Public Attributes | |
| static constexpr int | nConstraints = 0 |
| static constexpr Coefficient | octAdjustment = 0 |
Detailed Description
A do-nothing class that imposes no additional linear constraints on the tableaux of normal surface or angle structure matching equations.
See the LPConstraintBase class notes for details on all member functions.
These linear constraint classes are designed mainly to act as C++ template arguments, and end users will typically not need to construct their own object of these classes. Instead, to use a linear constraint class, pass it as a template parameter to one of the tree traversal subclasses (e.g., TreeEnumeration, TreeSingleSolution, or TautEnumeration).
- Python
- It is rare that you would need to access this class directly through Python. Instead, to use this do-nothing constraint class, you would typically create a tree traversal object with no linear constraint class suffix at all (since LPConstraintNone is the default behaviour). For example, the Python classes
TreeEnumeration,TreeSingleSoln_BanBoundaryandTautEnumerationall use this do-nothing LPConstraintNone class. See the LPConstraintBase class notes for further details on accessing other types of linear constraints from within Python.
- Warning
- The API for this class has not yet been finalised. This means that the class interface may change in new versions of Regina, without maintaining backward compatibility. If you use this class directly in your own code, please watch the detailed changelogs upon new releases to see if you need to make changes to your code.
Member Function Documentation
◆ addRows()
|
staticinherited |
Explicitly constructs equations for the linear function(s) constrained by this class.
Specifically, this routine takes an array of columns in the initial tableaux and fills in the necessary coefficient data.
More precisely: recall that, for each linear function, the initial tableaux acquires one new variable x_i that evaluates this linear function f(x). This routine must create the corresponding row that sets f(x) - x_i = 0. Thus it must construct the coefficients of f(x) in the columns corresponding to normal coordinates, and it must also set a coefficient of -1 in the column for the corresponding new variable.
As described in the LPInitialTableaux class notes, it might not be possible to construct the linear functions (since the underlying triangulation might not satisfy the necessary requirements). In such cases this routine should throw an exception, as described below, and the corresponding constraint class must mention this possibility in its class documentation.
If you are implementing this routine in a subclass that works with angle structure coordinates, remember that your linear constraints must not interact with the scaling coordinate (the final angle structure coordinate that is used to projectivise the angle structure polytope into a polyhedral cone). Your implementation of this routine must ensure that your linear constraints all have coefficient zero in this column.
The precise form of the linear function(s) will typically depend upon the underlying triangulation, as well as the permutation that indicates which columns of the initial tableaux correspond to which normal or angle structure coordinates. All of this information is read from the given initial tableaux init.
Note that the tableaux init may still be under construction (and indeed, the column array col to be filled will typically be the internal column array from init itself). This routine should not read any of the tableaux entries; it should only access the underlying triangulation (LPInitialTableaux.tri()) and the permutation of columns (LPInitialTableaux.columnPerm()).
For each subclass Sub of LPConstraintBase, the array col must be an array of objects of type LPCol<Sub>, and the tableaux init must be of type LPInitialTableaux<Sub>.
This routine should only write to the coefficients stored in LPCol::extra. You may assume that these coefficients have all been initialised to zero by the LPCol constructor.
- Precondition
- For all columns in the array col, the members LPCol::extra have all been initialised to zero.
- Exceptions
-
InvalidArgument it was not possible to create the linear functions for these constraints, due to an error which should have been preventable with the right checks in advance. Any constraint class that could throw exceptions in this way must describe this behaviour in its own class documentation. UnsolvedCase it was not possible to create the linear functions for these constraints, due to an error that was "genuinely" unforseeable. Again, any constraint class that could throw exceptions in this way must describe this behaviour in its own class documentation.
- Python
- The argument col is not present, since LPCol is only designed to be used as part of the internal data storage for LPInitialTableaux. Instead, this routine returns a Python list of constraints, where each constraint is presented as a Python list of coefficients. Each of these inner lists will have size init.columns().
- Parameters
-
col the array of columns as stored in the initial tableaux (i.e., the data member LPInitialTableaux::col_). init the tableaux through which this routine can acces the underlying triangulation and permutation of columns. Typically this will be the tableaux holding the column array col.
The documentation for this class was generated from the following file:
- enumerate/treeconstraint.h