-
Notifications
You must be signed in to change notification settings - Fork 141
/
encoder.rst
80 lines (56 loc) · 2.16 KB
/
encoder.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
.. _enc-turbo_prod-encoder-parameters:
|TPC| Encoder parameters
------------------------
.. _enc-turbo_prod-enc-sub-cw-size:
``--enc-sub-cw-size, -N`` |image_required_argument|
"""""""""""""""""""""""""""""""""""""""""""""""""""
:Type: integer
:Examples: ``--enc-sub-cw-size 127``
|factory::Encoder::parameters::p+cw-size,N|
Give the *sub-encoder code* codeword size. You can extend this codeword with a
parity bit with the :ref:`enc-turbo_prod-enc-ext` option.
Then the codeword size of the |TPC| is the square of this value.
.. _enc-turbo_prod-enc-sub-info-bits:
``--enc-sub-info-bits, -K`` |image_required_argument|
"""""""""""""""""""""""""""""""""""""""""""""""""""""
:Type: integer
:Examples: ``--enc-sub-info-bits 120``
|factory::Encoder::parameters::p+info-bits,K|
Give the *sub-encoder code* input size (number of information bits).
Then the number of information bits of the |TPC| is the
square of this value.
.. _enc-turbo_prod-enc-type:
``--enc-type``
""""""""""""""
:Type: text
:Allowed values: ``TPC`` ``AZCW`` ``COSET`` ``USER``
:Default: ``TPC``
:Examples: ``--enc-type AZCW``
|factory::Encoder::parameters::p+type|
Description of the allowed values:
+-----------+------------------------+
| Value | Description |
+===========+========================+
| ``TPC`` | |enc-type_descr_tpc| |
+-----------+------------------------+
| ``AZCW`` | |enc-type_descr_azcw| |
+-----------+------------------------+
| ``COSET`` | |enc-type_descr_coset| |
+-----------+------------------------+
| ``USER`` | |enc-type_descr_user| |
+-----------+------------------------+
.. |enc-type_descr_tpc| replace:: The |TPC| encoder.
.. |enc-type_descr_azcw| replace:: See the common :ref:`enc-common-enc-type`
parameter.
.. |enc-type_descr_coset| replace:: See the common :ref:`enc-common-enc-type`
parameter.
.. |enc-type_descr_user| replace:: See the common :ref:`enc-common-enc-type`
parameter.
.. _enc-turbo_prod-enc-sub-type:
``--enc-sub-type``
""""""""""""""""""
Please refer to the |BCH| :ref:`enc-bch-enc-type` parameter.
.. _enc-turbo_prod-enc-ext:
``--enc-ext``
"""""""""""""
|factory::Encoder_turbo_product::parameters::p+ext|