#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: Daniel Krenn | Author:
Merged: | Dependencies:
-----------------------------+----------------------------------------------
Changes (by dkrenn):
* status: needs_review => needs_work
Comment:
Looks much better now. It would be nice to follow the
[http://www.sagemath.org/doc/developer/conventions.html conventions]
(somewhere in the middle there is an example {{{def point...}}}
(...template when documenting functions)). E.g. use {{{`}}} and {{{``}}}
at the places where variables or formulas (interval) are.
Further I suggest to put {{{sage: entropy(1.1, 2)}}} and {{{sage:
entropy(1, 1)}}} under a separate section {{{TESTS::}}}, since to me it
seems more like a test than an example showing some functionality.
Maybe you can also add the following example (change the values if you
want others) to {{{EXAMPLES}}}:
{{{
sage: entropy(1/5,4)
-1/5*log(1/5)/log(4) - 4/5*log(4/5)/log(4) + 1/5*log(3)/log(4)
}}}
so that we have an example (with values that are not a special case).
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/12013#comment:8>
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.
