snappy 3.0.3__cp38-cp38-macosx_11_0_arm64.whl → 3.2__cp38-cp38-macosx_11_0_arm64.whl

snappy/len_spec/length_spectrum_geodesic_info.py

@@ -0,0 +1,170 @@
+from ..SnapPy import Info
+from ..math_basics import is_ComplexIntervalFieldElement
+
+from typing import Tuple, Optional
+
+class LengthSpectrumGeodesicInfo(Info):
+    """
+    Information about a geodesic in the length spectrum as returned by
+    Manifold.length_spectrum_alt_gen.
+    """
+
+    def _body(self) -> str:
+        return _format % (
+            _format_length(self.length),
+            _format_core_curve(self.core_curve),
+            self.word)
+
+    def __repr__(self) -> str:
+        if self._is_first:
+            return _header + '\n' + self._body()
+        else:
+            return self._body()
+
+_core_curve_label = 'Core curve'
+_verified_num_digits = 19
+
+_format = (
+    '%%-%ds '        # Length
+    '%%-%ds  '       # Core curve
+    '%%s'            # Word
+    ) % (_verified_num_digits + len(' + ') + _verified_num_digits + len('*I'),
+         len(_core_curve_label))
+
+_header = _format % ( 'Length',
+                      _core_curve_label,
+                      'Word')
+
+_total_length = len("Out [100:] " + _header)
+
+if _total_length > 80:
+    raise AssertionError(
+        "Total length spectrum string too long: %d" % (
+            _total_length))
+
+def _format_length(length) -> str:
+    if is_ComplexIntervalFieldElement(length):
+        return _format_verified_length(length)
+    else:
+        return _format_unverified_length(length)
+
+def _format_verified_length(length) -> str:
+    return (
+        _format_verified_real_length(length.real()) +
+        ' ' +
+        _format_verified_imag_length(length.imag()) +
+        '*I')
+
+def _format_verified_real_length(length) -> str:
+    result = repr(length)
+    return _make_fixed_length(result, _verified_num_digits)
+
+def _format_verified_imag_length(length) -> str:
+    result = repr(length)
+
+    # Consume "-" to consistently format " + " and " - " later.
+    has_minus = result[0] == '-'
+    if has_minus:
+        result = result[1:]
+
+    # If this appears to be zero
+    # (that is small enough that it is of the form 1.0?e-10
+    #  and cannot be verified to be non-zero), then
+    # we write "0.00000?" or "0.00000....".
+    if 'e' in result and not length != 0:
+        num_zeros = (-abs(length).log10()).lower().floor()
+        if num_zeros > 2:
+            result = '0.' + num_zeros * '0' + '?'
+
+    result = _make_fixed_length(result, _verified_num_digits)
+
+    if has_minus:
+        result = '- ' + result
+    else:
+        result = '+ ' + result
+    return result
+
+def _format_unverified_length(length) -> str:
+    formatStr = "%16.14f"
+
+    lenStr = formatStr % length.real()
+    absImag = abs(length.imag())
+    # Unverified: just drop imaginary part if it is close to zero.
+    if absImag > 1e-9:
+        if length.imag() > 0:
+            lenStr += " + "
+        else:
+            lenStr += " - "
+        lenStr += (formatStr % absImag) + "*I"
+    return lenStr
+
+def _format_word(word : str, max_length : int) -> str:
+    """
+    >>> _format_word('abcdefghi', 9)
+    'abcdefghi'
+    >>> _format_word('abcdefghi', 8)
+    'abcde...'
+    >>> _format_word('X1x2x123x12', 11)
+    'X1x2x123x12'
+    >>> _format_word('X1x2x123x12', 10)
+    'X1x2...'
+    """
+
+    if len(word) <= max_length:
+        return word
+
+    # If word is too long, write it as "abc..." so that total
+    # length is _max_word_length.
+    ellipsis = '...'
+
+    for i in range(max_length - len(ellipsis), -1, -1):
+        # Be careful not to break at, say 2, in x123 since
+        # x12... would be misleading.
+        if not word[i].isdigit():
+            break
+    return word[:i] + ellipsis
+
+def _format_core_curve(core_curve : Optional[int]) -> str:
+    if core_curve is None:
+        return '-'
+    else:
+        return 'Cusp %d' % core_curve
+
+def _split_scientific_notation(s : str) -> Tuple[str, str]:
+    """
+    >>> _split_scientific_notation('0.45')
+    ('0.45', '')
+    >>> _split_scientific_notation('4.5?e-5')
+    ('4.5?', 'e-5')
+    """
+
+    parts = s.split('e', 2)
+    if len(parts) == 2:
+        return parts[0], 'e' + parts[1]
+    else:
+        return parts[0], ''
+
+def _make_fixed_length(result : str, length : int) -> str:
+    """
+    >>> _make_fixed_length('0.1234567', 9)
+    '0.1234567'
+    >>> _make_fixed_length('0.1234567', 8)
+    '0.123...'
+    >>> _make_fixed_length('1.2345678e-4', 9)
+    '1.2...e-4'
+    """
+
+    n = len(result)
+
+    # How many characters to we need to erase.
+    k = n - length
+
+    if k <= 0:
+        # We actually need to fill with white space.
+        return result + (-k) * ' '
+
+    # Preserve trailing, e.g., 'e-4'
+    m, e = _split_scientific_notation(result)
+    ellipsis = '...'
+    k += len(ellipsis)
+    return m[:-k] + ellipsis + e

snappy/len_spec/spine.py

@@ -0,0 +1,206 @@
+from ..snap.t3mlite import Mcomplex, simplex, Tetrahedron
+from ..hyperboloid.distances import distance_r13_points
+from ..hyperboloid import compute_inradius_and_incenter_from_planes
+from ..hyperboloid import time_r13_normalise, r13_dot
+from ..math_basics import correct_max
+
+def add_spine(mcomplex : Mcomplex):
+    """
+    Adds a spine to the mcomplex with some geometric structures.
+
+    The key property of the spine is that every geodesic that is not a core
+    curve is intersecting the spine.
+
+    Topologically, the spine is the dual 2-skeleton of the triangulation.
+    Restricted to a tetrahedron, it consists of 12 triangles. The vertices
+    of each triangle are on an edge, on a face and inside the tetrahedron.
+
+    We can give the spine a geometry by picking a point on each edge, on
+    each face and in each tetrahedron. Since we are only interested in the
+    radius of the spine when restricted to a tetrahedron, we actually do
+    not explicitly compute a point for each face.
+
+    We store the following information about the spine:
+    - use the tetrahedron's incenter as its spine center tet.spine_center.
+    - compute tet.out_radius, the radius (about the spine center) of a
+      tetrahedron truncated by the smaller horotriangles given by the scale
+      factor.
+    - a point on each edge of the triangulation, stored in tet.spine_points
+    - the maximum distance of the tet.spine_points to tet.spine_center in
+      tet.spine_radius.
+      Lemma: There is a spine of the manifold such that for each tetrahedron
+      a ball of this radius about the tetrahedron's spine center will contain
+      the restriction of the spine to the tetrahedron.
+      Proof: For each face, pick as point on that face the point picked for
+      one of the edges of that face. Consider one of the 12 triangles.
+      The point furthest from the spine center will be one of its vertices.
+      We can ignore the vertex that is the spine center itself. Any other
+      vertex of the triangle was considered when computing the maximum
+      distance.
+    - tet.inv_spine_cosh = 1 / cosh(r) where r is the tet.spine_radius
+    - for the entire fundamental domain, we have store the spine center
+      of the base tetrahedron in mcomplex.spine_center and the distance of
+      the spine point of any edge in the fundamental domain in
+      mcomplex.spine_radius.
+    """
+
+    _add_spine_points(mcomplex)
+
+    for tet in mcomplex.Tetrahedra:
+        _, tet.spine_center = compute_inradius_and_incenter_from_planes(
+            [ tet.R13_planes[f]
+              for f in simplex.TwoSubsimplices ])
+
+        tet.spine_radius = correct_max(
+            [ distance_r13_points(tet.spine_center,
+                                  tet.spine_points[e])
+              for e in simplex.OneSubsimplices] )
+
+        tet.inv_spine_cosh = 1 / tet.spine_radius.cosh()
+
+        if False:
+            for v in simplex.ZeroSubsimplices:
+                d = r13_dot(tet.spine_center, tet.R13_vertices[v])
+                if not d < - (1 - mcomplex.RF(1e-8)):
+                    print(tet.spine_points)
+                    print(tet.R13_vertices)
+                    raise Exception("Conjecture is wrong.")
+
+        tet.out_points = {
+            (v0, v1): _out_point(tet, v0, v1)
+            for v0 in simplex.ZeroSubsimplices
+            for v1 in simplex.ZeroSubsimplices
+            if v0 != v1 }
+
+        tet.out_radius = correct_max(
+            [ distance_r13_points(tet.spine_center,
+                                  tet.out_points[(v0, v1)])
+              for v0 in simplex.ZeroSubsimplices
+              for v1 in simplex.ZeroSubsimplices
+              if v0 != v1 ])
+
+        if False:
+            print("out, spine =", tet.out_radius, tet.spine_radius)
+
+    mcomplex.spine_center = mcomplex.baseTet.spine_center
+    mcomplex.spine_radius = correct_max(
+        [ distance_r13_points(mcomplex.spine_center,
+                              tet.spine_points[e])
+          for tet in mcomplex.Tetrahedra
+          for e in simplex.OneSubsimplices ])
+
+def _add_spine_points(mcomplex : Mcomplex):
+    """
+    Adds tet.spine_points.
+
+    We need to pick the points such that they are inside the tetrahedra
+    truncated by the chosen cusp neighborhood or tube about the core curve (if
+    cusp is filled). We also need to pick them consistently across tetrahedra.
+
+    That is if two edges of two (not necessarily distinct) tetrahedra get
+    identified in the triangulation, then the two points we pick for those two
+    edges need to be the same point in the manifold.
+    """
+
+    for tet in mcomplex.Tetrahedra:
+        tet.spine_points = {}
+
+    for edge in mcomplex.Edges:
+        # An edge connects two (possibly not distinct) cusps.
+        #
+        # If both cusps are complete, this is easy:
+        # We simply take as point the midpoint on the edge between the two
+        # cusp neighborhoods. Given the vectors defining the
+        # corresponding horoballs stored in tet.R13_vertices, we can simply
+        # average the two corresponding vectors and normalise.
+        #
+        # However, if the cusp is incomplete, the horotriangles for one cusp
+        # about the edge touch the edge about different points in the
+        # manifold (recall the Giant's Causeway picture in
+        # scale_triangles_to_avoid_standard_tube).
+        #
+        # So when we walk about the edge, we need to keep track of the scaling
+        # factor that needs to be applied to tet.R13_vertices so that the
+        # horotriangle it defines lines up with the first horotriangle about
+        # the edge.
+        #
+        # When we go from one triangle to the next, the scaling factor needs to
+        # be adjusted by the ratio of the lengths of the edges of the triangle
+        # that we want to glue together.
+        #
+        # We start by simply picking the midpoint as in the complete case
+        # for the first edge embedding. Since the two horotriangles we use
+        # are both outside the chosen cusp neighborhood or core curve tube,
+        # the point computed this way will be outside those neighborhoods.
+
+        # Relevant edge length of triangle for cusps
+        length0 = None
+        length1 = None
+
+        # Scale factor to align horotriangles for both cusps
+        scale0 = mcomplex.RF(1)
+        scale1 = mcomplex.RF(1)
+
+        # Walk about the edge
+        for i, (tet, perm) in enumerate(edge.embeddings()):
+            # Vertices of tetrahedron corresponding to the cusps
+            v0 = simplex.ZeroSubsimplices[perm[0]]
+            v1 = simplex.ZeroSubsimplices[perm[1]]
+
+            # Face we need to cross to get to next embedding
+            face2 = simplex.TwoSubsimplices[perm[2]]
+            # Face we need to cross to get to previous embedding
+            face3 = simplex.TwoSubsimplices[perm[3]]
+
+            if i == 0:
+                # Record whether cusp is complete
+                is_complete0 = tet.Class[v0].is_complete
+                is_complete1 = tet.Class[v1].is_complete
+
+            if not is_complete0:
+                lengths0 = tet.horotriangles[v0].get_real_lengths()
+                if length0 is not None:
+                    # We are beyond the very first triangle and need to
+                    # update the scaling factor.
+                    #
+                    # We use the ratio of the following edge lengths:
+                    # - the edge of the current triangle. It is the edge that
+                    #   we need to cross to get to the previous embedding.
+                    # - the edge of the previous triangle. It is the edge that
+                    #   we needed to cross to get to this embedding.
+                    scale0 = scale0 * lengths0[face3] / length0
+                # Store length for next iteration
+                length0 = lengths0[face2]
+
+            if not is_complete1:
+                # Similar
+                lengths1 = tet.horotriangles[v1].get_real_lengths()
+                if length1 is not None:
+                    scale1 = scale1 * lengths1[face3] / length1
+                length1 = lengths1[face2]
+
+            tet.spine_points[v0 | v1] = time_r13_normalise(
+                scale0 * tet.R13_vertices[v0] + scale1 * tet.R13_vertices[v1])
+
+def _out_point(tet : Tetrahedron, v0 : int, v1 : int):
+    """
+    Compute one vertex of the truncated tetrahedron. Here it is the "large"
+    tetrahedron truncated by  the "small" horotriangle.
+
+    Note that for a complete cusps, we only have one horotriangle per tetrahedron
+    and vertex of that tetrahedron. But for a filled cusp, we have a pair of
+    horotriangles, a "big" one which is outside the chosen core curve tube and
+    a "small" one inside the chosen core curve tube.
+    """
+
+    # Inverse scaling factor to get from the default "big" horotriangle to the
+    # "small" one.
+    s = tet.horotriangles[v0].inverse_scale_to_be_inside_tube
+    return _point_on_horosphere(s * tet.R13_vertices[v0], tet.R13_vertices[v1])
+
+def _point_on_horosphere(horo_vec, pt):
+    """
+    The point that is the intersection of the horosphere defined by horo_vec
+    and the line from horo_vec to pt.
+    """
+    return time_r13_normalise( horo_vec - (2 / r13_dot(horo_vec, pt)) * pt)

snappy/len_spec/test.py

@@ -0,0 +1,24 @@
+from snappy import testing
+import snappy
+
+from snappy import len_spec
+import snappy.len_spec.test_cases
+
+modules = [
+    len_spec,
+    len_spec.word,
+    len_spec.length_spectrum_geodesic_info,
+    len_spec.test_cases
+]
+
+def run_doctests(verbose=False, print_info=True):
+    globs = {'Manifold': snappy.Manifold}
+    return testing.doctest_modules(modules,
+                                   verbose=verbose,
+                                   print_info=print_info,
+                                   extraglobs=globs)
+
+run_doctests.__name__ = len_spec.__name__
+
+if __name__ == '__main__':
+    testing.run_doctests_as_main(run_doctests)

snappy/len_spec/test_cases.py

@@ -0,0 +1,69 @@
+"""
+IMPORTANT: Python only recognises this as a doc string if there is
+nothing before it. In particular, add any includes after the doc string.
+
+>>> M = Manifold("m125(3,4)(0,0)")
+>>> spec = M.length_spectrum_alt_gen()
+>>> next(spec) # doctest: +NUMERIC9
+Length                                      Core curve  Word
+0.24208261435543 - 1.73621300277325*I       Cusp 0      aBDcDcb
+>>> next(spec).length # doctest: +NUMERIC9
+0.90986906036840 + 3.03574280072295*I
+>>> next(spec).length # doctest: +NUMERIC9
+0.98258854739348 - 2.33353878259198*I
+>>> next(spec).length # doctest: +NUMERIC9
+1.00610499287709 - 3.02617893116978*I
+>>> next(spec).length # doctest: +NUMERIC9
+1.13551437663552 - 2.12918861416187*I
+>>> next(spec).length # doctest: +NUMERIC9
+1.63203771292969 + 2.30009520293758*I
+
+Examples with +SKIP from length_spectrum_alt
+
+>>> M = Manifold("m202(3,4)(3,4)")
+>>> spec = M.length_spectrum_alt(count = 3)
+>>> len(spec)
+4
+>>> spec[0].length # doctest: +NUMERIC9
+0.14820741547094 - 1.76955170166922*I
+>>> spec[1].length # doctest: +NUMERIC9
+0.14820741547097 - 1.76955170166923*I
+>>> spec[2].length # doctest: +NUMERIC9
+0.79356651781096 + 2.65902431489655*I
+>>> spec[3].length # doctest: +NUMERIC9
+0.79356651781096 + 2.65902431489655*I
+
+Verified:
+
+sage: spec = M.length_spectrum_alt(count = 3, verified = True, bits_prec = 110)
+sage: len(spec)
+4
+sage: spec[0].length # doctest: +NUMERIC9
+0.14820741547094772? - 1.76955170166923543?*I
+sage: spec[1].length # doctest: +NUMERIC9
+0.14820741547094772? - 1.76955170166923543?*I
+sage: spec[2].length # doctest: +NUMERIC9
+0.79356651781095741? + 2.65902431489655135?*I
+sage: spec[3].length # doctest: +NUMERIC9
+0.79356651781095741? + 2.65902431489655135?*I
+
+>>> M = Manifold("m202(3,4)(0,0)")
+>>> M.length_spectrum_alt(max_len = 1.1) # doctest: +NUMERIC9
+[Length                                      Core curve  Word
+ 0.14742465268512 - 1.78287093565202*I       Cusp 0      aabcDabcB,
+ 0.81161414965958 + 2.72911699294426*I       -           b,
+ 0.84163270359334 + 2.61245944742151*I       -           aB,
+ 0.93461379591349 + 2.70060614107722*I       -           a]
+
+sage: M.length_spectrum_alt(max_len = 1.1, verified=True, bits_prec=130) # doctest: +NORMALIZE_WHITESPACE
+[Length                                      Core curve  Word
+ 0.14742465268515... - 1.78287093565201...*I Cusp 0      aabcDabcB,
+ 0.81161414965958... + 2.72911699294425...*I -           b,
+ 0.84163270359334... + 2.61245944742151...*I -           aB,
+ 0.93461379591349... + 2.70060614107721...*I -           a]
+
+
+"""
+
+if not __doc__:
+    raise Exception("doc string with tests was not recognized.")