#9439 closed enhancement (fixed)
hyperbolic geometry
Reported by:  vdelecroix  Owned by:  vdelecroix 

Priority:  major  Milestone:  sage6.4 
Component:  geometry  Keywords:  hyperbolic geometry, Poincare disc, upper half plane, BeltramiKlein, hyperboloid model, sd35, days64 
Cc:  kcrisman, pbruin  Merged in:  
Authors:  Vincent Delecroix, Martin Raum, Greg Laun, Travis Scrimshaw  Reviewers:  Johan Bosman, Travis Scrimshaw, Greg Laun, Frédéric Chapoton 
Report Upstream:  N/A  Work issues:  
Branch:  82cf89e (Commits)  Commit:  
Dependencies:  Stopgaps: 
Description (last modified by )
Implementation of two conformal models of hyperbolic geometry (half plane, disc) and actions of their isometry groups.
The actual file is almost complete for working with the hyperbolic plane as the following will plot a hyperbolic triangle
sage: HH Hyperbolic half plane sage: HH(0) Boundary point 0 sage: p = HH.polygon([CC(0), CC(1), CC(2,2)]) sage: p.plot(face_color='red').show(aspect_ratio=1)
There are more examples in the file.
Apply:
Attachments (16)
Change History (90)
Changed 9 years ago by
comment:1 Changed 9 years ago by
 Owner changed from mhampton to vdelecroix
comment:2 Changed 9 years ago by
 Description modified (diff)
comment:3 followup: ↓ 4 Changed 8 years ago by
 Description modified (diff)
 Milestone set to sage4.8
*ping* :)
Are you planning on finishing this? It would be very good to have an upper half plane implementation.
There are a few things that need to be improved though. Accessing attributes directly (e.g. with spam._value) is not good. Please use accessor methods instead (i.e. a method named value() that returns _value); this improves the separation of interface and implementation.
Near the real line, the hyperbolic distance becomes become HUGE compared to the Euclidean distance. Representing a point as a complex number thus leads to numeric instability. It is therefore better to implement a point by a pair of a matrix ((a,b),(c,d)) and a complex number z (thus representing (az+b)/(cz+d)).
comment:4 in reply to: ↑ 3 ; followup: ↓ 5 Changed 8 years ago by
Are you planning on finishing this? It would be very good to have an upper half plane implementation.
Yes. But if you have time and motivation, go on. But there are problems (see below)
There are a few things that need to be improved though. Accessing attributes directly (e.g. with spam._value) is not good. Please use accessor methods instead (i.e. a method named value() that returns _value); this improves the separation of interface and implementation.
Can be done.
Near the real line, the hyperbolic distance becomes become HUGE compared to the Euclidean distance. Representing a point as a complex number thus leads to numeric instability. It is therefore better to implement a point by a pair of a matrix ((a,b),(c,d)) and a complex number z (thus representing (az+b)/(cz+d)).
I agree on the fact that near the real line it is unstable but disagree on the fact that we need a 5 dimensional object (an element of SL(2,R) and a complex number) to record a 2 dimensional object (a point in the half plane). The best option would be to store only the SL(2,R) matrix m such that the point is the image by z of the point i. Two matrices give the same point iff they are congruent modulo SO(2).
Problems
1) The main problem with that project is about of action by matrices. It would be natural that matrices act on the upper half plane. But there are many instances
 element of ArithmeticSubgroup? (SL(2,Z)) which is implemented
 element of groups SL(2,R) or GL(2,R) or ...
 a matrix with real coefficient
 ...
I had trouble with the coercion system in order to be able to use any of the type above.
2) In the actual implementation, the geodesics that pass to infinity in the half plane model have an arbitrary maximum height. I did not find a good way to draw them depending on what is asked in the final .show(). In the same veine, a circle with radius 1 very near the boundary should not be drawn as it is less than one pixel...
comment:5 in reply to: ↑ 4 Changed 8 years ago by
Replying to vdelecroix:
I agree on the fact that near the real line it is unstable but disagree on the fact that we need a 5 dimensional object (an element of SL(2,R) and a complex number) to record a 2 dimensional object (a point in the half plane). The best option would be to store only the SL(2,R) matrix m such that the point is the image by z of the point i. Two matrices give the same point iff they are congruent modulo SO(2).
Okay. Another possibility is to have the matrix ((a, b), (c, d)) in SL_2(ZZ) and the complex number z in the standard fundamental domain for this group. Or use both representations (and allow oneself to convert between them).
comment:6 Changed 8 years ago by
 Keywords sd35 added
comment:7 Changed 8 years ago by
The patch I've just uploaded makes Sage import HH at startup. I propose that we clean up all the mess first (including all the doctest failures) before we add further functionality.
Changed 8 years ago by
comment:8 Changed 8 years ago by
I simply uploaded all current files, because I messed up my HG status.
I couldn't fix the problem with conversion into CC, which is now #12216. I replaced it by the method toCC.
I haven't checked whether triangles work, but I am exhausted. Plotting polygons works and it should be easy to fill in the tests, that are all stubs for the moment.
comment:9 followup: ↓ 11 Changed 7 years ago by
This looks neat: I just wanted to encourage you guys to keep working on it. I just had a request for plotting fundamental domains of congruence subgroups....
comment:10 Changed 7 years ago by
 Cc kcrisman added
 Reviewers set to Johan Bosman
comment:11 in reply to: ↑ 9 Changed 7 years ago by
Replying to roed:
This looks neat: I just wanted to encourage you guys to keep working on it. I just had a request for plotting fundamental domains of congruence subgroups....
I just notice that it is yet possible to draw fundamental domain for congruence subgroups using Farey symbols (#11709, integrated since sage5.0).
sage: FareySymbol(Gamma(3)).fundamental_domain()
comment:12 followup: ↓ 13 Changed 7 years ago by
I have a working implementation of hyperbolic twospace in sage that includes the upper half plane, Poincare disk, Klein disk, and hyperboloid model. For each model, geodesics, points, and isometry groups are implemented.
Conversion between each model to another is implemented*, as are a number of useful calculation routines. For example, geodesics can compute the corresponding reflection, two geodesics can compute their common perpendiculars, isometries can factor themselves into products of reflections.
The code originated as a series of Mathematica notebooks from Bill Goldman's lab at UMD. We had some students port it to a sage script, which was then fleshed out. I have refrained from publishing it here because I'm completely refactoring into something resembling readable code. It's taken me a few month longer than I thought it would to refactor, so I wanted to write a note here so that efforts aren't redoubled.
Is there a best course of action as far as posting code goes? I think that merging the patches posted here and my code won't be too bad. Should I finish refactoring my code first, and then post it? Should I post the original script? In the original code, there are lots of test and all tests pass, so it's usable. Should I post the bit of refactoring I've done so far?
*Actually, not quite. I don't have a great way to go from SO(2,1) to SL(2,R). So this makes converting from the hyperboloid model to the other models somewhat tricky.
comment:13 in reply to: ↑ 12 Changed 7 years ago by
Hi Greg,
You should either post your code here or provide a link. If your code does work, we will definitely use it !
Note that several things should be merged
 the different code in that ticket
 fundamental domain of FareySymbol?
 your code
Best, Vincent
comment:14 Changed 7 years ago by
Okay great. I'll post it by the end of the week. That should be enough time to clean up the remaining refactoring (which will greatly improve the ability to merge the code).
comment:15 Changed 7 years ago by
Obviously it's been longer than a week. I had to attend a long conference and then hurricanes etc. It will be at the very least another week before I get it up.
comment:16 Changed 7 years ago by
 Description modified (diff)
What a mess ! can some of you say what patches have to be applied and in which order ?
Let me try with just one patch:
apply trac_9439hyperbolic_geometry.patch
comment:17 Changed 7 years ago by
A review patch, so that tests pass. But there lacks a lot of documentation !
comment:18 Changed 7 years ago by
 Description modified (diff)
comment:19 Changed 7 years ago by
50% coverage
Changed 7 years ago by
comment:20 Changed 7 years ago by
77% coverage
comment:21 followup: ↓ 22 Changed 6 years ago by
I atteched the longoverdue patch that I mentioned 9 months ago. Sorry for the delay. The patch has the following positive properties:
 Hyperbolic point, geodesic, and isometry objects are implemented for each model.
 Upper half plane, Poincare disk, Klein disk, and hyperboloid model all implemented.
 Roundtrip conversion among models works. E.g. converting from the upper half plane to the hyperboloid and then back to the half plane gives the same point (up to numerical precision). This was harder than might first be apparent since there are so many isomorphisms to choose from and they all have to play well together.
 100% test coverage, all tests pass
Also note the following negative things:
 Points are not yet implemented as (point, isometry) pairs as suggested in Comment 3.
 My handling of numerical computations could probably be significantly improved, as can the overall organization. There may be features that are unnecessary or are vestigial from earlier versions.
 Symbolic computations can take an incredibly long time. I'm not sure if this is my fault (e.g. I should write functions to deal with this) or simply a drawback of allowing symbolic computations.
I intend to comb through the previously attached patches and merge what I can. I have also attached a filecalled hyp_demo.sage that demos the functionality of the implementation.
comment:22 in reply to: ↑ 21 ; followup: ↓ 23 Changed 6 years ago by
Replying to glaun:
I atteched the longoverdue patch that I mentioned 9 months ago. Sorry for the delay. The patch has the following positive properties:
Great! Good job!
Also note the following negative things:
 Points are not yet implemented as (point, isometry) pairs as suggested in Comment 3.
This was a *bad* suggestion! It's great that you avoid it.
 My handling of numerical computations could probably be significantly improved, as can the overall organization. There may be features that are unnecessary or are vestigial from earlier versions.
I will have a look as soon as possible.
 Symbolic computations can take an incredibly long time. I'm not sure if this is my fault (e.g. I should write functions to deal with this) or simply a drawback of allowing symbolic computations.
I intend to comb through the previously attached patches and merge what I can. I have also attached a filecalled hyp_demo.sage that demos the functionality of the implementation.
idem.
Two points:
 an important feature that you seem to avoid is the unit tangent bundle of the hyperbolic plane which is isomorphic to PSL(2,R). One great thing would be to have another object
TangentVector
(with a matrix as data). The action of PSL(2,R) on the unit tangent bundle is then just matrix multiplication.  your example worksheet should definitely be a thematic tutorial for the Sage documentation
I suggest that we open two new tickets for those features.
Thanks again for your work on this. I am starting the review and will be back with more technical remarks shortly.
comment:23 in reply to: ↑ 22 Changed 6 years ago by
Two points:
 an important feature that you seem to avoid is the unit tangent bundle of the hyperbolic plane which is isomorphic to PSL(2,R). One great thing would be to have another object
TangentVector
(with a matrix as data). The action of PSL(2,R) on the unit tangent bundle is then just matrix multiplication. your example worksheet should definitely be a thematic tutorial for the Sage documentation
Thanks, I'll look into both of these soon. I have some code for working in Minkowski (2,1) space that I want to use to implement the hyperboloid model in the Lie algebra sl(2,R) since that's what I use in my own research. Several of the functions are for working in SL(2,R)/PSL(2,R). I can take a look at that and see what can be appropriated for use in a TangentVector? object.
comment:24 followups: ↓ 25 ↓ 26 Changed 6 years ago by
Hi Greg,
There are many nice features in the patch but I did not start to play with. You should start by a big clean:
1) there should be no trailing whitespace
2) the organization of each file should be a header which consists of a string with authors the copyright statement and then the code. There should not be several headers and copyright statements.
3) all methods and functions should be commented and doctested. Running sage coverage
gives
SCORE hyperbolic_object.py: 10.0% (1 of 10) Missing documentation: * line 40: def to_model(self, model) * line 49: def to_UHP(self) * line 52: def uhp_representation(self) * line 55: def model_representation(self) * line 58: def representation_in_model(self, model=None) * line 96: def to_model(self, model, **options) * line 108: def graphics_options(self) Missing doctests: * line 33: def __init__(self, args, **graphics_options) * line 88: def __init__(self, args, **graphics_options)
4) the files should be properly included in the sage documentation
Now, more serious issues
5) the objects from your module must be lazy imported and not imported in the global namespace (in order to not slow down sage startup)
6) the method show
should not return a graphics object but should rather shows it! You could rename it plot
.
7) I agree that it is misleading but CC
in Sage is not the set of complex number! In particular the test x in CC
does not answer to the question "does my object x
modelizes some complex number ?". Precisely CC
is the set of floating point complex number with 53 bits of precision. But is it on purpose that you want x in CC
as coordinates for a point in the upper half plane ?
8) The string representation "Hyperbolic point whose representation in the Upper Half Plane is +Infinity" is definitely too long! Why not "Point in HH +Infinity".
And finally a design question (which perhaps should be thought of first)
9) I think that the fact of being conformal or bounded etc is not a property of a HyperbolicObject? but rather a property of the underlying model. You decided to not design a class for each model, was it on purpose? Such a class may contain all these property. As you see, in my initial patch, it was possible to write
sage: HH Hyperbolic plane sage: HH(0) Boundary point 0
I would prefer to have a dedicated class for each model and be able to construct point/geodesic/polygons from the class (via for example HH.point(data)
,
HH.geodesic(data)
, etc). You may also move the
random_element
methods and the various conversions between the models into this parent class.
comment:25 in reply to: ↑ 24 Changed 6 years ago by
Thanks for the feedback! I didn't know exactly what to do about tests in what was intended to be an abstract class (hyperbeolic_object) that shouldn't be instantiated. I see now that there are other abstract classes in sage and they all have poper doctests, so I'll go ahead and add those in. That should be very simple, as should the rest of the cleanup.
The other issues you mentioned are all things I thought might be problems, so I've given them all a little bit of thought already
Replying to vdelecroix:
4) the files should be properly included in the sage documentation
Okay, will do.
Now, more serious issues
5) the objects from your module must be lazy imported and not imported in the global namespace (in order to not slow down sage startup)
Okay, I will change this.
6) the method
show
should not return a graphics object but should rather shows it! You could rename itplot
.
I'm actually not quite sure what the difference is. Do you mean that show should make a system call to the default viewer? Is it not sufficient to call a method that makes that call for me? I've noticed in one other module that plot() is implemented and show() is an alias for plot. Would this be a workaround?
7) I agree that it is misleading but
CC
in Sage is not the set of complex number! In particular the testx in CC
does not answer to the question "does my objectx
modelizes some complex number ?". PreciselyCC
is the set of floating point complex number with 53 bits of precision. But is it on purpose that you wantx in CC
as coordinates for a point in the upper half plane ?
This is a hack. I wanted a function that returned True for things that can be converted into floating point complex numbers and "2 + I in CC" returns True even though "2 + I" is a symbolic expression. I didn't want to test more explicitly for symbolic complex numbers because I don't know the symbolic system well enough to be sure to catch all possible cases. And I didn't want to have a test condition that relied on the symbolic apparatus because via profiling I found many cases in which calling functions that were in the symbolics library slowed everything to a crawl. So "x in CC" quickly checks whether something is the right type of object to have "imag()" called on it sensibly. I more than welcome suggestions on how to solve this problem more elegantly without slowing down code. As an example, the functions _clean_points and _shorten_symbolic are both very ugly to my tastes, but I wrote each to address specific issues that arose in profiling and their impact is significant. In a similar way, I find 'x in CC' to be unfortunate but useful.
8) The string representation "Hyperbolic point whose representation in the Upper Half Plane is +Infinity" is definitely too long! Why not "Point in HH +Infinity".
The long strings were a request, and I agree they're much too long. I'll go ahead and change them. I'd like them to contain information about the model, though so that there is less confusion when performing conversion.
And finally a design question (which perhaps should be thought of first)
9) I think that the fact of being conformal or bounded etc is not a property of a HyperbolicObject? but rather a property of the underlying model. You decided to not design a class for each model, was it on purpose? Such a class may contain all these property. As you see, in my initial patch, it was possible to write
sage: HH Hyperbolic plane sage: HH(0) Boundary point 0I would prefer to have a dedicated class for each model and be able to construct point/geodesic/polygons from the class (via for example
HH.point(data)
,
HH.geodesic(data)
, etc). You may also move the
random_element
methods and the various conversions between the models into this parent class.
I think your way of doing it sounds much better than mine. I had actually been planning on looking more closely at your structure and applying it to mine as a next step. I'll look into this starting tomorrow.
comment:26 in reply to: ↑ 24 ; followup: ↓ 27 Changed 6 years ago by
Hi Vincent,
I've addressed issues 14, and I was hoping you wouldn't mind giving me some guidance about how to handle the remaining issues. Specifically, I have the following questions:
1) Should I post a patch for the fixes of 14? Or should I wait until I fix the remaining issues? More generally, should I err on the side of posting more patches (so more people can help) or posting only ones that seem more significant?
2) I like the structure of your code, and I aim to emulate it. Does it make sense for me to combine your class structure with the features in mine and post it in skeletal form before fixing all of the functions? For example, I could post a class diagram, or just an outline of the modules with the guts removed. Or is this step likely to be more work with little payoff? I would ideally like the structure to be as democratically decided as possible.
3) I find your usage of HyperbolicPlane? for the upper half plane to be confusing since the HyperbolicDisc? is also topologically a plane. I'm used to referring to both as the hyperbolic plane, and I typically differentiate them by specifying which model of the plane. I have been using the abbreviations UHP, PD, KM, and HM which were just decided by fiat to be short and convenient. Is there anything you dislike about this approach to naming? I worry that HyperbolicUHP is too cryptic, but HyperbolicUpperHalfPlane? is too long.
comment:27 in reply to: ↑ 26 Changed 6 years ago by
Hi,
Replying to glaun:
I've addressed issues 14, and I was hoping you wouldn't mind giving me some guidance about how to handle the remaining issues. Specifically, I have the following questions:
1) Should I post a patch for the fixes of 14? Or should I wait until I fix the remaining issues? More generally, should I err on the side of posting more patches (so more people can help) or posting only ones that seem more significant?
Not necessarily. You can fold your two patches into one and post only the update version of your previous patch (to fold two patches hg qfold
).
2) I like the structure of your code, and I aim to emulate it. Does it make sense for me to combine your class structure with the features in mine and post it in skeletal form before fixing all of the functions? For example, I could post a class diagram, or just an outline of the modules with the guts removed. Or is this step likely to be more work with little payoff? I would ideally like the structure to be as democratically decided as possible.
Your code definitely contains much more material than mine. If you like better the structure I drafted you are free to reuse it. If you post anything on trac it is always better that it is working code.
In my opinion, as you are currently working on that project, you may choose the datastructure you prefer and indicate clearly in the documentation the concept, why did you choose that design and why did you discard the other ones.
3) I find your usage of HyperbolicPlane? for the upper half plane to be confusing since the HyperbolicDisc? is also topologically a plane.
I agree. It was just because I always find HH and DD in textbooks and did not ask myself more questions.
I'm used to referring to both as the hyperbolic plane, and I typically differentiate them by specifying which model of the plane. I have been using the abbreviations UHP, PD, KM, and HM which were just decided by fiat to be short and convenient. Is there anything you dislike about this approach to naming? I worry that HyperbolicUHP is too cryptic, but HyperbolicUpperHalfPlane? is too long.
I like better UHP, PD, KM and HM but I think they should not be imported in the standard namespace as such (because it is not clear how the user may find them). What about something like:
sage: hyperbolic_geometry.upper_half_plane() The upper half plane sage: hyperbolic_geometry.UHP The upper half plane etc
That way, we may use tab completion. But perhaps, "hyperbolic_geometry" is a bit too long. If somebody want it in the global namespace it is still possible to do
sage: from sage.XXX.hyperbolic_geometry import * sage: UHP The upper half plane
Vincent
comment:28 Changed 6 years ago by
Hi, just to give an update, I've completely revamped the class and module structure in a way that I like much better. Right now only the basics of the classes are implemented, but those basics are tested and everything is in working order. I'm now starting to add more functionality.
comment:29 Changed 6 years ago by
 Milestone changed from sage5.11 to sage5.12
comment:30 Changed 6 years ago by
I just attached a new version. This one allows things like UHP.point(0) or KM.point((1/2, 1/2)), and similarly UHP.geodesic([start, finish]), and UHP.isometry(some_matrix).
The class structure is somewhat complicated, but it's designed to make it easy to implement new models of 2D and 3D geometry. Here's how it works:
 The hyperbolic_model module contains data about each individual model, such as its name, the name of its isometry group, and dictionaries of maps to convert points and isometries to other models and so on.
 the hyperbolic_point, hyperbolic_bdry_point, hyperbolic_geodesic, and hyperbolic_isometry modules all do what they sound like. The methods in these modules are meant to be as general and abstract as possible. Ideally they should barely have to be touched to implement new models of hyperbolic space.
 hyperbolic_methods implements any methods that involve doing computations with actual numbers. These methods have their own module because they are more likely to change if it turns out some computation is not efficient. Also any model of hyperbolic geometry can choose to do computations in another model and convert the results. In the current patch, every model does its computations in the upper half plane and then converts back to the desired model.
 hyperbolic_factory and model_factory are just factory patterns that make the whole abstract structure work.
 finally, hyperbolic_interface is the module that contains the objects UHP, HM, KM, and PD that allow operations like UHP.point(1 + I). These are just more pleasant user interfaces to methods in other classes.
To implement another 2D model, one mainly has to put the model information in hyperbolic_model and write down maps to all of the other models. To implement a 3D model, one also has to implement hyperbolic_methods for at least one model (say the upper half space model). In both cases there is a tiny amount of book keeping that must also be done in updating the factory and other modules with one or two lines of code.
comment:31 Changed 6 years ago by
I had occasion yesterday to use my most recent patch for actual computations that involve a lot of model changing, and I realized it's shamefully buggy/nonfunctioning. I fixed a few of the obvious bugs but I'll add more tests before I repost to make sure that I haven't introduced other bugs.
comment:32 Changed 6 years ago by
 Branch set to u/glaun/ticket/9439
 Keywords BeltramiKlein hyperboloid model added
 Modified changed from 09/19/13 13:23:07 to 09/19/13 13:23:07
comment:33 Changed 6 years ago by
 Branch u/glaun/ticket/9439 deleted
comment:34 Changed 6 years ago by
 Status changed from new to needs_review
comment:35 Changed 6 years ago by
I uploaded a new patch. It fixes some docbuild errors that I didn't catch before. I am marking it as needs_review because I'd like to get some feedback on it.
There are several things I'd like to add, including
 support for polygons, circles, and horocycles
 the ability to return the SageManifolds? manifold associated with each model
 some models of hyperbolic 3 space
But I'd like each of these to have their own bug report/feature request so before I do work on them I'd like to get the current patch reviewed.
If it's easier for reviewers, I can try to submit a barebones patch (maybe with just the upper half plane model) to reduce the number of lines of code and then add everything else in incremental patches.
comment:36 Changed 6 years ago by
 Branch set to u/glaun/ticket/9439
 Modified changed from 11/21/13 01:23:35 to 11/21/13 01:23:35
comment:37 Changed 6 years ago by
 Cc pbruin added
 Commit set to bda7f78dc5471984885bbbcc9f535412142dfe84
New commits:
bda7f78  Recommit of patches already on trac. 
comment:38 Changed 6 years ago by
 Milestone changed from sage6.1 to sage6.2
comment:39 Changed 6 years ago by
 Commit changed from bda7f78dc5471984885bbbcc9f535412142dfe84 to 22773f0ef46e236ab2bd7a86a090957e01e67fc9
Branch pushed to git repo; I updated commit sha1. New commits:
4675f7e  Fixed bug in fixed_point_set in hyperbolic_methods. For UHP matrices, the base_ring is now always changed to RDF before eigenvector computations.

556f3f7  In the function fixed_point in the module hyperbolic methods for UHP (SL2R) matrices, catch an index

22773f0  Fixed a bug in the drawing of complete geodesics in the Poincare disk model.

comment:40 Changed 6 years ago by
 Commit changed from 22773f0ef46e236ab2bd7a86a090957e01e67fc9 to c04c17cbdc4a5cb20591176200a5ba7a49a2a379
Branch pushed to git repo; I updated commit sha1. New commits:
c04c17c  Fixed bug in orientationreversing isometries.

comment:41 Changed 6 years ago by
 Commit changed from c04c17cbdc4a5cb20591176200a5ba7a49a2a379 to 354158f495a556c599cb6170276658762a0118c3
Branch pushed to git repo; I updated commit sha1. New commits:
354158f  Points are held as vectors rather than as tuples. This avoids some unwanted side effects.

comment:42 Changed 6 years ago by
 Milestone changed from sage6.2 to sage6.3
comment:43 Changed 6 years ago by
 Status changed from needs_review to needs_work
patchbot fails with make doc
:
[geometry ] /scratch/sage/src/doc/en/reference/geometry/index.rst:47: ERROR: Unexpected indentation. [geometry ] /scratch/sage/src/doc/en/reference/geometry/index.rst:56: WARNING: Literal block ends without a blank line; unexpected unindent. [geometry ] /scratch/sage/src/doc/en/reference/geometry/index.rst:56: SEVERE: Missing matching underline for section title overline. [geometry ] ======= [geometry ] sage/geometry/hyperplane_arrangement/arrangement [geometry ] sage/geometry/hyperplane_arrangement/library [geometry ] /scratch/sage/local/lib/python2.7/sitepackages/sage/geometry/hyperbolic_space/hyperbolic_model.py:docstring of sage.geometry.hyperbolic_space.hyperbolic_model:14: ERROR: Unexpected indentation. [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/hyperbolic_space/hyperbolic_bdry_point.rst:: WARNING: document isn't included in any toctree [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/hyperbolic_space/hyperbolic_geodesic.rst:: WARNING: document isn't included in any toctree [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/hyperbolic_space/hyperbolic_interface.rst:: WARNING: document isn't included in any toctree [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/hyperbolic_space/hyperbolic_isometry.rst:: WARNING: document isn't included in any toctree [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/hyperbolic_space/hyperbolic_methods.rst:: WARNING: document isn't included in any toctree [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/hyperbolic_space/hyperbolic_model.rst:: WARNING: document isn't included in any toctree [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/hyperbolic_space/hyperbolic_point.rst:: WARNING: document isn't included in any toctree [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/hyperplane_arrangement/affine_subspace.rst:: WARNING: document isn't included in any toctree [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/hyperplane_arrangement/arrangement.rst:: WARNING: document isn't included in any toctree [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/hyperplane_arrangement/hyperplane.rst:: WARNING: document isn't included in any toctree [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/hyperplane_arrangement/library.rst:: WARNING: document isn't included in any toctree [geometry ] /scratch/sage/src/doc/en/reference/geometry/sage/geometry/linear_expression.rst:: WARNING: document isn't included in any toctree Error building the documentation. Traceback (most recent call last): File "/scratch/sage/src/doc/common/builder.py", line 1477, in <module> getattr(get_builder(name), type)() File "/scratch/sage/src/doc/common/builder.py", line 276, in _wrapper getattr(get_builder(document), 'inventory')(*args, **kwds) File "/scratch/sage/src/doc/common/builder.py", line 487, in _wrapper x.get(99999) File "/scratch/sage/local/lib/python/multiprocessing/pool.py", line 554, in get raise self._value OSError: [geometry ] /scratch/sage/src/doc/en/reference/geometry/index.rst:47: ERROR: Unexpected indentation. make: *** [dochtml] Error 1
comment:44 Changed 5 years ago by
 Branch changed from u/glaun/ticket/9439 to public/ticket/9439
 Commit changed from 354158f495a556c599cb6170276658762a0118c3 to 7371810de8f1fc99cfa9cc230a2892a695ab9d99
 Status changed from needs_work to needs_review
comment:45 Changed 5 years ago by
 Commit changed from 7371810de8f1fc99cfa9cc230a2892a695ab9d99 to fe22a753e12f7779c4ab70dd733a917915fa84f4
Branch pushed to git repo; I updated commit sha1. New commits:
23181c4  Merge branch 'u/glaun/ticket/9439' of trac.sagemath.org:sage into public/geometry/hyperbolic9439

24fc77c  First pass of review changes.

2a64983  Some additional review changes.

95dd29e  Merge branch 'develop' into public/geometry/hyperbolic9439

f1f8302  Merge branch 'develop' into public/geometry/hyperbolic9439

656680f  Merge branch 'develop' into public/geometry/hyperbolic9439

8023779  Merge branch 'public/ticket/9439' of trac.sagemath.org:sage into public/geometry/hyperbolic9439

fe22a75  Some tweaks from the merge.

comment:46 Changed 5 years ago by
I've made some convention fixes and cleanup. I also have the following comments:
 I'm not completely sure the framework that is currently there shouldn't be restructured as abstract base classes as you're not creating an army of hyperbolic spaces, just one in each type with data from a "database". Moreover there seems to be a lot of redundancy.
 I think too much is getting imported into the global namespace (ex.
UHP
) which could have potential conflicts and in many ways is a strange acronym. It would probably be better to have them located viaHyperbolicSpace
(which would be a factory function or the base class with a__classcall__
) and/or a catalog importhyperbolic_space
.
I will have to think more about the first one. The second should be done at some point unless there is a very good argument otherwise IMO.
comment:47 Changed 5 years ago by
I'm glad to see other people working on this ticket! I tried to pull the updates and rebuild sage, but it won't build. It may be a few days before I have time to debug the build process and get back to work on this ticket.
In response to your points, I'm fine with a restructure as long as we talk it through first.
 Its design now uses abstract base classes for geodesics, isometries, and points. In the current organization, the "database" of facts about the underlying space are in hyperbolic_model, divided by model. The "database" of calculation methods are in hyperbolic_methods, of which only the methods in the upper half plane are implemented. I think these should be separate because it allows someone to implement a model without ever having to see the details of how calculations are done. I suppose we could put the database somewhere else, like in a dictionary or database if that's wise. I don't have strong opinions about that. Is the organization unclear? Let me know if you have specific ideas in mind, or even if you just want to discuss overall design philosophy.
 I wasn't aware of
__classcall__
when I wrote it. I was basically just going for doing a clean design. It seems like__classcall__
might be a modularity violation? I'll look into it more.
 It sounds like you're objecting to importing the interfaces into the global namespace. I'm fine with getting rid of those imports. We could do something like
UHP = HyperbolicPlane("upper half plane") UHP.point(I)
and then only import HyperbolicPlane?. Is that the sort of thing you had in mind? Or maybe something like
p = HyperbolicPoint(I, "upper half plane") # Create point 0 + I.
comment:48 Changed 5 years ago by
 Commit changed from fe22a753e12f7779c4ab70dd733a917915fa84f4 to 3a043392d7b6c21a186303c4990204e06da00a6c
Branch pushed to git repo; I updated commit sha1. New commits:
3a04339  Fixed failing test.

comment:49 Changed 5 years ago by
 Milestone changed from sage6.3 to sage6.4
comment:50 Changed 5 years ago by
 Commit changed from 3a043392d7b6c21a186303c4990204e06da00a6c to 58947b55679d1bd4b5b7c3d0804094653a17e830
comment:51 Changed 5 years ago by
 Commit changed from 58947b55679d1bd4b5b7c3d0804094653a17e830 to b7fa036b162e09cc5500c0fc67633dcc2b9e6786
comment:52 Changed 5 years ago by
 Branch changed from public/ticket/9439 to public/geometry/hyperbolic9439
 Commit changed from b7fa036b162e09cc5500c0fc67633dcc2b9e6786 to 37287f35acfced2696dff3126e36cba8578a96f4
 Reviewers changed from Johan Bosman to Johan Bosman, Travis Scrimshaw
 Status changed from needs_review to needs_info
Okay, so I've done a major refactoring in which I move everything into Sage's category/parent/element framework. In doing so, I figured out why all of the @classmethod
bothered me (beyond the somewhat mazelike path of methods); it was emulating a singleton pattern using classes rather than instances. To me, this is a bad practice, so I'm now using UniqueRepresentation
(although this would benefit from switching to #15247). So here's the other major points and structure.
 The models are parents using the
WithRealizations
framework, and the points are the elements. I've setup the maps between the models are coercions and have methods to also translate the geodesics and isometries. Geodesics are justSageObject
's, but isometries are morphisms.  I've changed the naming of some of the methods to better reflect their operation (in particular,
orientation_preserving
topreserves_orientation
).  I've kept most of the ease of implementing new models but by using the coercions instead of the methods class.
 I've implemented a custom hash for isometries since compared equal but had different hashes.
 More strict handling of points vs. coordinates and isometries vs. matrices. This makes the programmers/users take more care about where things belong and what one can do with them. This adds a little more burden of wrapping and unwrapping, but it shouldn't make things much (significant) difference in timings (I didn't check). Yet I would argue this is a better way of doing things.
 Removed the
**graphic_options
from things likeperpendicular_bisector
because it seemed out of place and makes it easier to keep things consistent (plus 2 distinct steps for distinct operations).  There is only one big lazy import needed, and that is for
HyperbolicPlane
, which is the global entry point. I've added a methodHyperbolicSpace
for the future, but I didn't import it into the global namespace.
Questions:
 If given an isometry, does one ask if it "is orientation preserving" or "preserves orientation"?
 Should we keep with the
get_*
(ex.get_point
) or just drop it to*
(ex.point
resp.)? I'm somewhat in favor of the way it is now, but I don't have a strong opinion.
Todo for positive review:
 Add doctests to remaining
hyperbolic_coercion.py
methods.  Fix doctest failures coming from
_to_std_geod
. I'm pretty sure it is not suppose to return an isometry (which is what causes the doctest failures). Please advise.
Todos for the future:
 Make custom endosets for each model with the isometries as elements and coercions implemented once homsets work with the coersion model (#14279 and possibly others).
 Implement a category for metric spaces.
I was quite impressed with the code and the interactions between everything and hope we can get more of (hyperbolic) geometry into Sage. So please test out, look over, and play with the refactored version (making sure everything works as before).
PS  Phew, finally had some time to sit down to think and work through this. Sorry it took so long.
New commits:
a77a115  Merge branch 'public/ticket/9439' of trac.sagemath.org:sage into public/geometry/hyperbolic9439

87f703a  Some more trivial cleanup.

2759b74  Changed global interface to HyperbolicPlane.

0572434  About 85% of the refactoring is done and basic functionality is working.

b203a53  Some more refactoring and starting to fix doctests.

5747604  Merge branch 'develop' into public/geometry/hyperbolic9439

42f8a7d  More cleanup work.

872e453  Finished refactoring and most doctest pass.

37287f3  Some more doctest and bug fixes.

comment:53 Changed 5 years ago by
 Branch changed from public/geometry/hyperbolic9439 to u/glaun/ticket/9439
 Modified changed from 09/14/14 07:25:28 to 09/14/14 07:25:28
comment:54 followup: ↓ 55 Changed 5 years ago by
 Commit changed from 37287f35acfced2696dff3126e36cba8578a96f4 to 222c2ad0611bc609c7a24f934a8fe6cef5cc6792
Thanks for your help on the code. I'm glad you were able to get things working with the sage parent/element/etc framework. I wasn't quite sure how to do that.
There are still bugs that I know about and have fixed in other branches, but which haven't been merged into this branch yet. I'll hopefully have time to commit a patch that fixes the remaining bugs that I know about in the next week or two.
New commits:
c612e31  Fixed two or three test failures in hyperbolic_geodesic.py.

222c2ad  All tests now pass for hyperbolic_geodesic.py. In particular, _to_std_geod tests are fixed.

comment:55 in reply to: ↑ 54 Changed 5 years ago by
Replying to glaun:
Thanks for your help on the code. I'm glad you were able to get things working with the sage parent/element/etc framework. I wasn't quite sure how to do that.
Not a problem. I hope a lot of the design is clear and makes sense. There's still a general question of what to do with subsets (here geodesics) of a given set (the entire plane) in terms of parents (so we can induce coercions on the subsets [geodesics]), but that is a separate, quite large, and probably thorny issue that we can't solve here.
There are still bugs that I know about and have fixed in other branches, but which haven't been merged into this branch yet. I'll hopefully have time to commit a patch that fixes the remaining bugs that I know about in the next week or two.
Let me know as things get merged in and I can review those changes so we can get this included into Sage.
FYI, a typo got introduced in c612e31
:
@@ 528,7 +528,7 @@ class HyperbolicGeodesic(SageObject): """ return self._cached_geodesic.reflection_involution().to_model(self._model)  def common_perpendicular(self, other): + def common_perpendicula(self, other): r""" Return the unique hyperbolic geodesic perpendicular to two given geodesics, if such a geodesic exists. If none exists, raise a
comment:56 Changed 5 years ago by
Ahh, thanks for finding the typo!
The design is very clear, and it's nice to read someone's improvement of your code. I plan to print out the code and make sure it makes sense from a bird's eye view, and to address the issue of what to do with subsets. But that may not happen until a few weeks from now.
At present, I'm writing up a paper that uses the code, which means I'll be looking a lot at individual lines of code but not so much at organization. Once I eliminate the remaining bugs that I've run into, I'll get to work on making the patch suitable for inclusion in Sage.
There are also some functions whose names I have always disliked  such as _to_std_geod  but for which I haven't yet found suitable replacements. I'll try to clean that up too, when I'm working on making sure the parent/element architecture does everything we need it to.
comment:57 Changed 5 years ago by
So what's left to review or what other bugs have you come across? Unfortunately we won't get this in 6.4, but I feel like this is very close to being done.
Also don't worry about dealing with subsets. As I mentioned, there are more general Sage design decisions that will need to be made and what we currently have is sufficient.
comment:58 Changed 5 years ago by
 Commit changed from 222c2ad0611bc609c7a24f934a8fe6cef5cc6792 to a1c4496109c119d3d44cacf31b6c87108dab1ba8
Branch pushed to git repo; I updated commit sha1. New commits:
b558754  Fixed a bug in isometry_from_fixed_points.

45392f4  Partial progress toward getting reflection_involution working properly with coercion UHP > PD.

1f8d109  May need to roll this one back. Uncertain if it's an improvement.

6d7c46d  Fixed associativity issue with PD orientationpreserving and orientationreversing isometries.

81ecbb0  Fixed test failures caused by the previous bug fixes.

a1c4496  Added tests to hyperbolic_isometry.py.

comment:59 Changed 5 years ago by
Sorry to have disappeared for a while. I had an insane schedule for a few weeks. I just pushed the latest code I have. It passes all tests and has 100% coverage.
I fixed the one major bug that I knew about. The bug had to do with orientationreversing isometries in the two models that use SO(2,1); namely, the hyperboloid model and the Klein disk. I solved the problem by doing isometry multiplication in the upeer half plane model.
New commits:
b558754  Fixed a bug in isometry_from_fixed_points.

45392f4  Partial progress toward getting reflection_involution working properly with coercion UHP > PD.

1f8d109  May need to roll this one back. Uncertain if it's an improvement.

6d7c46d  Fixed associativity issue with PD orientationpreserving and orientationreversing isometries.

81ecbb0  Fixed test failures caused by the previous bug fixes.

a1c4496  Added tests to hyperbolic_isometry.py.

New commits:
b558754  Fixed a bug in isometry_from_fixed_points.

45392f4  Partial progress toward getting reflection_involution working properly with coercion UHP > PD.

1f8d109  May need to roll this one back. Uncertain if it's an improvement.

6d7c46d  Fixed associativity issue with PD orientationpreserving and orientationreversing isometries.

81ecbb0  Fixed test failures caused by the previous bug fixes.

a1c4496  Added tests to hyperbolic_isometry.py.

comment:60 Changed 5 years ago by
 Branch changed from u/glaun/ticket/9439 to public/geometry/hyperbolic9439
 Commit changed from a1c4496109c119d3d44cacf31b6c87108dab1ba8 to c5dfd89e923df732ffb868dcf2a22f48b5d32a44
 Reviewers changed from Johan Bosman, Travis Scrimshaw to Johan Bosman, Travis Scrimshaw, Greg Laun
 Status changed from needs_info to needs_review
No worries; I completely understand (and will likely have to do the same thing shortly).
So, I've updated it to the latest develop version, fixed (trivial) doctests from that, and added full coverage to hyperbolic_coercion.py
(which I should've done in the first place). If there are no obvious major bugs, then you can set a positive review.
New commits:
c6eb9a0  Merge branch 'u/glaun/ticket/9439' of trac.sagemath.org:sage into public/geometry/hyperbolic9439

c5dfd89  Final fixes and touchups.

comment:61 Changed 5 years ago by
Please remove the trailing whitespaces in:
hyperbolic_geodesic.py
hyperbolic_model.py
comment:62 Changed 5 years ago by
 Commit changed from c5dfd89e923df732ffb868dcf2a22f48b5d32a44 to 015086df733e2c0a5bab26962aa9d0ff2ca08161
Branch pushed to git repo; I updated commit sha1. New commits:
015086d  trac #9439 whitespace removal plus other cosmetic cleanup

comment:63 Changed 5 years ago by
 Commit changed from 015086df733e2c0a5bab26962aa9d0ff2ca08161 to ef79bb7533500e8fa84faeca2197350e46e999df
Branch pushed to git repo; I updated commit sha1. New commits:
ef79bb7  trac #9439 correct doc index

comment:64 Changed 5 years ago by
 Reviewers changed from Johan Bosman, Travis Scrimshaw, Greg Laun to Johan Bosman, Travis Scrimshaw, Greg Laun, Frederic Chapoton
Thanks Frederic. I'm happy with your changes. So then I believe the only thing left is for someone to review c5dfd89.
comment:65 Changed 5 years ago by
 Commit changed from ef79bb7533500e8fa84faeca2197350e46e999df to 8789fdce0cd66dd71243be5f6466b2e5951cc9ce
comment:66 Changed 5 years ago by
 Commit changed from 8789fdce0cd66dd71243be5f6466b2e5951cc9ce to 82cf89e367b6f95cf44fdfb7b040974d4e247f94
Branch pushed to git repo; I updated commit sha1. New commits:
82cf89e  trac #9439 fine tuning the doc

comment:67 Changed 5 years ago by
I am a bit worried by the fact that some tests are longer than 1s, see
sage bt long warnlong src/sage/geometry/hyperbolic_space/*.py
Otherwise, things look good.
comment:68 Changed 5 years ago by
 Reviewers changed from Johan Bosman, Travis Scrimshaw, Greg Laun, Frederic Chapoton to Johan Bosman, Travis Scrimshaw, Greg Laun, Frédéric Chapoton
 Status changed from needs_review to positive_review
Some of those breakage of pep8 was to make it more readable, but I'm not opposed to those changes. However I am happy overall with your changes, and I'm treating your comments as positive review on the previous part. Also it's okay for long tests to be longer than 1s (at least, you're testing them), but if they were not marked as # long time
, then my philosophy is if they are longer than 23s on my machine, then I mark them as long.
Therefore I'm going to set this to a positive review.
comment:69 Changed 5 years ago by
 Branch changed from public/geometry/hyperbolic9439 to 82cf89e367b6f95cf44fdfb7b040974d4e247f94
 Resolution set to fixed
 Status changed from positive_review to closed
comment:70 Changed 5 years ago by
 Commit 82cf89e367b6f95cf44fdfb7b040974d4e247f94 deleted
 Keywords days64 added
comment:71 Changed 5 years ago by
First off: It's very nice to see the ticket closed. :)
Just a side remark: I noticed that complex embeddings are used a lot for points (be it by using imag for boundary points or CC). Unfortunately this doesn't work for relative number fields (no support for specifying default embeddings yet). I use those to do exact calculations with hyperbolic fixed points of hecke triangle group elements. I guess I'm hoping that relative number fields will be improved. :)
comment:72 Changed 5 years ago by
I think it would be good to have as a followup being able to specify which field you want to work over (for example, the benefit of being able to specify precision). However I felt that this was a very good step forward to include into Sage (and I don't care so much about having a perfect solution at the beginning but going in steps towards the optimal solution, but perhaps I'm in the minority...).
comment:73 Changed 5 years ago by
Oh, I very much agree with going in steps and I'm glad the ticket got closed, good job! :)
Also: The issue I mentioned is much more about (relative) number fields than this implementation (i.e. I'm offtopic and should probably have sent this to sagedevel).
I guess one of the main issues is that (relative) number fields in sage are mostly "designed" without a fixed choice of embedding ("they are not viewed as part of complex numbers / hyperbolic plane"). Still they are quite important when doing arithmetic/number theory/exact calculations...
Even in the absolute case a fixed field needs to be choosen for the default embedding. To make it work in general one has to use something that coerces into many fields, e.g. AA/QQbar. Side question: Conceptually how would one organize/order the embeddings in a meaningful way? (I'm not sure how they are ordered at the moment.)
The issue with number fields also comes up when dealing with isometries/matrices over number fields and the group action...
Regards Jonas
comment:74 Changed 5 years ago by
I don't think I can answer many of those questions because my knowledge in that part of math (and definitely of Sage) is likely insufficient. I think moving this to sagedevel is the best way to get the answers you're after.
draft of hyperbolic geometry space