#19677: Document the output type of Graph.matching(value_only=True)
--------------------------------+--------------------------
       Reporter:  tmonteil      |        Owner:
           Type:  defect        |       Status:  needs_work
       Priority:  major         |    Milestone:  sage-6.10
      Component:  graph theory  |   Resolution:
       Keywords:                |    Merged in:
        Authors:                |    Reviewers:
Report Upstream:  N/A           |  Work issues:
         Branch:                |       Commit:
   Dependencies:                |     Stopgaps:
--------------------------------+--------------------------
Changes (by tmonteil):

 * status:  needs_review => needs_work
 * milestone:  sage-duplicate/invalid/wontfix => sage-6.10


Old description:

> Currently the `Graph.matching` method returns a float or an integer when
> called with `value_only` set to `True`, while, as a cardinality, it
> should always return an integer.
>
> {{{
> sage: G = graphs.RandomBipartite(10,10,0.5)
> sage: type(G.matching(value_only=True))
> <type 'float'>
>
> sage: type(G.matching(use_edge_labels=False,value_only=True))
> <type 'sage.rings.integer.Integer'>
> }}}

New description:

 Currently the `Graph.matching` method returns a float or an integer when
 called with `value_only` set to `True`, depending on `use_edge_labels`
 option.

 {{{
 sage: G = graphs.RandomBipartite(10,10,0.5)
 sage: type(G.matching(value_only=True))
 <type 'float'>

 sage: type(G.matching(use_edge_labels=False,value_only=True))
 <type 'sage.rings.integer.Integer'>
 }}}

 Let us make this explicit in the documentation.

--

Comment:

 Finally i think that something is missing in the doc so that we do not
 have to read the source code to predict the output.

--
Ticket URL: <http://trac.sagemath.org/ticket/19677#comment:2>
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.
For more options, visit https://groups.google.com/d/optout.

Reply via email to