#20908: Rework index and catalogs in sage.coding
-------------------------------------+-------------------------------------
Reporter: dlucas | Owner:
Type: enhancement | Status: needs_info
Priority: major | Milestone: sage-7.3
Component: coding theory | Resolution:
Keywords: | Merged in:
Authors: David Lucas | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/dlucas/consistency_in_coding_catalogs|
71655889e2dbb16d4473e49c1bc09eef1a2d2b79
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by jsrn):
Suggestion for headlines in `index.rst`. Note that I'm not including every
single module; I'm not sure that makes sense.
You can change the title a module gets in a toc by writing "This is my
title <mymodule>" instead of simply "mymodule".
{{{
# Coding Theory objects
- Linear Code and its abstract base class
- Decoder
- Encoder
- Channel
# Catalogs
- Index of channels
- Index of codes
- Index of decoders
- Index of encoders
# Code Constructions
- Constructing a linear code given a generator matrix <linear_code>
The named code families below are represented in Sage by their own
classes, allowing specialised implementations of e.g. decoding or
computation of properties.
- Generalized Reed-Solomon code
- Hamming code
In contrast, for some code families Sage can only construct their
generator matrix and has no other a priori knowledge on them.
- Code families whose generator matrix can be constructed
- Generator matrices construced using GAP-Guava
- Database of two-weight codes
- Self-dual binary codes
- Binary codes, fast implementation
# Methods and Operations related to Linear Codes
- Bounds on linear codes <index of bounds>
- Delsarte upper bounds, a.k.a. Linear Programming upper bounds
- Canonical forms and automorphisms for linear codes over finite fields
# Source coding
- Huffman Encoding
# Indices and Tables
- Bla bla
}}}
Other notes:
- It's a pity that Guruswami--Sudan is not easily seen when browsing Reed
--Solomon codes. It could be added with a note to the top of the doc of
`grs.py`.
- The module `code_bounds` is just a messy version of the index of bounds.
So do we want a link to it? Further, I didn't put this index under
"Catalogs" since its more of a module than a catalogue. Also, it's semi-
deprecated so we don't want to give it too much attention ;-)
Best,
Johan
--
Ticket URL: <https://trac.sagemath.org/ticket/20908#comment:3>
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 https://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
