Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
Some polishing, and promote linear_code in documentation index
Browse files Browse the repository at this point in the history
  • Loading branch information
johanrosenkilde committed May 25, 2016
1 parent 1efb48e commit 9c82dcd
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
4 changes: 2 additions & 2 deletions src/doc/en/reference/coding/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ Linear codes and related constructions
.. toctree::
:maxdepth: 1

sage/coding/binary_code
sage/coding/linear_code
sage/coding/grs
sage/coding/hamming_code
sage/coding/guruswami_sudan/gs_decoder
sage/coding/guruswami_sudan/interpolation
sage/coding/guruswami_sudan/rootfinding
sage/coding/guruswami_sudan/utils
sage/coding/linear_code
sage/coding/code_constructions
sage/coding/sd_codes
sage/coding/guava
sage/coding/binary_code

Bounds on codes
---------------
Expand Down
23 changes: 13 additions & 10 deletions src/sage/coding/linear_code.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,27 +28,30 @@
=========================
Linear codes are either studied as generic vector spaces without any known
structure, or as particular sub-families with special properties. The class
:class:`sage.coding.linear_code.LinearCode` is used to represent the former. For
the latter, these will be represented by specialised classes; for instance, the
family of Hamming codes are represented by the class
:class:`sage.coding.hamming_code.HammingCode`. Type ``codes.<tab>`` for a list of
all code families known to Sage. Such code family classes should inherit from
structure, or as particular sub-families with special properties.
The class :class:`sage.coding.linear_code.LinearCode` is used to represent the
former.
For the latter, these will be represented by specialised classes; for instance,
the family of Hamming codes are represented by the class
:class:`sage.coding.hamming_code.HammingCode`. Type ``codes.<tab>`` for a list
of all code families known to Sage. Such code family classes should inherit from
the abstract base class :class:`sage.coding.linear_code.AbstractLinearCode`.
``AbstractLinearCode``
----------------------
This class is a base class designed to contain methods, features and parameters
This is a base class designed to contain methods, features and parameters
shared by every linear code. For instance, generic algorithms for computing the
minimum distance, the covering radius, etc. Many of these algorithms are slow,
e.g. exponential in the code length. For specific subfamilies, better algorithms
or even closed formulas might be known, in which case the respective method
should be overridden.
``AbstractLinearCode`` is an abstract class for linear code classes, so any
linear code class should inherit from this class. Also ``AbstractLinearCode``
should never itself be instantiated.
``AbstractLinearCode`` is an abstract class for linear codes, so any linear code
class should inherit from this class. Also ``AbstractLinearCode`` should never
itself be instantiated.
See :class:`sage.coding.linear_code.AbstractLinearCode` for details and
examples.
Expand Down

0 comments on commit 9c82dcd

Please sign in to comment.