Opened 6 months ago

Closed 4 months ago

#31718 closed enhancement (fixed)

ManifoldSubset: Change some methods to generators

Reported by: mkoeppe Owned by:
Priority: major Milestone: sage-9.4
Component: manifolds Keywords:
Cc: gh-mjungmath, egourgoulhon, tscrim Merged in:
Authors: Matthias Koeppe Reviewers: Eric Gourgoulhon
Report Upstream: N/A Work issues:
Branch: e026e7a (Commits, GitHub, GitLab) Commit: e026e7a68095577277de1b32df0f8c446b594aa7
Dependencies: #31680 Stopgaps:

Status badges

Description (last modified by mkoeppe)

This ticket proposes to change some methods that currently return lists to generators - like the method open_supersets added in #31677. This is in line with the changes in the Python standard library when we moved from Python 2 to 3.

ManifoldSubset:

  • open_covers() currently returns a list of lists
    • change to generator of ManifoldSubsetFiniteFamily instances
    • add optional argument trivial to simplify the common use case that only needs the nontrivial open covers
  • subsets() currently returns a frozenset
    • change to generator of ManifoldSubset instances

These API changes will probably make some updates to sage.manifolds worksheets that are maintained outside of the Sage tree necessary.

Follow-up for some methods of Manifold in #31720.

Change History (15)

comment:1 Changed 6 months ago by mkoeppe

  • Branch set to u/mkoeppe/manifoldsubset__manifold__change_some_methods_to_generators

comment:2 Changed 6 months ago by mkoeppe

  • Commit set to 186707ba9fe840040c6675421a65f28fc4f3999e
  • Description modified (diff)

New commits:

186707bManifoldSubset.subsets: Change to generator

comment:3 Changed 6 months ago by mkoeppe

  • Description modified (diff)

comment:4 Changed 6 months ago by git

  • Commit changed from 186707ba9fe840040c6675421a65f28fc4f3999e to 78cc27a8e439c542c2f03958e8e0888b0551a979

Branch pushed to git repo; I updated commit sha1. Last 10 new commits:

42abda7Adding __bool__ for other families.
1f21a8fMerge #31717
f095988FiniteManifoldObjectFamily.__bool__: Remove, inherited from superclass after #31717
5d87ceeManifold{Object,Subset}FiniteFamily: Rename from FiniteManifold{Object,Subset}Family
2f2ace2src/doc/en/reference/manifolds/manifold.rst: Add sage.manifolds.family
1aff58aFix up docstring markup
b922066ManifoldSubsetFiniteFamily: If all subsets are open, include 'open' in repr
30271afFixup doctest
adac07aMerge #31680
78cc27aManifoldSubset.open_covers: Change to generator, add optional arg 'trivial'; update uses

comment:5 Changed 6 months ago by mkoeppe

  • Authors set to Matthias Koeppe
  • Description modified (diff)
  • Status changed from new to needs_review
  • Summary changed from ManifoldSubset, Manifold: Change some methods to generators to ManifoldSubset: Change some methods to generators

comment:6 Changed 6 months ago by git

  • Commit changed from 78cc27a8e439c542c2f03958e8e0888b0551a979 to e026e7a68095577277de1b32df0f8c446b594aa7

Branch pushed to git repo; I updated commit sha1. New commits:

e026e7aManifoldSubset.subset_digraph: Use open_covers method

comment:7 Changed 6 months ago by mkoeppe

  • Description modified (diff)

comment:8 Changed 6 months ago by egourgoulhon

  • Reviewers set to Eric Gourgoulhon
  • Status changed from needs_review to positive_review

LGTM. Thanks!

comment:9 Changed 6 months ago by mkoeppe

Thanks for reviewing!

comment:10 follow-up: Changed 6 months ago by gh-mjungmath

I assume it has a purpose, but just out of curiosity: why do you make a difference between families of manifold objects and families of manifold subsets? Do you have a further usage in mind other than just subsets? Because all the examples you provide are still with subsets.

comment:11 Changed 6 months ago by gh-mjungmath

I can imagine this can be useful for frames whose domains cover the manifold? Perhaps this is a more suitable example for the non-subset case to show the difference?

Some time ago I provided a helper function _get_min_covering (can be found in manifolds/manifold.py) to obtain a minimal amount of manifold objects necessary to cover the manifold. It looks like this method is more suited within the family class you just provided.

Another example in the field I could imagine is for orientations. An orientation is given by a family of charts/frames, too, but yet not implemented as such.

Last edited 6 months ago by gh-mjungmath (previous) (diff)

comment:12 in reply to: ↑ 10 ; follow-up: Changed 6 months ago by mkoeppe

Replying to gh-mjungmath:

I assume it has a purpose, but just out of curiosity: why do you make a difference between families of manifold objects and families of manifold subsets? Do you have a further usage in mind other than just subsets?

Yes, in #31732 I use ManifoldObjectFiniteFamily directly for the family of open covers. Its elements are ManifoldSubsetFiniteFamily instances.

I agree that charts/frames are likely to benefit from becoming finite families too. This will also need a separate subclass because they are indexed not by names but by coordinate tuples.

comment:13 in reply to: ↑ 12 ; follow-up: Changed 6 months ago by gh-mjungmath

Replying to mkoeppe:

Replying to gh-mjungmath:

I assume it has a purpose, but just out of curiosity: why do you make a difference between families of manifold objects and families of manifold subsets? Do you have a further usage in mind other than just subsets?

Yes, in #31732 I use ManifoldObjectFiniteFamily directly for the family of open covers. Its elements are ManifoldSubsetFiniteFamily instances.

Alright, that makes sense. Just a personal taste: I think its better to add some distinct examples to ManifoldObjectFiniteFamily to clarify the difference to ManifoldSubsetFiniteFamily.

I agree that charts/frames are likely to benefit from becoming finite families too. This will also need a separate subclass because they are indexed not by names but by coordinate tuples.

Right. But don't you think it should rather be a new common parent class both inherit from?

In any case, this is something definitely need, indeed!

comment:14 in reply to: ↑ 13 Changed 6 months ago by mkoeppe

Replying to gh-mjungmath:

I think its better to add some distinct examples to ManifoldObjectFiniteFamily to clarify the difference to ManifoldSubsetFiniteFamily.

Sure, let's do that when we introduce some more applications to families.

Replying to mkoeppe:

I agree that charts/frames are likely to benefit from becoming finite families too. This will also need a separate subclass because they are indexed not by names but by coordinate tuples.

Right. But don't you think it should rather be a new common parent class both inherit from?

Sure, that makes sense.

In any case, this is something definitely need, indeed!

Let's take this discussion to #31720 (Manifold: Change some methods to generators), which introduces generators for charts. Families could be introduced in the same ticket -- but I will need some guidance there what the keys should be.

comment:15 Changed 4 months ago by vbraun

  • Branch changed from u/mkoeppe/manifoldsubset__manifold__change_some_methods_to_generators to e026e7a68095577277de1b32df0f8c446b594aa7
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.