Opened 6 years ago

Closed 5 years ago

#20001 closed enhancement (fixed)

Decoders and types for linear codes

Reported by: dlucas Owned by:
Priority: major Milestone: sage-7.2
Component: coding theory Keywords: rd3
Cc: dlucas, cpernet, jlavauzelle, danielaugot Merged in:
Authors: David Lucas, Johan Rosenkilde Reviewers: Johan Rosenkilde
Report Upstream: N/A Work issues:
Branch: 6e9c1dc (Commits, GitHub, GitLab) Commit: 6e9c1dc2916bd817877da303b4a2719e322f3d9a
Dependencies: Stopgaps:

Status badges

Description

Decoders objects in coding theory are associated with a list of types, which are a list of keywords describing to the user the specificites of the underlying decoding algorithm.

For now, the types are not listed nor defined anywhere.

This ticket proposes to create a proper list of types and their definitions.

Change History (12)

comment:1 Changed 6 years ago by karandesai-96

Could you please mention the files you intend to point out in the sage directory tree ?

comment:2 Changed 6 years ago by dlucas

Hello,

I intend to create a list of types and their definitions in decoder.py (sage.coding.decoder), under the generic method decoder_type.

Actually, I originally did that in #19897, but after a discussion in #19623, we found that defining precisely types for decoders wasn't such an easy thing, hence this ticket.

David

comment:3 Changed 5 years ago by dlucas

  • Cc dlucas cpernet jlavauzelle danielaugot added
  • Milestone changed from sage-7.1 to sage-7.2

comment:4 Changed 5 years ago by danielaugot

Hi,

I do not clearly understand what is asked for.

Is a type something like "always_succes", "unique", "list" and so on ? I would then rather call that a property, since it is not a sage type.

Should that be done with a codes.decoders.decoder_types() call, which lists all decoder "types" , with an extremely clear docstring when querying with codes.decoders.decoder_types? ?

Daniel

Last edited 5 years ago by danielaugot (previous) (diff)

comment:5 Changed 5 years ago by ralfaro

I put my comments in the Issue #151 that Johan pointed out to me. It gives a suggestion on redefining the decoder types.

comment:6 Changed 5 years ago by dlucas

  • Branch set to u/dlucas/decoder_types

comment:7 Changed 5 years ago by dlucas

  • Authors set to David Lucas
  • Commit set to 37e738f37217f2458e57d04e0870a4e0a067e20c
  • Keywords rd3 added
  • Status changed from new to needs_review

I pushed a table which contains a list of decoder types and their definitions. Open for review.


New commits:

37e738fTable for decoder types

comment:8 Changed 5 years ago by jsrn

  • Branch changed from u/dlucas/decoder_types to u/jsrn/decoder_types

comment:9 Changed 5 years ago by jsrn

  • Commit changed from 37e738f37217f2458e57d04e0870a4e0a067e20c to 6e9c1dc2916bd817877da303b4a2719e322f3d9a

I made some improvements:

  • Some reformulations.
  • Used simpler table format for future modifications.
  • The doc was not present on Decoder instances (which is where most users will see them). I wrote introspection code which propagates the doc of decoder_type to _instance_decoder_type to fix this.

If you're OK, let's get this thing in the air!


New commits:

70e6052Reformulated some elements. Simpler table format
6e9c1dcDon't duplicate doc-string in decoder_type and _instance_decoder_type

comment:10 Changed 5 years ago by jsrn

  • Authors changed from David Lucas to David Lucas, Johan Rosenkilde
  • Reviewers set to Johan Rosenkilde

comment:11 Changed 5 years ago by dlucas

  • Status changed from needs_review to positive_review

I'm OK, setting to positive review.

David

comment:12 Changed 5 years ago by vbraun

  • Branch changed from u/jsrn/decoder_types to 6e9c1dc2916bd817877da303b4a2719e322f3d9a
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.