#5039: Improve DisjointSet documentation
------------------------------------+---------------------------------------
Reporter: slabbe | Owner: slabbe
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-5.9
Component: combinatorics | Resolution:
Keywords: | Work issues:
Report Upstream: N/A | Reviewers:
Authors: Travis Scrimshaw | Merged in:
Dependencies: | Stopgaps:
------------------------------------+---------------------------------------
Changes (by tscrim):
* status: needs_info => needs_review
Old description:
> The Elements of `SetPartitions` of a set A are actually Sets of Sets. But
> there are specific functionalities I would like for those "Sets of Sets".
> For example : merge the classes of a an b and ask what is the
> representant of a, where a, b are in A.
>
> Right now, Arnaud Bergeron and I coded and named it as `DisjointSet` and
> it is available in the sage-combinat tree. The implementation is inspired
> from :
>
> http://en.wikipedia.org/wiki/Disjoint_set_data_structure
>
> See also this thread :
> http://groups.google.com/group/sage-combinat-
> devel/browse_thread/thread/4b6d5bb2983d81c2/f52adb855eb3b09f?lnk=gst&q=disjoint+set#f52adb855eb3b09f
New description:
Previous title: Create a class for SetPartition (with no s)
The Elements of `SetPartitions` of a set A are actually Sets of Sets. But
there are specific functionalities I would like for those "Sets of Sets".
For example : merge the classes of a an b and ask what is the representant
of a, where a, b are in A.
Right now, Arnaud Bergeron and I coded and named it as `DisjointSet` and
it is available in the sage-combinat tree. The implementation is inspired
from :
http://en.wikipedia.org/wiki/Disjoint_set_data_structure
See also this thread :
http://groups.google.com/group/sage-combinat-
devel/browse_thread/thread/4b6d5bb2983d81c2/f52adb855eb3b09f?lnk=gst&q=disjoint+set#f52adb855eb3b09f
Since this has already been done in #6775, I've recycled this ticket to
improve the documentation for `DisjointSet`.
--
Comment:
Replying to [comment:4 ncohen]:
> * Could you update the ticket's title and description ?
Done
> * Why did you move the description of the data structure from the module
to the function ? `:-/` I prefer when it is at the top of the html
documentation, and here you have no idea of what is happening in that
module... Plus there is a function and three classes in that module, so
something should be said at the module level `:-/`
The main reason is for viewing the interactive doc using `DisjoinSet?`
since getting the module level doc interactively is unintuitive IMO. I
have I've added somethings to the module level directing you to the
function for more info.
> * I know it's not the point of this ticket but what would you think of
changing `cardinality()` so that it actually returns the cardinality of
the partition, and not the cardinality of its union ? And have another
method named "`number_of_elements`" which would return what `cardinality`
currently returns ? Would make more sense, wouldn't it ? It does not have
to be in this ticket, though.
Part of me says yes, part no. However because this is how it's been, I
don't want to make any changes. If you feel strongly about it, you can
make the change on another ticket.
> Nice patch though ! Always good to improve the doc `:-)`
Thank you. Ready for review again.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/5039#comment:5>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
