Skip to content

Better coset accessors & documentation #4283

Open
@fingolfin

Description

@fingolfin

While looking at PR #4274 modifying the group cosets code I started to wonder: For a GroupCoset in variable x,

  1. what is the getter to retrieve x.G? I found none
  2. what is the getter to retrieve x.H? Searching the code I found
    acting_domain(C::GroupCoset) = C.H
    While it makes some sense to me (if one considers a right coset Hg as a G-set, namely the (left!) orbit of g under H) I don't think most people would find it. Can we come up with a better name? (The old one should stay supported to be non-breaking). Perhaps at least acting_group?
  3. Turns out for GroupDoubleCoset we use left_acting_group and right_acting_group ... some consistency in terminology might be helpful.
  4. Regardless of that, the accessors for x.G and x.H as well as representative(x) should be made to easier to find -- I suggest the docstrings for GroupCoset as well as right_coset and left_coset should [@ref] these accessors and perhaps also include a doctest example showing their use? Though arguably it is enough to point at these functions, then their docstrings can contain usage examples.
  5. Similar for double cosets (i.e. mention accessors in docstrings)

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions