#18269: A new structure for experimentation on decoding: communication channels
-------------------------+-------------------------------------------------
       Reporter:         |        Owner:
  dlucas                 |       Status:  needs_work
           Type:         |    Milestone:  sage-6.7
  enhancement            |   Resolution:
       Priority:  major  |    Merged in:
      Component:         |    Reviewers:
  coding theory          |  Work issues:
       Keywords:         |       Commit:
        Authors:         |  62a2447c45d3d2878f2da037ea4721464bef2ea4
Report Upstream:  N/A    |     Stopgaps:
         Branch:         |
  u/dlucas/channels      |
   Dependencies:         |
-------------------------+-------------------------------------------------

Comment (by dlucas):

 Hello,

 Thank you for the input!

 >I would rather hide them under `codes.channels.<name>`. That way you can
 avoid the file `channels_catalog`.
 >Why `sage.coding.channel_constructions` and not `sage.coding.channels`?

 My idea here was to mimic the way codes were stored and hide: a
 code_constructions file for the codes, and a codes_catalog file for the
 list of codes. I wanted to do the same with channels for consistency.
 That's why I chose the name channel_constructions.
 Hiding the channels under codes.channels.<name> might be confusing (imho):
 one can think that channels depends on codes, which is not the case as
 they are completely independant objects. So they can be used on any
 vector, not only on codewords, or for experimentation on decoding. Which
 also explains why the documentation looks like an isolated block, I wrote
 it as a new object, independant from codes.

 >The functions `_random_error_position`, `_random_error_vector` and
 `_tuple_to_integer` will not appear in the documentation. You should
 either remove the `_` at the begining or add some `automethod` sphinx
 directives (you have to look in the code to find how to do it)

 Well, that was done on purpose as one should not use these methods except
 when implementing a new Channel object. Now, with a second thought about
 this, it's not that smart as one will have to browse through the code to
 find these methods. I think I'll remove the underscore to make them appear
 in the doc, while putting the statement "This is a helper function, for
 internal use only." in a `..NOTE::` block to highlight this.

 For the rest of your comments, thanks a lot for the advice on these
 `random` issues. I'll change the code accordingly.

 David

--
Ticket URL: <http://trac.sagemath.org/ticket/18269#comment:4>
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