#12013: Fix entropy function in devel/sage/sage/coding
-----------------------------+----------------------------------------------
Reporter: ppurka | Owner: wdj
Type: defect | Status: needs_work
Priority: minor | Milestone: sage-5.0
Component: coding theory | Keywords: entropy coding theory
Work_issues: | Upstream: N/A
Reviewer: | Author:
Merged: | Dependencies:
-----------------------------+----------------------------------------------
Changes (by dkrenn):
* status: needs_review => needs_work
Comment:
There should be a doctest for the inputs {{{x=0}}} and {{{x=1}}}.
Maybe the message of
{{{
raise ValueError("The entropy function is undefined for values not between
0 and 1")
}}}
should be more precise (since there is more than one input parameter),
e.g. something like
{{{
"The value x (x = %s) must be between 0 and 1." % x
}}}
Can you also improve the documentation by describing the input parameters
{{{x}}} and {{{q}}} and add one or two examples?
I'm not sure, whether it should also be checked that {{{q}}} is positive.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/12013#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 post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.