Merge of previous 'rank metric channel' enhancement #39117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…StaticRankErrorChannel
|
Documentation preview for this PR (built with commit ae52e87; changes) is ready! 🎉 |
kwankyu
reviewed
Jan 22, 2025
| It can be either an integer of a tuple. If a tuple is passed as | ||
| argument, the rank of the error will be a random integer between the | ||
| two bounds of the tuple. | ||
|
|
There was a problem hiding this comment.
message. It can be
It can be either an integer or a tuple?
kwankyu
reviewed
Jan 22, 2025
| - ``relative_field`` -- The field to which the extension is relative. | ||
| If not given, it will default to the prime_subfield of the ambient space | ||
| base_field. | ||
|
|
There was a problem hiding this comment.
``prime_subfield`` or just the prime subfield?
``base_field`` or just the base field?
kwankyu
reviewed
Jan 22, 2025
|
|
||
| We construct a StaticRankErrorChannel which adds error of rank 2 | ||
| to any transmitted message:: | ||
|
|
There was a problem hiding this comment.
:class:`StaticRankErrorChannel`?
kwankyu
reviewed
Jan 22, 2025
| r""" | ||
| TESTS: | ||
|
|
||
| If the number of errors exceeds the dimension of the input space, |
There was a problem hiding this comment.
How about
r"""
Initialize.
TESTS:?
kwankyu
reviewed
Jan 22, 2025
| super(StaticRankErrorChannel, self).__init__(space, space) | ||
| if rank_errors[1] > space.dimension(): | ||
| raise ValueError("There might be errors of rank larger than the dimension of the input space.") | ||
| self._rank_errors = rank_errors |
There was a problem hiding this comment.
ValueError("there might be errors of rank larger than the dimension of the input space")
?
kwankyu
reviewed
Jan 22, 2025
| else: | ||
| if relative_field not in Fields(): | ||
| raise ValueError("relative_field must be a Field and %s is not." % relative_field) | ||
| if not relative_field.is_subring(self._base_field): |
There was a problem hiding this comment.
must be a field
?
%s is not"
?
kwankyu
reviewed
Jan 22, 2025
| if rank_errors[1] > self._extension_degree: | ||
| raise ValueError("There might be errors of rank larger than the field extension degree.") | ||
| self._map_to_field = vec_to_field | ||
|
|
There was a problem hiding this comment.
ValueError("there might be errors of rank larger than the field extension degree")
or
ValueError("there could be errors of rank larger than the field extension degree")
?
kwankyu
reviewed
Jan 22, 2025
| no_err = self.rank_errors() | ||
| return "Channel creating error of rank %s over %s, of input and output space %s"\ | ||
| % (format_interval(no_err), self._relative_field, self.input_space()) | ||
|
|
kwankyu
reviewed
Jan 22, 2025
| no_err = self.rank_errors() | ||
| return "\\textnormal{Channel creating error of rank %s over %s, of input and output space %s}"\ | ||
| % (format_interval(no_err), self._relative_field, self.input_space()) | ||
|
|
kwankyu
reviewed
Jan 22, 2025
| pick a random integer between the bounds of the tuple and use it as the number of errors. | ||
|
|
||
| This method does not check if ``message`` belongs to the input space of``self``. | ||
|
|
kwankyu
reviewed
Jan 22, 2025
| OUTPUT: | ||
|
|
||
| - a vector of the output space | ||
|
|
There was a problem hiding this comment.
OUTPUT: a vector of the output space
kwankyu
reviewed
Jan 22, 2025
| rank_errors = (rank_errors, rank_errors) | ||
| if not isinstance(rank_errors, (tuple, list)): | ||
| raise ValueError("rank_errors must be a tuple, a list, an Integer or a Python int") | ||
| super(StaticRankErrorChannel, self).__init__(space, space) |
There was a problem hiding this comment.
ValueError("rank_errors must be a tuple, a list, or an integer")
?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims at merging and updating an enhancement that was written in #32330 a few years ago. The previous branch was very close to be added at that time.
As a reminder, the goal of #32330 was to add a
StaticRankErrorChannelclass that allows to generate an error of a given "rank weight", and to add it to a codeword.There are some additional minor changes compared to the previous branch:
StaticRankErrorChannel(as a side effect, this update improves the decoder's tests which only covered a very specific case)📝 Checklist
⌛ Dependencies
#32330: the original work