snappy 3.2__cp310-cp310-macosx_10_12_x86_64.whl

snappy/verify/canonical.py

@@ -0,0 +1,542 @@
+from ..sage_helper import _within_sage, sage_method
+
+from ..geometric_structure.cusp_neighborhood.real_cusp_cross_section import RealCuspCrossSection
+from ..snap.t3mlite import simplex
+
+from .square_extensions import find_shapes_as_complex_sqrt_lin_combinations
+from . import edge_equations
+from . import hyperbolicity
+from . import exceptions
+from ..exceptions import SnapPeaFatalError
+
+if _within_sage:
+    from sage.rings.complex_interval_field import ComplexIntervalField
+    from ..pari import prec_dec_to_bits, prec_bits_to_dec
+
+__all__ = [
+    'FindExactShapesError',
+    'interval_checked_canonical_triangulation',
+    'exactly_checked_canonical_retriangulation',
+    'verified_canonical_retriangulation',
+    'default_interval_bits_precs',
+    'default_exact_bits_prec_and_degrees']
+
+default_interval_bits_precs = [53, 212]
+default_exact_bits_prec_and_degrees = [( 212, 10),
+                                       (1000, 20),
+                                       (2000, 20)]
+
+_num_tries_kernel_canonize = 3
+_max_tries_verify_penalty = 9
+
+
+class FindExactShapesError(RuntimeError):
+    """
+    Raised when snap failed to find the exact shapes using the LLL-algorithm
+    for a manifold.
+    """
+
+
+@sage_method
+def interval_checked_canonical_triangulation(M, bits_prec=None):
+    """
+    Given a canonical triangulation of a cusped (possibly non-orientable)
+    manifold M, return this triangulation if it has tetrahedral cells and can
+    be verified using interval arithmetics with the optional, given precision.
+    Otherwise, raises an Exception.
+
+    It fails when we call it on something which is not the canonical
+    triangulation::
+
+       sage: from snappy import Manifold
+       sage: M = Manifold("m015")
+       sage: interval_checked_canonical_triangulation(M) # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
+       Traceback (most recent call last):
+       ...
+       TiltProvenPositiveNumericalVerifyError: Numerical verification that tilt is negative has failed, tilt is actually positive. This is provably not the proto-canonical triangulation: 0.164542163...? <= 0
+
+    It verifies the canonical triangulation::
+
+       sage: M.canonize()
+       sage: K = interval_checked_canonical_triangulation(M)
+       sage: K
+       m015(0,0)
+
+    Has a non-tetrahedral canonical cell::
+
+      sage: M = Manifold("m137")
+      sage: M.canonize()
+      sage: interval_checked_canonical_triangulation(M) # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
+      Traceback (most recent call last):
+      ...
+      TiltInequalityNumericalVerifyError: Numerical verification that tilt is negative has failed: 0.?e-1... < 0
+
+    Has a cubical canonical cell::
+
+       sage: M = Manifold("m412")
+       sage: M.canonize()
+       sage: interval_checked_canonical_triangulation(M) # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
+       Traceback (most recent call last):
+       ...
+       TiltInequalityNumericalVerifyError: Numerical verification that tilt is negative has failed: 0.?e-1... < 0
+
+    """
+
+    # Get verified shape intervals
+    shapes = M.tetrahedra_shapes('rect', intervals=True,
+                                 bits_prec=bits_prec)
+
+    # Compute cusp cross sections
+    c = RealCuspCrossSection.fromManifoldAndShapes(M, shapes)
+
+    # Use interval arithmetics to verify hyperbolicity
+    hyperbolicity.check_logarithmic_gluing_equations_and_positively_oriented_tets(
+        M, shapes)
+
+    # Normalize cusp area. This is not needed when only 1 cusp
+    if M.num_cusps() > 1:
+        c.normalize_cusps()
+
+    # Compute tilts
+    c.compute_tilts()
+
+    # Make sure all tilts are negative
+    for face in c.mcomplex.Faces:
+        # Raise different exceptions to indicate whether we have proven
+        # that there are positive tilt or whether the intervals couldn't
+        # prove that they are negative
+        if face.Tilt > 0:
+            # If we can prove there is a positive tilt, raise this
+            # exception. Clients thus know that this is not a proto-canonical
+            # triangulations.
+            raise exceptions.TiltProvenPositiveNumericalVerifyError(face.Tilt)
+
+        if not (face.Tilt < 0):
+            # We failed to show it is negative. This might be because a tilt
+            # is zero or because we lost precision and even though the true
+            # value is negative, the interval we have contains positive
+            # numbers as well.
+            raise exceptions.TiltInequalityNumericalVerifyError(face.Tilt)
+
+    # Return M
+    return M
+
+
+@sage_method
+def exactly_checked_canonical_retriangulation(M, bits_prec, degree):
+    """
+    Given a proto-canonical triangulation of a cusped (possibly non-orientable)
+    manifold M, return its canonical retriangulation which is computed from
+    exact shapes. The exact shapes are computed using snap (which uses the
+    LLL-algorithm). The precision (in bits) and the maximal degree need to be
+    specified (here 300 bits precision and polynomials of degree less than 4)::
+
+       sage: from snappy import Manifold
+       sage: M = Manifold("m412")
+       sage: M.canonize()
+       sage: K = exactly_checked_canonical_retriangulation(M, 300, 4)
+
+    M's canonical cell decomposition has a cube, so non-tetrahedral::
+
+       sage: K.has_finite_vertices()
+       True
+
+    Has 12 tetrahedra after the retrianglation::
+
+      sage: K.num_tetrahedra()
+      12
+
+    Check that it fails on something which is not a proto-canonical
+    triangulation::
+
+      sage: from snappy import Manifold
+      sage: M = Manifold("m015")
+      sage: exactly_checked_canonical_retriangulation(M, 500, 6)  # doctest: +IGNORE_EXCEPTION_DETAIL
+      Traceback (most recent call last):
+      ...
+      TiltProvenPositiveNumericalVerifyError: Numerical verification that tilt is negative has failed, tilt is actually positive. This is provably not the proto-canonical triangulation: 0.1645421638874662848910671879? <= 0
+    """
+
+    # Convert to decimal precision
+    dec_prec = prec_bits_to_dec(bits_prec)
+
+    # Try to find the exact shapes
+    shapes = find_shapes_as_complex_sqrt_lin_combinations(M, dec_prec, degree)
+    if not shapes:
+        raise FindExactShapesError()
+
+    # Build the cusp cross section
+    c = RealCuspCrossSection.fromManifoldAndShapes(M, shapes)
+
+    # Check that the exact solutions form a complete hyperbolic structure
+    # We convert to intervals to check that the shapes are positive and
+    # the angles add up to 2pi and not some other multiple of 2pi.
+    edge_equations.check_polynomial_edge_equations_exactly(c.mcomplex)
+    c.check_cusp_development_exactly()
+    CIF = ComplexIntervalField(bits_prec)
+    edge_equations.check_logarithmic_edge_equations_and_positivity(c.mcomplex, CIF)
+
+    # Normalize cusp area. This is not needed when only 1 cusp
+    if M.num_cusps() > 1:
+        c.normalize_cusps()
+
+    # Compute tilts
+    c.compute_tilts()
+
+    # Get the opacity of a face in the proto-canonical triangulation
+    def get_opacity(tilt):
+        # Get the tilt of the sign. The sign method is implemented
+        # to use exact arithmetic to certify that the sign is 0 and
+        # to use interval arithmetic (of increasing precision until a decision
+        # can be made) to certify the sign otherwise.
+        sign, interval = tilt.sign_with_interval()
+
+        # Tilt is negative, return True
+        if sign < 0:
+            return True
+
+        # Tilt is zero, return False
+        if sign == 0:
+            return False
+
+        # Tilt is positive, raise exception
+        if sign > 0:
+            raise exceptions.TiltProvenPositiveNumericalVerifyError(interval)
+
+    def index_of_face_corner(corner):
+        face_index = simplex.comp(corner.Subsimplex).bit_length() - 1
+        return 4 * corner.Tetrahedron.Index + face_index
+
+    # Opacities of all four faces of each tetrahedron, initialize with None.
+    # The format is opacity of face 0, 1, 2, 3 of the first tetrahedron,
+    # ... of second tetrahedron, ...
+    opacities = (4 * len(c.mcomplex.Tetrahedra)) * [ None ]
+
+    # For each face of the triangulation
+    for face in c.mcomplex.Faces:
+        opacity = get_opacity(face.Tilt)
+        for corner in face.Corners:
+            opacities[index_of_face_corner(corner)] = opacity
+
+    if None in opacities:
+        raise Exception("Mismatch with opacities")
+
+    # If there are transparent faces, the given triangulation is just the
+    # proto-canonical triangulation. We need to call into the SnapPea
+    # kernel to retriangulate (introduces finite vertices)
+    if not all(opacities):
+        return M._canonical_retriangulation(opacities)
+
+    # No transparent faces, this triangulation itself is the canonical cell
+    # decomposition.
+    # Return it without introducing finite vertices.
+    return M
+
+
+def _retrying_canonize(M) -> None:
+    """
+    Wrapper for SnapPea kernel's function to compute the proto-canonical
+    triangulation in place. It will retry the kernel function if it fails.
+    Raises an exception if it did not succeed eventually.
+    """
+    err = ValueError('_num_tries_canonize is not positive.')
+
+    for i in range(_num_tries_kernel_canonize):
+        try:
+            M.canonize()
+            return
+        except (RuntimeError, SnapPeaFatalError) as e:
+            err = e
+            M.randomize()
+    raise err
+
+def _retrying_high_precision_canonize(M):
+    """
+    Wrapper for SnapPea kernel's function to compute the proto-canonical
+    triangulation. It will retry the kernel function if it fails, switching
+    to the quad-double implementation.
+    Returns the proto-canonical triangulation if the kernel function was
+    successful eventually. Otherwise, raises an exception.
+    The original manifold is unchanged.
+    """
+
+    from .. import ManifoldHP
+
+    # Make a copy of the manifold
+    Mcopy = M.copy()
+
+    # Try with the given precision first
+    try:
+        _retrying_canonize(Mcopy)
+        return Mcopy
+    except (RuntimeError, SnapPeaFatalError) as e:
+        if isinstance(M, ManifoldHP):
+            # Already using high precision.
+            # Give up.
+            raise e
+        # Then try with high precision.
+        Mhp = M.high_precision()
+        _retrying_canonize(Mhp)
+        return Mhp.low_precision()
+
+def _print_exception(e):
+    print('%s: %s' % (type(e).__name__, e))
+
+
+@sage_method
+def verified_canonical_retriangulation(
+    M,
+    interval_bits_precs=default_interval_bits_precs,
+    exact_bits_prec_and_degrees=default_exact_bits_prec_and_degrees,
+    verbose=False):
+    """
+    Given some triangulation of a cusped (possibly non-orientable) manifold ``M``,
+    return its canonical retriangulation. Return ``None`` if it could not certify
+    the result.
+
+    To compute the canonical retriangulation, it first prepares the manifold
+    (filling all Dehn-filled cusps and trying to find a proto-canonical
+    triangulation).
+    It then tries to certify the canonical triangulation using interval
+    arithmetics. If this fails, it uses snap (using `LLL-algorithm
+    <http://en.wikipedia.org/wiki/Lenstra%E2%80%93Lenstra%E2%80%93Lov%C3%A1sz_lattice_basis_reduction_algorithm>`_)
+    to guess
+    exact representations of the shapes in the shape field and then certifies
+    that it found the proto-canonical triangulation and determines the
+    transparent faces to construct the canonical retriangulation.
+
+    The optional arguments are:
+
+    - ``interval_bits_precs``:
+      a list of precisions used to try to
+      certify the canonical triangulation using intervals. By default, it
+      first tries to certify using 53 bits precision. If it failed, it tries
+      212 bits precision next. If it failed again, it moves on to trying exact
+      arithmetics.
+
+    - ``exact_bits_prec_and_degrees``:
+      a list of pairs (precision, maximal degree) used when the LLL-algorithm
+      is trying to find the defining polynomial of the shape field.
+      Similar to ``interval_bits_precs``, each pair is tried until we succeed.
+
+    - ``verbose``:
+      If ``True``, print out additional information.
+
+    The exact arithmetics can take a long time. To circumvent it, use
+    ``exact_bits_prec_and_degrees = None``.
+
+
+    Canonical cell decomposition of ``m004`` has 2 tetrahedral cells::
+
+       sage: from snappy import Manifold
+       sage: M = Manifold("m004")
+       sage: K = verified_canonical_retriangulation(M)
+       sage: K.has_finite_vertices()
+       False
+       sage: K.num_tetrahedra()
+       2
+
+    Canonical cell decomposition of ``m137`` is not tetrahedral::
+
+       sage: M = Manifold("m137")
+       sage: K = verified_canonical_retriangulation(M)
+       sage: K.has_finite_vertices()
+       True
+       sage: K.num_tetrahedra()
+       18
+
+    Canonical cell decomposition of ``m412`` is a cube and has exactly 8
+    symmetries::
+
+       sage: M = Manifold("m412")
+       sage: K = verified_canonical_retriangulation(M)
+       sage: K.has_finite_vertices()
+       True
+       sage: K.num_tetrahedra()
+       12
+       sage: len(K.isomorphisms_to(K))
+       8
+
+    `Burton's example <http://arxiv.org/abs/1311.7615>`_ of ``x101`` and ``x103`` which are actually isometric but
+    SnapPea fails to show so. We certify the canonical retriangulation and
+    find them isomorphic::
+
+       sage: M = Manifold('x101'); K = verified_canonical_retriangulation(M)
+       sage: N = Manifold('x103'); L = verified_canonical_retriangulation(N)
+       sage: len(K.isomorphisms_to(L)) > 0
+       True
+
+    Avoid potentially expensive exact arithmetics (return ``None`` because it has
+    non-tetrahedral cells so interval arithmetics can't certify it)::
+
+       sage: M = Manifold("m412")
+       sage: verified_canonical_retriangulation(M, exact_bits_prec_and_degrees = None) # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
+       Traceback (most recent call last):
+       ...
+       snappy.verify.exceptions.TiltInequalityNumericalVerifyError: Numerical verification that tilt is negative has failed: ... < 0
+
+    """
+
+    # This is the "outer" retry loop: it catches those verification
+    # failures that can probably be fixed by taking a different
+    # triangulation
+
+    tries_penalty_left = _max_tries_verify_penalty
+
+    err = ValueError("_max_tries_verify_penalty is not positive.")
+
+    while tries_penalty_left > 0:
+        try:
+            # The "inner" retry loop: it catches those verification
+            # failures that can probably be fixed by using higher
+            # precision intervals or by switching to exact
+            # arithmetics because we have transparent faces in the
+            # proto-canonical triangulation (i.e., non-tetrahedral
+            # canonical cells)
+
+            return _verified_canonical_retriangulation(
+                M, interval_bits_precs, exact_bits_prec_and_degrees,
+                verbose)
+
+        except (ZeroDivisionError,
+                exceptions.TiltProvenPositiveNumericalVerifyError,
+                exceptions.EdgeEquationExactVerifyError) as e:
+
+            err = e
+
+            # These three exceptions are probably raised due to the
+            # SnapPea kernel failures:
+            # - flat tetrahedra in the proto-canonical triangulation
+            # - this provably not being the proto-canonical triangulation
+            # Snap failures:
+            # - the wrong number field
+
+            # These failures can most of the time be fixed by trying
+            # a different triangulation of the same manifold
+
+            if verbose:
+                _print_exception(e)
+                print("Failure: In verification of result of SnapPea "
+                      "kernel's proto_canonize", end="")
+                if isinstance(e, ZeroDivisionError):
+                    print(" probably due to flat tetrahedra.")
+                if isinstance(
+                        e, exceptions.TiltProvenPositiveNumericalVerifyError):
+                    print(" due to provably positive tilts.")
+                if isinstance(
+                        e, exceptions.EdgeEquationExactVerifyError):
+                    print(" probably due to snap giving wrong number field.")
+
+                print("Next step: Retrying with randomized triangulation.")
+
+            M = M.copy()
+            M.randomize()
+
+            if isinstance(e, ZeroDivisionError):
+                # If there is a flat-tetrahedron, experience shows that enough
+                # randomization will yield a geometric triangulation eventually
+                # so keep going longer.
+                tries_penalty_left -= 1
+            else:
+                # But the other cases are more obscure, so give up faster.
+                tries_penalty_left -= 3
+
+        except exceptions.VerifyErrorBase as e:
+            # Failures we don't know how to recover from
+            if verbose:
+                _print_exception(e)
+                print("Failure: In verification of result of SnapPea kernel's "
+                      "proto_canonize.")
+                print("Next step: Give up.")
+
+            raise e
+
+    raise err
+
+def _verified_canonical_retriangulation(
+        M, interval_bits_precs, exact_bits_prec_and_degrees,
+        verbose):
+    """
+    Implements the "inner" retry loop of verified_canonical_retriangulation
+
+    Returns retriangulation or raises exception.
+
+    Some exceptions are caught by the "outer" loop to retry, using that
+    the SnapPea kernel uses a randomized algorithm to fill incomplete cusps
+    (if applicable) and perform the flips to find the proto-canonical
+    triangulation.
+    """
+
+    if all(M.cusp_info('complete?')):
+        Mfilled = M
+    else:
+        # Dehn-fill manifold first
+        Mfilled = M.filled_triangulation()
+        if not all(Mfilled.cusp_info('complete?')):
+            raise ValueError(
+                'Could not compute filled triangulation. '
+                'Are the filling coefficients co-prime integers?')
+
+    # Try to compute proto-canonical triangulation
+    Mcopy = _retrying_high_precision_canonize(Mfilled)
+
+    err = ValueError(
+        'Neither interval_bits_precs nor exact_bits_prec_and_degrees was '
+        'non-empty.')
+    
+    # First try interval arithmetics to verify
+    if interval_bits_precs:
+        for interval_bits_prec in interval_bits_precs:
+            if verbose:
+                print(("Method: Intervals with "
+                       "interval_bits_prec = %d") % interval_bits_prec)
+            try:
+                return interval_checked_canonical_triangulation(
+                    Mcopy, interval_bits_prec)
+            except (RuntimeError,
+                    ValueError, # Manifold.tetrahedra_shapes,
+                                # KrawczykShapesEngine.log_gluing_LHSs
+                    exceptions.NumericalVerifyError) as e:
+                err = e
+                if verbose:
+                    _print_exception(e)
+                    if isinstance(e, exceptions.NumericalVerifyError):
+                        print("Failure: Could not verify proto-canonical "
+                              "triangulation.")
+                    else:
+                        print("Failure: Could not find verified interval.")
+                    print("Next step: trying different method/precision.")
+
+    # Then using exact arithmetics
+    if exact_bits_prec_and_degrees:
+        for bits_prec, degree in exact_bits_prec_and_degrees:
+            if verbose:
+                print(("Method: Exact, using LLL with "
+                       "bits_prec = %d, degree = %d") % (bits_prec, degree))
+            try:
+                return exactly_checked_canonical_retriangulation(
+                    Mcopy, bits_prec, degree)
+            except FindExactShapesError as e:
+                err = e
+                if verbose:
+                    _print_exception(e)
+                    print("Failure: Could not find exact shapes.")
+                    print("Next step: trying different method/precision")
+
+    raise err
+
+_known_canonical_retriangulations = [
+    ('m004', '\x02\x0e\x01\x01\x01-\x1b\x87'),
+    ('m412', '\x0c\x80\xac\xff\x07\x05\x07\t\n\t\x08\t\n\x0b\x0b\n\x0b\xe4\xe4\xe4\xe4\xe4\xe1\xe1\xe1\xe1\xe1\xe1\xe1\xe1'),
+    ('m137', '\x12\x00\xb0\xfa\xaf\x0f\x04\t\x0b\x08\x07\x07\n\x0c\x0e\r\n\x0f\x0f\r\x11\x11\x10\x10\x11\xb4\xe4\xe1\xe1\xe1\xb4\xe1\xe1\xb1\xe1\xb4\xe4\xe4\xe1\xb1\xe1\xe1\xb4\xe1') ]
+
+
+def _test_against_known_canonical_retriangulations():
+    from snappy import Manifold
+    for name, bytes_ in _known_canonical_retriangulations:
+        M = Manifold(name)
+        K = verified_canonical_retriangulation(M)
+        L = Manifold('empty')
+        L._from_bytes(bytes_)
+        if not K.isomorphisms_to(L):
+            raise Exception('%s failed' % name)

snappy/verify/complex_volume/__init__.py

@@ -0,0 +1,18 @@
+from ...sage_helper import sage_method
+
+from .cusped import *
+from .closed import *
+
+__all__ = ['verified_complex_volume_torsion']
+
+
+@sage_method
+def verified_complex_volume_torsion(manifold, bits_prec=None):
+
+    completeness = [
+        cusp_info['complete?'] for cusp_info in manifold.cusp_info() ]
+
+    if False in completeness:
+        return verified_complex_volume_closed_torsion(manifold, bits_prec)
+    else:
+        return verified_complex_volume_cusped_torsion(manifold, bits_prec)

snappy/verify/complex_volume/adjust_torsion.py

@@ -0,0 +1,86 @@
+from ...sage_helper import _within_sage, sage_method
+if _within_sage:
+    from sage.symbolic.constants import pi
+
+from .extended_bloch import *
+from ...snap import t3mlite as t3m
+
+__all__ = ['verified_complex_volume_from_lifted_ptolemys',
+           'normalize_by_pi_square_over_two']
+
+_move_to_three = {
+    t3m.F0 : t3m.Perm4((3,0,1,2)),
+    t3m.F1 : t3m.Perm4((0,3,1,2)),
+    t3m.F2 : t3m.Perm4((0,1,3,2)),
+    t3m.F3 : t3m.Perm4((0,1,2,3))
+}
+
+_move_from_three = {
+    k : ~p for k, p in _move_to_three.items()
+}
+
+
+def _perm_for_q_tet(F, gluing):
+    return _move_to_three[gluing.image(F)] * gluing * _move_from_three[F]
+
+
+def _compute_adjustment_for_face(face):
+    canonical_corner = face.Corners[0]
+    tet = canonical_corner.Tetrahedron
+    F = canonical_corner.Subsimplex
+    gluing = tet.Gluing[F]
+    other_F = gluing.image(F)
+
+    return -2 * _perm_for_q_tet(F, gluing)[0] * (-1) ** t3m.FaceIndex[other_F]
+
+
+def _compute_adjustment(mcomplex):
+    """
+    Given an mcomplex, compute the adjustment term to account for the
+    triangulation not being ordered.
+
+    So far, only solves for the 3-torsion but 2-torsion remains
+    """
+    return sum([ _compute_adjustment_for_face(face)
+                 for face in mcomplex.Faces ])
+
+
+@sage_method
+def verified_complex_volume_from_lifted_ptolemys(mcomplex, ptolemys):
+    """
+    Given lifted Ptolemy coordinates for a triangulation (as dictionary)
+    and the number of tetrahedra, compute the complex volume (where
+    the real part is the Chern-Simons and the imaginary part is the
+    volume).
+
+    The result is correct modulo pi^2/2.
+    """
+
+    # Simply add Neumann's dilog over all simplicies as if the triangulation
+    # was ordered
+    result = compute_complex_volume_from_lifted_ptolemys_no_torsion_adjustment(
+        len(mcomplex.Tetrahedra), ptolemys)
+
+    # Add suitable multiple of pi^2/6 to the result to account for the fact
+    # that the triangulation was probably not ordered
+    CIF = result.parent()
+    return result + _compute_adjustment(mcomplex) * CIF(pi ** 2 / 6)
+
+
+@sage_method
+def normalize_by_pi_square_over_two(z):
+    """
+    Add multiples of pi^2/2 to the real part to try to bring the
+    real part between -pi^2/4 and pi^2/4.
+    """
+
+    CIF = z.parent()
+    RIF = CIF.real_field()
+
+    pi_square_over_two = RIF(pi**2 / 2)
+
+    # Round to integer
+    q = (z.real().center() / pi_square_over_two.center()).round()
+
+    # Subtract multiple of pi^2/6
+    return z - q * pi_square_over_two