author
int64 658
755k
| date
stringlengths 19
19
| timezone
int64 -46,800
43.2k
| hash
stringlengths 40
40
| message
stringlengths 5
490
| mods
list | language
stringclasses 20
values | license
stringclasses 3
values | repo
stringlengths 5
68
| original_message
stringlengths 12
491
|
|---|---|---|---|---|---|---|---|---|---|
8,483 |
29.11.2018 16:30:11
| -3,600 |
34634e66793f617eae2f130bfd29866f0f98058d
|
Doc: rework the Turbo prod to integrate common parameters.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo_prod/decoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo_prod/decoder.rst",
"diff": "@@ -62,9 +62,10 @@ Description of the allowed values:\n.. |dec-type_descr_cp| replace:: Decode with the Chase-Pyndiah algorithm of\nthe |TPC|\n-.. |dec-type_descr_chase| replace:: Decode with the Chase algorithm\n-.. |dec-type_descr_ml| replace:: Decode with the |ML| algorithm\n-\n+.. |dec-type_descr_chase| replace:: See the common :ref:`dec-common-dec-type`\n+ parameter.\n+.. |dec-type_descr_ml| replace:: See the common :ref:`dec-common-dec-type`\n+ parameter.\n.. rubric:: The ``CP`` algorithm is the implementation of\n:cite:`Pyndiah1998` but in a more generic way in order to let the user\n@@ -121,7 +122,7 @@ Description of the allowed values:\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: text\n- :Allowed values: ``FAST`` ``NAIVE`` ``STD``\n+ :Allowed values: ``STD``\n:Default: ``STD``\n:Examples: ``--dec-implem STD``\n@@ -134,17 +135,8 @@ Description of the allowed values:\n+===========+==========================+\n| ``STD`` | |dec-implem_descr_std| |\n+-----------+--------------------------+\n-| ``NAIVE`` | |dec-implem_descr_naive| |\n-+-----------+--------------------------+\n-\n-.. | ``FAST`` | |dec-implem_descr_fast| |\n-.. +-----------+--------------------------+\n.. |dec-implem_descr_std| replace:: A standard implementation\n-.. |dec-implem_descr_naive| replace:: A naive implementation only for the ``ML``\n-..\n- .. |dec-implem_descr_fast| replace:: TODO VALUE FAST\n-\n.. _dec-turbo_prod-dec-ite:\n@@ -153,7 +145,7 @@ Description of the allowed values:\n:Type: integer\n:Default: 4\n- :Examples: ``--dec-ite 5``\n+ :Examples: ``--dec-ite 8``\nSet the number of iterations in the turbo.\n@@ -242,22 +234,37 @@ Set the *number of test vectors*. A value of 0 means equal to :math:`2^p` where\nGive the 5 ``CP`` constant coefficients :math:`a, b, c, d, e` as described in\n:ref:`dec-turbo_prod-dec-type`.\n-.. _dec-turbo_prod-dec-flips:\n-``--dec-flips``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+.. _dec-turbo_prod-dec-sub-type:\n- :Type: integer\n- :Examples: ``--dec-flips 1``\n+``--dec-sub-type, -D``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-Set the maximum number of flips in the CHASE decoder.\n+ :Type: text\n+ :Allowed values: ``ALGEBRAIC`` ``CHASE`` ``ML``\n+ :Examples: ``--dec-sub-type ALGEBRAIC``\n-.. _dec-turbo_prod-dec-hamming:\n+Select the algorithm of the sub-decoder to decode each row and column.\n-``--dec-hamming``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+Description of the allowed values:\n+\n++---------------+--------------------------------+\n+| Value | Description |\n++===============+================================+\n+| ``ALGEBRAIC`` | |dec-sub-type_descr_algebraic| |\n++---------------+--------------------------------+\n+| ``CHASE`` | |dec-sub-type_descr_chase| |\n++---------------+--------------------------------+\n+| ``ML`` | |dec-sub-type_descr_ml| |\n++---------------+--------------------------------+\n+\n+.. |dec-sub-type_descr_algebraic| replace:: See the |BCH| code\n+ :ref:`dec-bch-dec-type`.\n+.. |dec-sub-type_descr_chase| replace:: See the common :ref:`dec-common-dec-type`\n+ parameter.\n+.. |dec-sub-type_descr_ml| replace:: See the common :ref:`dec-common-dec-type`\n+ parameter.\n-Enable the computation of the Hamming distance instead of the Euclidean distance in the ML/CHASE decoders.\n.. _dec-turbo_prod-dec-sub-corr-pow:\n@@ -266,9 +273,9 @@ Enable the computation of the Hamming distance instead of the Euclidean distance\n:Type: integer\n:Default: 1\n- :Examples: ``-T 1``\n+ :Examples: ``-T 2``\n-Give the correction power of the BCH sub-decoder.\n+Give the correction power of the |BCH| ``ALGEBRAIC`` sub-decoder.\n.. _dec-turbo_prod-dec-sub-implem:\n@@ -279,57 +286,33 @@ Give the correction power of the BCH sub-decoder.\n:Allowed values: ``FAST`` ``GENIUS`` ``NAIVE`` ``STD``\n:Examples: ``--dec-sub-implem FAST``\n-Select the implementation of the algorithm to decode.\n+Select the implementation of the algorithm of the sub-decoder.\nDescription of the allowed values:\n+------------+-------------------------------+\n| Value | Description |\n+============+===============================+\n-| ``FAST`` | |dec-sub-implem_descr_fast| |\n-+------------+-------------------------------+\n-| ``GENIUS`` | |dec-sub-implem_descr_genius| |\n-+------------+-------------------------------+\n| ``NAIVE`` | |dec-sub-implem_descr_naive| |\n+------------+-------------------------------+\n| ``STD`` | |dec-sub-implem_descr_std| |\n+------------+-------------------------------+\n+| ``FAST`` | |dec-sub-implem_descr_fast| |\n++------------+-------------------------------+\n+| ``GENIUS`` | |dec-sub-implem_descr_genius| |\n++------------+-------------------------------+\n-.. |dec-sub-implem_descr_fast| replace:: TODO VALUE FAST\n-.. |dec-sub-implem_descr_genius| replace:: TODO VALUE GENIUS\n-.. |dec-sub-implem_descr_naive| replace:: TODO VALUE NAIVE\n-.. |dec-sub-implem_descr_std| replace:: TODO VALUE STD\n-\n-\n-.. _dec-turbo_prod-dec-sub-type:\n-\n-``--dec-sub-type, -D``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: text\n- :Allowed values: ``ALGEBRAIC`` ``CHASE`` ``ML``\n- :Examples: ``--dec-sub-type ALGEBRAIC``\n-\n-Select the algorithm you want to decode the codeword.\n-\n-Description of the allowed values:\n-\n-+---------------+--------------------------------+\n-| Value | Description |\n-+===============+================================+\n-| ``ALGEBRAIC`` | |dec-sub-type_descr_algebraic| |\n-+---------------+--------------------------------+\n-| ``CHASE`` | |dec-sub-type_descr_chase| |\n-+---------------+--------------------------------+\n-| ``ML`` | |dec-sub-type_descr_ml| |\n-+---------------+--------------------------------+\n-\n-.. |dec-sub-type_descr_algebraic| replace:: TODO VALUE ALGEBRAIC\n-.. |dec-sub-type_descr_chase| replace:: TODO VALUE CHASE\n-.. |dec-sub-type_descr_ml| replace:: TODO VALUE ML\n-\n-\n-.. TODO : remove those arguments in the code\n+.. |dec-sub-implem_descr_naive| replace:: See the common\n+ :ref:`dec-common-dec-implem` parameter.\n+.. |dec-sub-implem_descr_std| replace:: See the common\n+ :ref:`dec-common-dec-implem` parameter, and the |BCH| code\n+ :ref:`dec-bch-dec-implem` parameter.\n+.. |dec-sub-implem_descr_fast| replace:: See the |BCH| code\n+ :ref:`dec-bch-dec-implem` parameter.\n+.. |dec-sub-implem_descr_genius| replace:: See the |BCH| code\n+ :ref:`dec-bch-dec-implem` parameter.\n+\n+.. TODO : remove those following arguments from the code\n.. _dec-turbo_prod-dec-sub-flips:\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo_prod/encoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo_prod/encoder.rst",
"diff": "@@ -26,17 +26,52 @@ Description of the allowed values:\n+----------------+-----------------------------+\n| ``COSET`` | |enc-type_descr_coset| |\n+----------------+-----------------------------+\n-| ``NO`` | |enc-type_descr_no| |\n-+----------------+-----------------------------+\n| ``USER`` | |enc-type_descr_user| |\n+----------------+-----------------------------+\n-.. |enc-type_descr_turbo_prod| replace:: The |TPC| encoder\n-.. |enc-type_descr_azcw| replace:: The |AZCW| encoder\n-.. |enc-type_descr_coset| replace:: The *coset* encoder\n-.. |enc-type_descr_no| replace:: No encoder is used\n-.. |enc-type_descr_user| replace:: User defined codewords\n+.. |enc-type_descr_turbo_prod| replace:: The |TPC| encoder.\n+.. |enc-type_descr_azcw| replace:: See the common :ref:`enc-common-enc-type`\n+ parameter.\n+.. |enc-type_descr_coset| replace:: See the common :ref:`enc-common-enc-type`\n+ parameter.\n+.. |enc-type_descr_user| replace:: See the common :ref:`enc-common-enc-type`\n+ parameter.\n+\n+\n+.. _enc-turbo_prod-enc-sub-type:\n+\n+``--enc-sub-type``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: text\n+ :Allowed values: ``AZCW`` ``BCH`` ``COSET`` ``NO`` ``USER``\n+ :Default: ``BCH``\n+ :Examples: ``--enc-sub-type BCH``\n+\n+Give the type of the sub-encoder to use to code each column and row.\n+\n+Description of the allowed values:\n+\n++-----------+----------------------------+\n+| Value | Description |\n++===========+============================+\n+| ``BCH`` | |enc-sub-type_descr_bch| |\n++-----------+----------------------------+\n+| ``AZCW`` | |enc-sub-type_descr_azcw| |\n++-----------+----------------------------+\n+| ``COSET`` | |enc-sub-type_descr_coset| |\n++-----------+----------------------------+\n+| ``USER`` | |enc-sub-type_descr_user| |\n++-----------+----------------------------+\n+.. |enc-sub-type_descr_bch| replace:: See the |BCH| code\n+ :ref:`enc-bch-encoder-parameters` parameters.\n+.. |enc-sub-type_descr_azcw| replace:: See the common :ref:`enc-common-enc-type`\n+ parameter.\n+.. |enc-sub-type_descr_coset| replace:: See the common :ref:`enc-common-enc-type`\n+ parameter.\n+.. |enc-sub-type_descr_user| replace:: See the common :ref:`enc-common-enc-type`\n+ parameter.\n.. _enc-turbo_prod-enc-sub-cw-size:\n@@ -70,63 +105,7 @@ square of this value.\nExtend the *sub-encoder* codeword with a parity bit in order to increase the\ndistance of the code.\n-.. _enc-turbo_prod-enc-path:\n-\n-``--enc-path``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: file\n- :Rights: read only\n- :Examples: ``--enc-path example/path/to/the/right/file``\n-\n-Set the path to a file containing one or a set of pre-computed codewords\n-for the ``USER`` type.\n-\n-.. _enc-turbo_prod-enc-start-idx:\n-\n-``--enc-start-idx``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: integer\n- :Examples: ``--enc-start-idx 1``\n-\n-Set the first frame index to use when reading the file in the ``USER`` type\n-encoder.\n-\n-.. _enc-turbo_prod-enc-sub-type:\n-\n-``--enc-sub-type``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: text\n- :Allowed values: ``AZCW`` ``BCH`` ``COSET`` ``NO`` ``USER``\n- :Default: ``BCH``\n- :Examples: ``--enc-sub-type BCH``\n-\n-Give the type of the sub-encoder to use to code each line .\n-\n-Description of the allowed values:\n-\n-+-----------+----------------------------+\n-| Value | Description |\n-+===========+============================+\n-| ``BCH`` | |enc-sub-type_descr_bch| |\n-+-----------+----------------------------+\n-| ``AZCW`` | |enc-sub-type_descr_azcw| |\n-+-----------+----------------------------+\n-| ``COSET`` | |enc-sub-type_descr_coset| |\n-+-----------+----------------------------+\n-| ``NO`` | |enc-sub-type_descr_no| |\n-+-----------+----------------------------+\n-| ``USER`` | |enc-sub-type_descr_user| |\n-+-----------+----------------------------+\n-\n-.. |enc-sub-type_descr_bch| replace:: The |BCH| code\n-.. |enc-sub-type_descr_azcw| replace:: The |AZCW| encoder\n-.. |enc-sub-type_descr_coset| replace:: The *coset* encoder\n-.. |enc-sub-type_descr_no| replace:: No encoder is used\n-.. |enc-sub-type_descr_user| replace:: User defined codewords\n-\n+.. TODO: Need to deactivate those options in the code\n.. _enc-turbo_prod-enc-sub-path:\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: rework the Turbo prod to integrate common parameters.
|
8,483 |
29.11.2018 17:10:27
| -3,600 |
1ff547e2f39f1cd3ce9ecf6781e5c55ca2e1f509
|
Doc: Add references for the RS decoder
|
[
{
"change_type": "ADD",
"old_path": null,
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/rs/references.bib",
"diff": "+@Book{Berlekamp1968,\n+ title = {Algebraic Coding Theory},\n+ publisher = {New York: McGraw-Hill},\n+ year = {1968},\n+ author = {E. R. Berlekamp},\n+ isbn = {978-981-4635-89-9},\n+ url = {https://www.worldscientific.com/worldscibooks/10.1142/9407},\n+ doi = {10.1142/9407},\n+}\n+\n+@Article{Massey1969,\n+ author = {J. Massey},\n+ journal = {IEEE Transactions on Information Theory (TIT)},\n+ title = {Shift-Register Synthesis and BCH Decoding},\n+ year = {1969},\n+ volume = {15},\n+ number = {1},\n+ pages = {122-127},\n+ abstract = {It is shown in this paper that the iterative algorithm introduced by Berlekamp for decoding BCH codes actually provides a general solution to the problem of synthesizing the shortest linear feedback shift register capable of generating a prescribed finite sequence of digits. The shift-register approach leads to a simple proof of the validity of the algorithm as well as providing additional insight into its properties. The equivalence of the decoding problem for BCH codes to a shift-register synthesis problem is demonstrated, and other applications for the algorithm are suggested.},\n+ keywords = {BCH codes;Decoding;Shift-register sequences},\n+ doi = {10.1109/TIT.1969.1054260},\n+ ISSN = {0018-9448},\n+ month = jan,\n+}\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: Add references for the RS decoder
|
8,490 |
30.11.2018 11:07:12
| -3,600 |
67fab88502217e19d728b3b33e2ea96ca3f29da5
|
Doc: add refs for the BCH decoder parameters.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/conf.py",
"new_path": "doc/sphinx/source/conf.py",
"diff": "@@ -244,6 +244,7 @@ rst_epilog = \"\"\"\n.. |BER| replace:: :abbr:`BER (Bit Error Rate)`\n.. |BFER| replace:: :abbr:`BER/FER (Bit and Frame Error Rate)`\n.. |BPSK| replace:: :abbr:`BPSK (Bit Phase-Shift Keying)`\n+.. |BM| replace:: :abbr:`BM (Berlekamp-Massey)`\n.. |BP| replace:: :abbr:`BP (Belief Propagation)`\n.. |BPS| replace:: :abbr:`BPS (Bit Per Symbol)`\n.. |BSC| replace:: :abbr:`BSC (Binary Symmetric Channel)`\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/bch/references.bib",
"diff": "+@Book{Berlekamp1968,\n+ title = {Algebraic Coding Theory (Revised Edition)},\n+ publisher = {World Scientific},\n+ year = {2015},\n+ month = may,\n+ author = {E. R. Berlekamp},\n+ doi = {10.1142/9407},\n+ note = {First edition from 1968}\n+}\n+\n+@Article{Massey1969,\n+ author = {J. Massey},\n+ journal = {IEEE Transactions on Information Theory (TIT)},\n+ title = {Shift-Register Synthesis and BCH Decoding},\n+ year = {1969},\n+ volume = {15},\n+ number = {1},\n+ pages = {122-127},\n+ abstract = {It is shown in this paper that the iterative algorithm introduced by Berlekamp for decoding BCH codes actually provides a general solution to the problem of synthesizing the shortest linear feedback shift register capable of generating a prescribed finite sequence of digits. The shift-register approach leads to a simple proof of the validity of the algorithm as well as providing additional insight into its properties. The equivalence of the decoding problem for BCH codes to a shift-register synthesis problem is demonstrated, and other applications for the algorithm are suggested.},\n+ keywords = {BCH codes;Decoding;Shift-register sequences},\n+ doi = {10.1109/TIT.1969.1054260},\n+ ISSN = {0018-9448},\n+ month = jan,\n+}\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: add refs for the BCH decoder parameters.
|
8,483 |
30.11.2018 13:07:07
| -3,600 |
5c9bf3de114b5ae0ce1b9aba94bbd5ced094dc3d
|
Add Chien paper in BCH and RS codec and Reed-Solomon paper for RS.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/bch/decoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/bch/decoder.rst",
"diff": "@@ -25,7 +25,7 @@ Description of the allowed values:\n+===============+==============================================================+\n| ``ALGEBRAIC`` | Select the `Berlekamp-Massey algorithm`_ |\n| | :cite:`Berlekamp1968,Massey1969` followed by a |\n-| | `Chien search`_. |\n+| | `Chien search`_ :cite:`Chien1964`. |\n+---------------+--------------------------------------------------------------+\n| ``CHASE`` | See the common :ref:`dec-common-dec-type` parameter. |\n+---------------+--------------------------------------------------------------+\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/bch/references.bib",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/bch/references.bib",
"diff": "ISSN = {0018-9448},\nmonth = jan,\n}\n+\n+@Article{Chien1964,\n+ author = {R. Chien},\n+ journal = {IEEE Transactions on Information Theory (TIT)},\n+ title = {Cyclic decoding procedures for Bose- Chaudhuri-Hocquenghem codes},\n+ year = {1964},\n+ volume = {10},\n+ number = {1},\n+ pages = {357-363},\n+ abstract = {This paper presents new general error-correction procedures for fhe class of codes known as Bose-Chaudhuri-Hocquenghem codes. It is shown that these procedures are efficient in time required for error-correction, and that they can be implemented with relatively simple electronic circuits. A comparison is also made with existing procedures.},\n+ keywords = {BCH codes, Decoding},\n+ doi = {10.1109/TIT.1964.1053699},\n+ ISSN = {0018-9448},\n+ month = oct,\n+}\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/rs/references.bib",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/rs/references.bib",
"diff": "@Book{Berlekamp1968,\n- title = {Algebraic Coding Theory},\n- publisher = {New York: McGraw-Hill},\n- year = {1968},\n+ title = {Algebraic Coding Theory (Revised Edition)},\n+ publisher = {World Scientific},\n+ year = {2015},\n+ month = may,\nauthor = {E. R. Berlekamp},\n- isbn = {978-981-4635-89-9},\n- url = {https://www.worldscientific.com/worldscibooks/10.1142/9407},\ndoi = {10.1142/9407},\n+ note = {First edition from 1968}\n}\n@Article{Massey1969,\nISSN = {0018-9448},\nmonth = jan,\n}\n+\n+@Article{Chien1964,\n+ author = {R. Chien},\n+ journal = {IEEE Transactions on Information Theory (TIT)},\n+ title = {Cyclic decoding procedures for Bose- Chaudhuri-Hocquenghem codes},\n+ year = {1964},\n+ volume = {10},\n+ number = {4},\n+ pages = {357-363},\n+ abstract = {This paper presents new general error-correction procedures for fhe class of codes known as Bose-Chaudhuri-Hocquenghem codes. It is shown that these procedures are efficient in time required for error-correction, and that they can be implemented with relatively simple electronic circuits. A comparison is also made with existing procedures.},\n+ keywords = {BCH codes, Decoding},\n+ doi = {10.1109/TIT.1964.1053699},\n+ ISSN = {0018-9448},\n+ month = oct,\n+}\n+\n+@Article{ReedSolomon1960,\n+ author = {I. S. Reed, G. Solomon},\n+ journal = {Society for Industrial and Applied Mathematics},\n+ title = {Polynomial Codes Over Certain Finite Fields},\n+ year = {1960},\n+ month = jun,\n+ volume = {8},\n+ number = {2},\n+ pages = {300-304},\n+ abstract = {},\n+ keywords = {RS codes, Polynomial codes},\n+ doi = {10.1137/0108018},\n+ ISSN = {0368-4245},\n+}\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add Chien paper in BCH and RS codec and Reed-Solomon paper for RS.
|
8,483 |
30.11.2018 15:32:00
| -3,600 |
83cded6214dc3c121c1a31f779d58d17bd2467ae
|
Doc: work on the LDPC codec
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"diff": "Decoder parameters\n------------------\n-.. _dec-ldpc-dec-h-path:\n-\n-``--dec-h-path`` |image_required_argument|\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: file\n- :Rights: read only\n- :Examples: ``--dec-h-path example/path/to/the/right/file``\n-\n-Path to the H matrix (AList or QC formated file).\n-\n-.. _dec-ldpc-dec-flips:\n-\n-``--dec-flips``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: integer\n- :Examples: ``--dec-flips 1``\n-\n-Set the maximum number of flips in the CHASE decoder.\n-\n-.. _dec-ldpc-dec-h-reorder:\n+.. _dec-ldpc-dec-type:\n-``--dec-h-reorder``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+``--dec-type, -D``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: text\n- :Allowed values: ``ASC`` ``DSC`` ``NONE``\n- :Examples: ``--dec-h-reorder ASC``\n+ :Allowed values: ``BIT_FLIPPING`` ``BP_FLOODING`` ``BP_HORIZONTAL_LAYERED``\n+ ``BP_PEELING`` ``BP_VERTICAL_LAYERED`` ``CHASE`` ``ML``\n+ :Default: ``BP_FLOODING``\n+ :Examples: ``--dec-type BP_HORIZONTAL_LAYERED``\n-Specify if the check nodes (CNs) from H have to be reordered, 'NONE': do nothing (default), 'ASC': from the smallest to the biggest CNs, 'DSC': from the biggest to the smallest CNs.\n+Select the algorithm you want to decode the codeword.\nDescription of the allowed values:\n-+----------+----------------------------+\n++---------------------------+---------------------------------------------------------------+\n| Value | Description |\n-+==========+============================+\n-| ``ASC`` | |dec-h-reorder_descr_asc| |\n-+----------+----------------------------+\n-| ``DSC`` | |dec-h-reorder_descr_dsc| |\n-+----------+----------------------------+\n-| ``NONE`` | |dec-h-reorder_descr_none| |\n-+----------+----------------------------+\n-\n-.. |dec-h-reorder_descr_asc| replace:: TODO VALUE ASC\n-.. |dec-h-reorder_descr_dsc| replace:: TODO VALUE DSC\n-.. |dec-h-reorder_descr_none| replace:: TODO VALUE NONE\n-\n-\n-.. _dec-ldpc-dec-hamming:\n-\n-``--dec-hamming``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n++===========================+===============================================================+\n+| ``BIT_FLIPPING`` | The Bit Flipping algorithm. |\n++---------------------------+---------------------------------------------------------------+\n+| ``BP_FLOODING`` | The Belief Propagation Flooding algorithm. |\n++---------------------------+---------------------------------------------------------------+\n+| ``BP_HORIZONTAL_LAYERED`` | The Belief Propagation Horizontal Layered algorithm. |\n++---------------------------+---------------------------------------------------------------+\n+| ``BP_VERTICAL_LAYERED`` | The Belief Propagation Vertical Layered algorithm. |\n++---------------------------+---------------------------------------------------------------+\n+| ``BP_PEELING`` | The Belief Propagation Peeling algorithm :cite:`Peeling2001`. |\n++---------------------------+---------------------------------------------------------------+\n+| ``CHASE`` | See the common :ref:`dec-common-dec-type` parameter. |\n++---------------------------+---------------------------------------------------------------+\n+| ``ML`` | See the common :ref:`dec-common-dec-type` parameter. |\n++---------------------------+---------------------------------------------------------------+\n+\n+\n+.. TODO: BP_HORIZONTAL_LAYERED_LEGACY and __cpp_aligned_new\n-Enable the computation of the Hamming distance instead of the Euclidean distance in the ML/CHASE decoders.\n.. _dec-ldpc-dec-implem:\n@@ -66,7 +46,9 @@ Enable the computation of the Hamming distance instead of the Euclidean distance\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: text\n- :Allowed values: ``AMS`` ``GALA`` ``LSPA`` ``MS`` ``NAIVE`` ``NMS`` ``OMS`` ``SPA`` ``STD`` ``WBF``\n+ :Allowed values: ``AMS`` ``GALA`` ``LSPA`` ``MS`` ``NMS`` ``OMS``\n+ ``SPA`` ``STD`` ``WBF``\n+ :Default: ``SPA``\n:Examples: ``--dec-implem AMS``\nSelect the implementation of the algorithm to decode.\n@@ -80,34 +62,147 @@ Description of the allowed values:\n+-----------+--------------------------+\n| ``GALA`` | |dec-implem_descr_gala| |\n+-----------+--------------------------+\n-| ``LSPA`` | |dec-implem_descr_lspa| |\n-+-----------+--------------------------+\n| ``MS`` | |dec-implem_descr_ms| |\n+-----------+--------------------------+\n-| ``NAIVE`` | |dec-implem_descr_naive| |\n-+-----------+--------------------------+\n| ``NMS`` | |dec-implem_descr_nms| |\n+-----------+--------------------------+\n| ``OMS`` | |dec-implem_descr_oms| |\n+-----------+--------------------------+\n| ``SPA`` | |dec-implem_descr_spa| |\n+-----------+--------------------------+\n+| ``LSPA`` | |dec-implem_descr_lspa| |\n++-----------+--------------------------+\n| ``STD`` | |dec-implem_descr_std| |\n+-----------+--------------------------+\n| ``WBF`` | |dec-implem_descr_wbf| |\n+-----------+--------------------------+\n-.. |dec-implem_descr_ams| replace:: TODO VALUE AMS\n-.. |dec-implem_descr_gala| replace:: TODO VALUE GALA\n-.. |dec-implem_descr_lspa| replace:: TODO VALUE LSPA\n-.. |dec-implem_descr_ms| replace:: TODO VALUE MS\n-.. |dec-implem_descr_naive| replace:: TODO VALUE NAIVE\n-.. |dec-implem_descr_nms| replace:: TODO VALUE NMS\n-.. |dec-implem_descr_oms| replace:: TODO VALUE OMS\n-.. |dec-implem_descr_spa| replace:: TODO VALUE SPA\n-.. |dec-implem_descr_std| replace:: TODO VALUE STD\n-.. |dec-implem_descr_wbf| replace:: TODO VALUE WBF\n+.. |dec-implem_descr_ams| replace:: The Approximate Min Star algorithm.\n+.. |dec-implem_descr_gala| replace:: The Gallager A algorithm.\n+.. |dec-implem_descr_ms| replace:: The Min-Sum algorithm.\n+.. |dec-implem_descr_nms| replace:: The Normalized Min-Sum algorithm.\n+.. |dec-implem_descr_oms| replace:: The Offset Min-Sum algorithm.\n+.. |dec-implem_descr_spa| replace:: The Sum-Product Algorithm.\n+.. |dec-implem_descr_lspa| replace:: The Log Sum-Product Algorithm.\n+.. |dec-implem_descr_std| replace:: A standard implementation of the decoder.\n+.. |dec-implem_descr_wbf| replace:: The Weighted Bit Flipping algorithm\n+\n+\n+The ``MS``, ``NMS`` and ``OMS`` implementations come from the *Offset-Normalized\n+Min-Sum* algorithm. The ``MS`` force the norm to 1 and the offset to 0.\n+The ``NMS`` leaves the norm free to the user to choose, when it is the offset\n+for the ``OMS``.\n+\n+\n+\n+The following table shows the different decoder types and their matching\n+implementation when no |SIMD| strategy is used:\n+\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+| Value | ``AMS``|``GALA``|``MS``|``NMS``|``OMS``|``SPA``|``LSPA``|``STD``|``WBF`` |\n++===========================+========+========+======+=======+=======+=======+========+=======+========+\n+| ``BIT_FLIPPING`` | | | | | | | | | |OK| |\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+| ``BP_FLOODING`` | |OK| | |OK| | |OK| | |OK| | |OK| | |OK| | |OK| | | |\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+| ``BP_HORIZONTAL_LAYERED`` | |OK| | | |OK| | |OK| | |OK| | |OK| | |OK| | | |\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+| ``BP_VERTICAL_LAYERED`` | |OK| | | |OK| | |OK| | |OK| | |OK| | |OK| | | |\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+| ``BP_PEELING`` | | | | | | | | |OK| | |\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+\n+The following table shows the different decoder types and their matching\n+implementation when the ``INTER`` |SIMD| strategy is used:\n+\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+| Value | ``AMS``|``GALA``|``MS``|``NMS``|``OMS``|``SPA``|``LSPA``|``STD``|``WBF`` |\n++===========================+========+========+======+=======+=======+=======+========+=======+========+\n+| ``BIT_FLIPPING`` | | | | | | | | | |\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+| ``BP_FLOODING`` | | | | | | | | | |\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+| ``BP_HORIZONTAL_LAYERED`` | | | |OK| | |OK| | |OK| | | | | |\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+| ``BP_VERTICAL_LAYERED`` | | | | | | | | | |\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+| ``BP_PEELING`` | | | | | | | | | |\n++---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n+\n+.. |OK| replace:: OK\n+.. _dec-ldpc-dec-simd:\n+\n+``--dec-simd``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: text\n+ :Allowed values: ``INTER``\n+ :Examples: ``--dec-simd INTER``\n+\n+Select the |SIMD| strategy you want to use to accelerate significantly\n+the simulation.\n+\n+Description of the allowed values:\n+\n++-----------+------------------------+\n+| Value | Description |\n++===========+========================+\n+| ``INTER`` | |dec-simd_descr_inter| |\n++-----------+------------------------+\n+\n+.. |dec-simd_descr_inter| replace:: The decoder processes several frames at the\n+ same time.\n+\n+\n+.. _dec-ldpc-dec-h-path:\n+\n+``--dec-h-path`` |image_required_argument|\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: file\n+ :Rights: read only\n+ :Examples: ``--dec-h-path conf/dec/LDPC/AR4JA_4096_8192.qc``\n+ ``--dec-h-path conf/dec/LDPC/MACKAY_504_1008.alist``\n+\n+Give the path to the H matrix. Supported format are AList and QC files.\n+\n+This argument is not needed if the encoder type :ref:`enc-ldpc-enc-type`\n+is ``LDPC_DVBS2``.\n+\n+.. TODO: info bits pos at the end of .alist file\n+ puncturer pattern at the end of QC file\n+\n+\n+.. _dec-ldpc-dec-h-reorder:\n+\n+``--dec-h-reorder``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: text\n+ :Allowed values: ``ASC`` ``DSC`` ``NONE``\n+ :Default: ``NONE``\n+ :Examples: ``--dec-h-reorder ASC``\n+\n+Specify if the check nodes (CNs) from H have to be reordered.\n+\n+Description of the allowed values:\n+\n++----------+----------------------------+\n+| Value | Description |\n++==========+============================+\n+| ``ASC`` | |dec-h-reorder_descr_asc| |\n++----------+----------------------------+\n+| ``DSC`` | |dec-h-reorder_descr_dsc| |\n++----------+----------------------------+\n+| ``NONE`` | |dec-h-reorder_descr_none| |\n++----------+----------------------------+\n+\n+.. |dec-h-reorder_descr_asc| replace:: Reorder from the smallest to the biggest\n+ CNs.\n+.. |dec-h-reorder_descr_dsc| replace:: Reorder from the biggest to the smallest\n+ CNs.\n+.. |dec-h-reorder_descr_none| replace:: Do not change the order.\n.. _dec-ldpc-dec-ite:\n@@ -115,9 +210,15 @@ Description of the allowed values:\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-ite 1``\n+ :Default: 10\n+ :Examples: ``--dec-ite 30``\n-Maximal number of iterations in the LDPC decoder.\n+Set the maximal number of iterations in the LDPC decoder.\n+\n+.. note:: The syndrome is used in order to accelerate the simulation\n+ by stopping the decoder process before the end of all its iterations.\n+ The decoder may then often not realize all the planned iterations.\n+ Use :ref:`dec-ldpc-dec-no-synd` to deactivate this behavior.\n.. _dec-ldpc-dec-min:\n@@ -126,44 +227,38 @@ Maximal number of iterations in the LDPC decoder.\n:Type: text\n:Allowed values: ``MIN`` ``MINL`` ``MINS``\n+ :Default: ``MINL``\n:Examples: ``--dec-min MIN``\n-The MIN implementation for the nodes (AMS decoder).\n+Give the *MIN* implementation for the ``AMS`` decoder nodes.\nDescription of the allowed values:\n+----------+----------------------+\n| Value | Description |\n+==========+======================+\n-| ``MIN`` | |dec-min_descr_min| |\n+| ``MINS`` | |dec-min_descr_mins| |\n+----------+----------------------+\n| ``MINL`` | |dec-min_descr_minl| |\n+----------+----------------------+\n-| ``MINS`` | |dec-min_descr_mins| |\n+| ``MIN`` | |dec-min_descr_min| |\n+----------+----------------------+\n-.. |dec-min_descr_min| replace:: TODO VALUE MIN\n-.. |dec-min_descr_minl| replace:: TODO VALUE MINL\n-.. |dec-min_descr_mins| replace:: TODO VALUE MINS\n-\n+.. |dec-min_descr_mins| replace:: :math:`\\min^*(a,b) = \\min(a,b) +\n+ \\log(1 + \\exp(-(a + b))) - \\log(1 + \\exp(-|a - b|))`.\n+.. |dec-min_descr_minl| replace:: :math:`\\min^*(a,b) \\approx \\min(a,b) +\n+ corr(a + b) - corr(|a + b|)` with :math:`corr(x) = \\begin{cases}\n+ 0 & \\text{if } x >= 2.625\\\\\n+ -0.375 x + 0.6825 & \\text{if } x < 1.0 \\\\\n+ -0.1875 x + 0.5 & \\text{else}\n+ \\end{cases}`.\n+.. |dec-min_descr_min| replace:: :math:`\\min^*(a,b) \\approx \\min(a,b)`.\n-.. _dec-ldpc-dec-mwbf:\n+``MINS`` for *Min Star* is the exact :math:`\\min^*` operator.\n+``MINL`` for *Min Linear* is a linear approximation of the :math:`\\min^*`\n+function. ``MIN`` for *Min* is the simplest approximation with\n+only a :math:`\\min` function.\n-``--dec-mwbf``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: real number\n- :Examples: ``--dec-mwbf 1.0``\n-\n-Factor used in the modified WBF algorithm (works only with \"\\\\-\\\\-dec-implem WBF\"). Set 0 for basic WBF.\n-\n-.. _dec-ldpc-dec-no-synd:\n-\n-``--dec-no-synd``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n-\n-Disable the syndrome detection (disable the stop criterion in the LDPC decoders).\n.. _dec-ldpc-dec-norm:\n@@ -171,9 +266,10 @@ Disable the syndrome detection (disable the stop criterion in the LDPC decoders)\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: real number\n- :Examples: ``--dec-norm 1.0``\n+ :Default: 1.0\n+ :Examples: ``--dec-norm 0.75``\n-Normalization factor used in the normalized min-sum BP algorithm (works only with \"\\\\-\\\\-dec-implem NMS\").\n+Set the normalization factor used in the ``NMS`` algorithm.\n.. _dec-ldpc-dec-off:\n@@ -181,31 +277,21 @@ Normalization factor used in the normalized min-sum BP algorithm (works only wit\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: real number\n- :Examples: ``--dec-off 1.0``\n+ :Default: 0.0\n+ :Examples: ``--dec-off 0.25``\n-Offset used in the offset min-sum BP algorithm (works only with \"\\\\-\\\\-dec-implem NMS\").\n+Set the offset used in the ``OMS`` algorithm.\n-.. _dec-ldpc-dec-simd:\n+.. _dec-ldpc-dec-mwbf:\n-``--dec-simd``\n+``--dec-mwbf``\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n- :Type: text\n- :Allowed values: ``INTER``\n- :Examples: ``--dec-simd INTER``\n-\n-The |SIMD| strategy you want to use.\n-\n-Description of the allowed values:\n-\n-+-----------+------------------------+\n-| Value | Description |\n-+===========+========================+\n-| ``INTER`` | |dec-simd_descr_inter| |\n-+-----------+------------------------+\n-\n-.. |dec-simd_descr_inter| replace:: TODO VALUE INTER\n+ :Type: real number\n+ :Default: 0.0\n+ :Examples: ``--dec-mwbf 1.0``\n+Give the factor used in the modified ``WBF`` algorithm. Set 0 for basic WBF.\n.. _dec-ldpc-dec-synd-depth:\n@@ -213,47 +299,22 @@ Description of the allowed values:\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-synd-depth 1``\n-\n-Successive number of iterations to validate the syndrome detection.\n-\n-.. _dec-ldpc-dec-type:\n+ :Default: 1\n+ :Examples: ``--dec-synd-depth 2``\n-``--dec-type, -D``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+It helps to avoid the detection of false positive syndrome by ensuring that it\n+is valid for several consecutive iterations.\n- :Type: text\n- :Allowed values: ``BIT_FLIPPING`` ``BP_FLOODING`` ``BP_HORIZONTAL_LAYERED`` ``BP_PEELING`` ``BP_VERTICAL_LAYERED`` ``CHASE`` ``ML``\n- :Examples: ``--dec-type BIT_FLIPPING``\n+.. _dec-ldpc-dec-no-synd:\n-Select the algorithm you want to decode the codeword.\n+``--dec-no-synd``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-Description of the allowed values:\n+Disable the syndrome detection and so the stop criterion iteration after\n+iteration.\n-+---------------------------+----------------------------------------+\n-| Value | Description |\n-+===========================+========================================+\n-| ``BIT_FLIPPING`` | |dec-type_descr_bit_flipping| |\n-+---------------------------+----------------------------------------+\n-| ``BP_FLOODING`` | |dec-type_descr_bp_flooding| |\n-+---------------------------+----------------------------------------+\n-| ``BP_HORIZONTAL_LAYERED`` | |dec-type_descr_bp_horizontal_layered| |\n-+---------------------------+----------------------------------------+\n-| ``BP_PEELING`` | |dec-type_descr_bp_peeling| |\n-+---------------------------+----------------------------------------+\n-| ``BP_VERTICAL_LAYERED`` | |dec-type_descr_bp_vertical_layered| |\n-+---------------------------+----------------------------------------+\n-| ``CHASE`` | |dec-type_descr_chase| |\n-+---------------------------+----------------------------------------+\n-| ``ML`` | |dec-type_descr_ml| |\n-+---------------------------+----------------------------------------+\n-\n-.. |dec-type_descr_bit_flipping| replace:: TODO VALUE BIT_FLIPPING\n-.. |dec-type_descr_bp_flooding| replace:: TODO VALUE BP_FLOODING\n-.. |dec-type_descr_bp_horizontal_layered| replace:: TODO VALUE BP_HORIZONTAL_LAYERED\n-.. |dec-type_descr_bp_peeling| replace:: TODO VALUE BP_PEELING\n-.. |dec-type_descr_bp_vertical_layered| replace:: TODO VALUE BP_VERTICAL_LAYERED\n-.. |dec-type_descr_chase| replace:: TODO VALUE CHASE\n-.. |dec-type_descr_ml| replace:: TODO VALUE ML\n+References\n+\"\"\"\"\"\"\"\"\"\"\n+.. bibliography:: references.bib\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/encoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/encoder.rst",
"diff": "Encoder parameters\n------------------\n+.. _enc-ldpc-enc-type:\n+\n+``--enc-type``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: text\n+ :Allowed values: ``LDPC`` ``LDPC_H`` ``LDPC_DVBS2`` ``LDPC_IRA``\n+ ``LDPC_QC`` ``AZCW`` ``COSET`` ``USER``\n+ :Default: ``AZCW``\n+ :Examples: ``--enc-type AZCW``\n+\n+Type of the encoder to use in the simulation.\n+\n+Description of the allowed values:\n+\n++----------------+-----------------------------+\n+| Value | Description |\n++================+=============================+\n+| ``LDPC`` | |enc-type_descr_ldpc| |\n++----------------+-----------------------------+\n+| ``LDPC_H`` | |enc-type_descr_ldpc_h| |\n++----------------+-----------------------------+\n+| ``LDPC_DVBS2`` | |enc-type_descr_ldpc_dvbs2| |\n++----------------+-----------------------------+\n+| ``LDPC_IRA`` | |enc-type_descr_ldpc_ira| |\n++----------------+-----------------------------+\n+| ``LDPC_QC`` | |enc-type_descr_ldpc_qc| |\n++----------------+-----------------------------+\n+| ``AZCW`` | |enc-type_descr_azcw| |\n++----------------+-----------------------------+\n+| ``COSET`` | |enc-type_descr_coset| |\n++----------------+-----------------------------+\n+| ``USER`` | |enc-type_descr_user| |\n++----------------+-----------------------------+\n+\n+.. |enc-type_descr_ldpc| replace:: Encode from a given generator matrix.\n+.. |enc-type_descr_ldpc_h| replace:: Build the generator matrix from the\n+ given parity matrix and then encode with the ``LDPC`` method.\n+.. |enc-type_descr_ldpc_dvbs2| replace:: Optimized encoding from the chosen\n+ |DVB-S2| matrix. It is selected from its given dimensions.\n+.. |enc-type_descr_ldpc_ira| replace:: Optimized encoding from a given\n+ **IRA** parity matrix.\n+.. |enc-type_descr_ldpc_qc| replace:: Optimized encoding from a given\n+ **QC** parity matrix.\n+.. |enc-type_descr_azcw| replace:: See the common\n+ :ref:`enc-common-enc-type` parameter.\n+.. |enc-type_descr_coset| replace:: See the common\n+ :ref:`enc-common-enc-type` parameter.\n+.. |enc-type_descr_user| replace:: See the common\n+ :ref:`enc-common-enc-type` parameter.\n+\n+\n+.. note:: The ``LDPC_DVBS2`` encoder type allow the simulation of the\n+ |DVB-S2| standard but without the |BCH| code. All matrices described by\n+ `the standard (Tables 5a/5b page 22/23) <https://www.etsi.org/deliver/etsi_en/302300_302399/30230701/01.04.01_60/en_30230701v010401p.pdf>`_\n+ are available. You just need to give to the arguments\n+ :ref:`enc-ldpc-enc-info-bits` and\n+ :ref:`enc-ldpc-enc-cw-size` the real :math:`K` and :math:`N` |LDPC|\n+ dimensions, respectively.\n+\n.. _enc-ldpc-enc-cw-size:\n``--enc-cw-size, -N`` |image_required_argument|\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--enc-cw-size 1``\n+ :Examples: ``--enc-cw-size 1024``\n-The codeword size.\n+Set the codeword size. This argument is not required as the size is known\n+through the parity matrix given with :ref:`dec-ldpc-dec-h-path` or the\n+generator matrix given with :ref:`enc-ldpc-enc-g-path`.\n.. _enc-ldpc-enc-info-bits:\n@@ -19,9 +81,26 @@ The codeword size.\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--enc-info-bits 1``\n+ :Examples: ``--enc-info-bits 512``\n+\n+Give the useful number of information bits. This argument is not required as the\n+size is known through the generator matrix when given with\n+:ref:`enc-ldpc-enc-g-path`. If not it is calculated from\n+the parity matrix given with :ref:`dec-ldpc-dec-h-path`,\n+as :math:`K = N - M` where :math:`N` and :math:`M`\n+are the parity matrix dimensions, considering then a regular matrix. For\n+*non-regular matrices*, :math:`K` has to be given.\n+\n+.. _enc-ldpc-enc-g-path:\n+\n+``--enc-g-path``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: file\n+ :Rights: read only\n+ :Examples: ``--enc-g-path example/path/to/the/G_matrix.alist``\n-Useful number of bit transmitted (information bits).\n+Give the path to the generator matrix in a AList or Qc formated file.\n.. _enc-ldpc-enc-g-method:\n@@ -30,9 +109,11 @@ Useful number of bit transmitted (information bits).\n:Type: text\n:Allowed values: ``IDENTITY`` ``LU_DEC``\n+ :Default: ``IDENTITY``\n:Examples: ``--enc-g-method IDENTITY``\n-The method used to generate G from H when using 'LDPC_H' encoder type. 'LU_DEC' method generates a hollow G thanks to the LU decomposition with a guarantee to have the systematic identity (do not work with irregular matrices) when the 'IDENTITY' method generate an identity on H to get the parity part.\n+Specify the method used to build the generator matrix from the parity matrix\n+when using the ``LDPC_H`` encoder type.\nDescription of the allowed values:\n@@ -44,31 +125,15 @@ Description of the allowed values:\n| ``LU_DEC`` | |enc-g-method_descr_lu_dec| |\n+--------------+-------------------------------+\n-.. |enc-g-method_descr_identity| replace:: TODO VALUE IDENTITY\n-.. |enc-g-method_descr_lu_dec| replace:: TODO VALUE LU_DEC\n-\n+.. _LU decomposition: https://en.wikipedia.org/wiki/LU_decomposition\n-.. _enc-ldpc-enc-g-path:\n-\n-``--enc-g-path``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+.. |enc-g-method_descr_identity| replace:: Generate an identity on H to get the\n+ parity part\n+.. |enc-g-method_descr_lu_dec| replace:: Generate a hollow G thanks to the\n+ `LU decomposition`_ with a guarantee to have the systematic identity.\n+ Do not work with irregular matrices.\n- :Type: file\n- :Rights: read only\n- :Examples: ``--enc-g-path example/path/to/the/right/file``\n-\n-Path to the G matrix (AList formated file, required by the \"LDPC\" encoder).\n-\n-.. _enc-ldpc-enc-path:\n-\n-``--enc-path``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: file\n- :Rights: read only\n- :Examples: ``--enc-path example/path/to/the/right/file``\n-\n-Path to a file containing one or a set of pre-computed codewords, to use with \"\\\\-\\\\-enc-type USER\".\n+``LU_DEC`` method is faster than ``IDENTITY``.\n.. _enc-ldpc-enc-save-g:\n@@ -77,63 +142,12 @@ Path to a file containing one or a set of pre-computed codewords, to use with \"\\\n:Type: file\n:Rights: write only\n- :Examples: ``--enc-save-g example/path/to/the/right/file``\n-\n-Path where the generated G matrix with the 'LDPC_H' encoder type will be saved.\n-\n-.. _enc-ldpc-enc-start-idx:\n-\n-``--enc-start-idx``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: integer\n- :Examples: ``--enc-start-idx 1``\n-\n-Start idx to use in the USER type encoder.\n-\n-.. _enc-ldpc-enc-type:\n-\n-``--enc-type``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: text\n- :Allowed values: ``AZCW`` ``COSET`` ``LDPC`` ``LDPC_DVBS2`` ``LDPC_H`` ``LDPC_IRA`` ``LDPC_QC`` ``NO`` ``USER``\n- :Examples: ``--enc-type AZCW``\n-\n-Type of the encoder to use in the simulation.\n-\n-Description of the allowed values:\n-\n-+----------------+-----------------------------+\n-| Value | Description |\n-+================+=============================+\n-| ``AZCW`` | |enc-type_descr_azcw| |\n-+----------------+-----------------------------+\n-| ``COSET`` | |enc-type_descr_coset| |\n-+----------------+-----------------------------+\n-| ``LDPC`` | |enc-type_descr_ldpc| |\n-+----------------+-----------------------------+\n-| ``LDPC_DVBS2`` | |enc-type_descr_ldpc_dvbs2| |\n-+----------------+-----------------------------+\n-| ``LDPC_H`` | |enc-type_descr_ldpc_h| |\n-+----------------+-----------------------------+\n-| ``LDPC_IRA`` | |enc-type_descr_ldpc_ira| |\n-+----------------+-----------------------------+\n-| ``LDPC_QC`` | |enc-type_descr_ldpc_qc| |\n-+----------------+-----------------------------+\n-| ``NO`` | |enc-type_descr_no| |\n-+----------------+-----------------------------+\n-| ``USER`` | |enc-type_descr_user| |\n-+----------------+-----------------------------+\n-\n-.. |enc-type_descr_azcw| replace:: TODO VALUE AZCW\n-.. |enc-type_descr_coset| replace:: TODO VALUE COSET\n-.. |enc-type_descr_ldpc| replace:: TODO VALUE LDPC\n-.. |enc-type_descr_ldpc_dvbs2| replace:: TODO VALUE LDPC_DVBS2\n-.. |enc-type_descr_ldpc_h| replace:: TODO VALUE LDPC_H\n-.. |enc-type_descr_ldpc_ira| replace:: TODO VALUE LDPC_IRA\n-.. |enc-type_descr_ldpc_qc| replace:: TODO VALUE LDPC_QC\n-.. |enc-type_descr_no| replace:: TODO VALUE NO\n-.. |enc-type_descr_user| replace:: TODO VALUE USER\n+ :Examples: ``--enc-save-g example/path/to/the/generated/G_matrix.alist``\n+Give the filename where the built generator matrix with the ``LDPC_H`` encoder\n+is saved in an AList format.\n+.. hint:: It is useful to not have to generate again and again this matrix\n+ simulation after simulation. Use this option the first time but pay attention\n+ to generate it only on a single thread with :ref:`sim-sim-threads`\n+ to not write the file several times.\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/puncturer.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/puncturer.rst",
"diff": "Puncturer parameters\n--------------------\n-.. _pct-ldpc-pct-fra-size:\n-\n-``--pct-fra-size, -N`` |image_required_argument|\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: integer\n- :Examples: ``--pct-fra-size 1``\n-\n-Useful number of bit transmitted (information bits).\n-\n-.. _pct-ldpc-pct-pattern:\n-\n-``--pct-pattern``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: text\n- :Examples: ``--pct-pattern \"TODO CHECK VALUE\"``\n-\n-Puncturing pattern for the LDPC encoder/decoder (size = N_Code/Z) (ex: \"1,1,1,0\").\n-\n.. _pct-ldpc-pct-type:\n``--pct-type``\n@@ -30,9 +10,10 @@ Puncturing pattern for the LDPC encoder/decoder (size = N_Code/Z) (ex: \"1,1,1,0\"\n:Type: text\n:Allowed values: ``LDPC`` ``NO``\n+ :Default: ``LDPC``\n:Examples: ``--pct-type LDPC``\n-Code puncturer type.\n+Select the puncturer type.\nDescription of the allowed values:\n@@ -44,7 +25,33 @@ Description of the allowed values:\n| ``NO`` | |pct-type_descr_no| |\n+----------+-----------------------+\n-.. |pct-type_descr_ldpc| replace:: TODO VALUE LDPC\n-.. |pct-type_descr_no| replace:: TODO VALUE NO\n+.. |pct-type_descr_ldpc| replace:: Puncture the |LDPC| codeword.\n+.. |pct-type_descr_no| replace:: Deactivate the puncturer.\n+\n+.. _pct-ldpc-pct-fra-size:\n+\n+``--pct-fra-size, -N`` |image_required_argument|\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: integer\n+ :Examples: ``--pct-fra-size 912``\n+\n+Set the number of bit transmitted after the puncture process.\n+If the given size matches with the codeword size, then the puncturer is\n+deactivated.\n+\n+.. _pct-ldpc-pct-pattern:\n+\n+``--pct-pattern``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: binary vector\n+ :Examples: ``--pct-pattern \"1,1,1,0\"``\n+Give the puncturing pattern following the |LDPC| code.\n+The number :math:`P` of values given in this pattern must be as\n+:math:`N_{cw} = P \\times Z` where :math:`Z` is the number of bits represented\n+by a single value in the pattern.\n+This |LDPC| puncturer behavior is such as, for the above example, the first\n+three quarter bits are kept and the last quarter is removed from the frame.\n\\ No newline at end of file\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/references.bib",
"diff": "+@Article{Peeling2001,\n+ author = {M.G. Luby ; M. Mitzenmacher ; M.A. Shokrollahi ; D.A. Spielman},\n+ journal = {IEEE Transactions on Information Theory (TIT)},\n+ title = {Efficient erasure correcting codes},\n+ year = {2001},\n+ volume = {47},\n+ number = {2},\n+ pages = {569 - 584},\n+ abstract = {We introduce a simple erasure recovery algorithm for codes derived from cascades of sparse bipartite graphs and analyze the algorithm by analyzing a corresponding discrete-time random process. As a result, we obtain a simple criterion involving the fractions of nodes of different degrees on both sides of the graph which is necessary and sufficient for the decoding process to finish successfully with high probability. By carefully designing these graphs we can construct for any given rate R and any given real number /spl epsiv/ a family of linear codes of rate R which can be encoded in time proportional to ln(1//spl epsiv/) times their block length n. Furthermore, a codeword can be recovered with high probability from a portion of its entries of length (1+/spl epsiv/)Rn or more. The recovery algorithm also runs in time proportional to n ln(1//spl epsiv/). Our algorithms have been implemented and work well in practice; various implementation issues are discussed.},\n+ keywords = {error correction codes, linear codes, decoding, probability, graph theory, random processes, LDPC},\n+ doi = {10.1109/18.910575},\n+ ISSN = {0018-9448},\n+ month = feb,\n+}\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: work on the LDPC codec
|
8,490 |
30.11.2018 18:25:18
| -3,600 |
baf510b9eae972f07e534a4258da7370d3dba6c4
|
Doc: typos LDPC.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/conf.py",
"new_path": "doc/sphinx/source/conf.py",
"diff": "@@ -281,6 +281,7 @@ rst_epilog = \"\"\"\n.. |GSM| replace:: :abbr:`GSM (Global System for Mobile Communications)`\n.. |GUI| replace:: :abbr:`GUI (Graphical User Interface)`\n.. |IFL| replace:: :abbr:`IFL (Inter Frame Level)`\n+.. |IRA| replace:: :abbr:`IRA (Irregular Repeat Accumulate)`\n.. |ISA| replace:: :abbr:`ISA (Instruction Set Architecture)`\n.. |ISAs| replace:: :abbr:`ISAs (Instruction Set Architectures)`\n.. |LDPC| replace:: :abbr:`LDPC (Low-Density Parity-Check)`\n@@ -313,6 +314,7 @@ rst_epilog = \"\"\"\n.. |PSK| replace:: :abbr:`PSK (Phase-Shift Keying)`\n.. |PyBER| replace:: PyBER\n.. |QAM| replace:: :abbr:`QAM (Quadrature Amplitude Modulation)`\n+.. |QC| replace:: :abbr:`QC (Quasi-Cyclic)`\n.. |RA| replace:: :abbr:`RA (Repeat and Accumulate)`\n.. |release| replace:: \"\"\" + release + \"\"\"\n.. |ROP| replace:: :abbr:`ROP (Received Optical Power)`\n@@ -332,6 +334,7 @@ rst_epilog = \"\"\"\n.. |TPC| replace:: :abbr:`TPC (Turbo Product Code)`\n.. |TV| replace:: :abbr:`TV (Tal & Vardy)`\n.. |version| replace:: \"\"\" + version + \"\"\"\n+.. |WBF| replace:: :abbr:`WBF (Weighted Bit Flipping)`\n\"\"\"\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/encoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/encoder.rst",
"diff": ":Type: integer\n:Examples: ``--enc-cw-size 1024``\n-Set the codeword size. This argument is not required as the size is known\n-through the parity matrix given with :ref:`dec-ldpc-dec-h-path` or the\n-generator matrix given with :ref:`enc-ldpc-enc-g-path`.\n+Set the codeword size :math:`N`. This argument is not required as the size is\n+known through the parity matrix given with the :ref:`dec-ldpc-dec-h-path`\n+parameter or through the generator matrix given with the\n+:ref:`enc-ldpc-enc-g-path` parameter.\n.. _enc-ldpc-enc-info-bits:\n@@ -23,13 +24,12 @@ generator matrix given with :ref:`enc-ldpc-enc-g-path`.\n:Type: integer\n:Examples: ``--enc-info-bits 512``\n-Give the useful number of information bits. This argument is not required as the\n-size is known through the generator matrix when given with\n-:ref:`enc-ldpc-enc-g-path`. If not it is calculated from\n-the parity matrix given with :ref:`dec-ldpc-dec-h-path`,\n-as :math:`K = N - M` where :math:`N` and :math:`M`\n-are the parity matrix dimensions, considering then a regular matrix. For\n-*non-regular matrices*, :math:`K` has to be given.\n+Set the number of information bits :math:`K`. This argument is not required as\n+the size is known through the generator matrix when given with the\n+:ref:`enc-ldpc-enc-g-path` parameter. If not it is calculated from the parity\n+matrix given with the :ref:`dec-ldpc-dec-h-path` parameter, as :math:`K = N - M`\n+where :math:`N` and :math:`M` are the parity matrix dimensions, considering then\n+a regular matrix. For *non-regular matrices*, :math:`K` has to be given.\n.. _enc-ldpc-enc-type:\n@@ -66,30 +66,34 @@ Description of the allowed values:\n| ``USER`` | |enc-type_descr_user| |\n+----------------+-----------------------------+\n-.. |enc-type_descr_ldpc| replace:: Encode from a given generator matrix.\n-.. |enc-type_descr_ldpc_h| replace:: Build the generator matrix from the\n- given parity matrix and then encode with the ``LDPC`` method.\n-.. |enc-type_descr_ldpc_dvbs2| replace:: Optimized encoding from the chosen\n- |DVB-S2| matrix. It is selected from its given dimensions.\n-.. |enc-type_descr_ldpc_ira| replace:: Optimized encoding from a given\n- **IRA** parity matrix.\n-.. |enc-type_descr_ldpc_qc| replace:: Optimized encoding from a given\n- **QC** parity matrix.\n-.. |enc-type_descr_azcw| replace:: See the common\n- :ref:`enc-common-enc-type` parameter.\n-.. |enc-type_descr_coset| replace:: See the common\n- :ref:`enc-common-enc-type` parameter.\n-.. |enc-type_descr_user| replace:: See the common\n- :ref:`enc-common-enc-type` parameter.\n-\n+.. |enc-type_descr_ldpc| replace:: Select the generic encoder that encode\n+ from a given :math:`G` generator matrix (to use with the\n+ :ref:`enc-ldpc-enc-g-path` parameter).\n+.. |enc-type_descr_ldpc_h| replace:: Build the :math:`G` generator matrix from\n+ the given :math:`H` parity matrix and then encode with the ``LDPC`` method\n+ (to use with the :ref:`dec-ldpc-dec-h-path` parameter).\n+.. |enc-type_descr_ldpc_dvbs2| replace:: Select the optimized encoding process\n+ for the |DVB-S2| :math:`H` matrices (to use with the\n+ :ref:`enc-ldpc-enc-cw-size` and :ref:`enc-ldpc-enc-info-bits` parameters).\n+.. |enc-type_descr_ldpc_ira| replace:: Select the optimized encoding process for\n+ the |IRA| :math:`H` parity matrices (to use with the\n+ :ref:`dec-ldpc-dec-h-path` parameter).\n+.. |enc-type_descr_ldpc_qc| replace:: Select the optimized encoding process for\n+ the |QC| :math:`H` parity matrices (to use with the\n+ :ref:`dec-ldpc-dec-h-path` parameter).\n+.. |enc-type_descr_azcw| replace:: See the common :ref:`enc-common-enc-type`\n+ parameter.\n+.. |enc-type_descr_coset| replace:: See the common :ref:`enc-common-enc-type`\n+ parameter.\n+.. |enc-type_descr_user| replace:: See the common :ref:`enc-common-enc-type`\n+ parameter.\n.. note:: The ``LDPC_DVBS2`` encoder type allow the simulation of the\n|DVB-S2| standard but without the |BCH| code. All matrices described by\n- `the standard (Tables 5a/5b page 22/23) <https://www.etsi.org/deliver/etsi_en/302300_302399/30230701/01.04.01_60/en_30230701v010401p.pdf>`_\n+ `the standard (Tables 5a/5b page 22-23) <https://www.etsi.org/deliver/etsi_en/302300_302399/30230701/01.04.01_60/en_30230701v010401p.pdf>`_\nare available. You just need to give to the arguments\n- :ref:`enc-ldpc-enc-info-bits` and\n- :ref:`enc-ldpc-enc-cw-size` the real :math:`K` and :math:`N` |LDPC|\n- dimensions, respectively.\n+ :ref:`enc-ldpc-enc-info-bits` and :ref:`enc-ldpc-enc-cw-size` the real\n+ :math:`K` and :math:`N` |LDPC| dimensions, respectively.\n.. _enc-ldpc-enc-g-path:\n@@ -100,7 +104,8 @@ Description of the allowed values:\n:Rights: read only\n:Examples: ``--enc-g-path example/path/to/the/G_matrix.alist``\n-Give the path to the generator matrix in a AList or Qc formated file.\n+Give the path to the :math:`G` generator matrix in a AList or |QC| formated\n+file.\n.. _enc-ldpc-enc-g-method:\n@@ -112,8 +117,8 @@ Give the path to the generator matrix in a AList or Qc formated file.\n:Default: ``IDENTITY``\n:Examples: ``--enc-g-method IDENTITY``\n-Specify the method used to build the generator matrix from the parity matrix\n-when using the ``LDPC_H`` encoder type.\n+Specify the method used to build the :math:`G` generator matrix from the\n+:math:`H` parity matrix when using the ``LDPC_H`` encoder.\nDescription of the allowed values:\n@@ -144,8 +149,8 @@ Description of the allowed values:\n:Rights: write only\n:Examples: ``--enc-save-g example/path/to/the/generated/G_matrix.alist``\n-Give the filename where the built generator matrix with the ``LDPC_H`` encoder\n-is saved in an AList format.\n+Set the path where the :math:`G` generator matrix will be saved (AList\n+file format). To use with the ``LDPC_H`` encoder.\n.. hint:: It is useful to not have to generate again and again this matrix\nsimulation after simulation. Use this option the first time but pay attention\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: typos LDPC.
|
8,490 |
01.12.2018 12:07:38
| -3,600 |
2d0a575c11a950a371e0b97659547b18ac0f23eb
|
Doc: improve the LDPC parameters.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/conf.py",
"new_path": "doc/sphinx/source/conf.py",
"diff": "@@ -244,15 +244,22 @@ rst_epilog = \"\"\"\n.. |BCJR| replace:: :abbr:`BCJR (Bahl, Cocke, Jelinek and Raviv algorithm or Maximum A Posteriori (MAP))`\n.. |BEC| replace:: :abbr:`BEC (Binary Erasure Channel)`\n.. |BER| replace:: :abbr:`BER (Bit Error Rate)`\n+.. |BF| replace:: :abbr:`BF (Bit Flipping)`\n.. |BFER| replace:: :abbr:`BER/FER (Bit and Frame Error Rate)`\n.. |BPSK| replace:: :abbr:`BPSK (Bit Phase-Shift Keying)`\n.. |BM| replace:: :abbr:`BM (Berlekamp-Massey)`\n.. |BP| replace:: :abbr:`BP (Belief Propagation)`\n+.. |BP-F| replace:: :abbr:`BP-F (Belief Propagation with Flooding scheduling)`\n+.. |BP-HL| replace:: :abbr:`BP-HL (Belief Propagation with Horizontal Layered scheduling)`\n+.. |BP-P| replace:: :abbr:`BP-P (Belief Propagation Peeling)`\n+.. |BP-VL| replace:: :abbr:`BP-VL (Belief Propagation with Vertical Layered scheduling)`\n.. |BPS| replace:: :abbr:`BPS (Bit Per Symbol)`\n.. |BSC| replace:: :abbr:`BSC (Binary Symmetric Channel)`\n.. |CA| replace:: :abbr:`CA (CRC Aided)`\n.. |CCSDS| replace:: :abbr:`CCSDS (Consultative Committee for Space Data Systems)`\n.. |CDF| replace:: :abbr:`CDF (Cumulative Distribution Function)`\n+.. |CN| replace:: :abbr:`CN (Check Node)`\n+.. |CNs| replace:: :abbr:`CNs (Check Nodes)`\n.. |codec| replace:: :abbr:`codec (coder/decoder)`\n.. |codecs| replace:: :abbr:`codecs (coders/decodes)`\n.. |CP| replace:: :abbr:`CP (Chase-Pyndiah)`\n@@ -287,7 +294,7 @@ rst_epilog = \"\"\"\n.. |LDPC| replace:: :abbr:`LDPC (Low-Density Parity-Check)`\n.. |LLRs| replace:: :abbr:`LLRs (Log Likelihood Ratios)`\n.. |LLR| replace:: :abbr:`LLR (Log Likelihood Ratio)`\n-.. |LSPA| replace:: :abbr:`LSPA (Logarithm Sum-Product Algorithm)`\n+.. |LSPA| replace:: :abbr:`LSPA (Logarithmic Sum-Product Algorithm)`\n.. |LTE| replace:: :abbr:`LTE (Long Term Evolution)`\n.. |LUT| replace:: :abbr:`LUT (Look Up Table)`\n.. |LUTs| replace:: :abbr:`LUTs (Look Up Tables)`\n@@ -331,9 +338,12 @@ rst_epilog = \"\"\"\n.. |SPC| replace:: :abbr:`SPC (Single Parity Check)`\n.. |SPA| replace:: :abbr:`SPA (Sum-Product Algorithm)`\n.. |SSE| replace:: :abbr:`SSE (Streaming SIMD Extensions)`\n+.. |STD| replace:: :abbr:`STD (Standard)`\n.. |TPC| replace:: :abbr:`TPC (Turbo Product Code)`\n.. |TV| replace:: :abbr:`TV (Tal & Vardy)`\n.. |version| replace:: \"\"\" + version + \"\"\"\n+.. |VN| replace:: :abbr:`VN (Variable Node)`\n+.. |VNs| replace:: :abbr:`VNs (Variable Nodes)`\n.. |WBF| replace:: :abbr:`WBF (Weighted Bit Flipping)`\n\"\"\"\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"diff": ":Examples: ``--dec-h-path conf/dec/LDPC/AR4JA_4096_8192.qc``\n``--dec-h-path conf/dec/LDPC/MACKAY_504_1008.alist``\n-Give the path to the H matrix. Supported format are AList and QC files.\n+Give the path to the :math:`H` parity matrix. Support the AList and |QC|\n+formats.\n-This argument is not needed if the encoder type :ref:`enc-ldpc-enc-type`\n+This argument is not required if the encoder type :ref:`enc-ldpc-enc-type`\nis ``LDPC_DVBS2``.\n-.. TODO: info bits pos at the end of .alist file\n- puncturer pattern at the end of QC file\n-\n+.. TODO: info bits pos at the end of .alist file puncturer pattern at the end\n+ of QC file\n.. _dec-ldpc-dec-type:\n@@ -28,8 +28,9 @@ is ``LDPC_DVBS2``.\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: text\n- :Allowed values: ``BIT_FLIPPING`` ``BP_FLOODING`` ``BP_HORIZONTAL_LAYERED``\n- ``BP_PEELING`` ``BP_VERTICAL_LAYERED`` ``CHASE`` ``ML``\n+ :Allowed values: ``BIT_FLIPPING`` ``BP_PEELING`` ``BP_FLOODING``\n+ ``BP_HORIZONTAL_LAYERED`` ``BP_VERTICAL_LAYERED``\n+ ``CHASE`` ``ML``\n:Default: ``BP_FLOODING``\n:Examples: ``--dec-type BP_HORIZONTAL_LAYERED``\n@@ -37,36 +38,40 @@ Select the algorithm you want to decode the codeword.\nDescription of the allowed values:\n-+---------------------------+---------------------------------------------------------------+\n++---------------------------+--------------------------------------------------+\n| Value | Description |\n-+===========================+===============================================================+\n-| ``BIT_FLIPPING`` | The Bit Flipping algorithm. |\n-+---------------------------+---------------------------------------------------------------+\n-| ``BP_FLOODING`` | The Belief Propagation Flooding algorithm. |\n-+---------------------------+---------------------------------------------------------------+\n-| ``BP_HORIZONTAL_LAYERED`` | The Belief Propagation Horizontal Layered algorithm. |\n-+---------------------------+---------------------------------------------------------------+\n-| ``BP_VERTICAL_LAYERED`` | The Belief Propagation Vertical Layered algorithm. |\n-+---------------------------+---------------------------------------------------------------+\n-| ``BP_PEELING`` | The Belief Propagation Peeling algorithm :cite:`Peeling2001`. |\n-+---------------------------+---------------------------------------------------------------+\n-| ``CHASE`` | See the common :ref:`dec-common-dec-type` parameter. |\n-+---------------------------+---------------------------------------------------------------+\n-| ``ML`` | See the common :ref:`dec-common-dec-type` parameter. |\n-+---------------------------+---------------------------------------------------------------+\n-\n++===========================+==================================================+\n+| ``BIT_FLIPPING`` | Select the |BF| category of algorithms. |\n++---------------------------+--------------------------------------------------+\n+| ``BP_PEELING`` | Select the |BP-P| algorithm from |\n+| | :cite:`Peeling2001`. |\n++---------------------------+--------------------------------------------------+\n+| ``BP_FLOODING`` | Select the |BP-F| algorithm from |\n+| | :cite:`MacKay1995`. |\n++---------------------------+--------------------------------------------------+\n+| ``BP_HORIZONTAL_LAYERED`` | Select the |BP-HL| algorithm from |\n+| | :cite:`Yeo2001`. |\n++---------------------------+--------------------------------------------------+\n+| ``BP_VERTICAL_LAYERED`` | Select the |BP-VL| algorithm from |\n+| | :cite:`Zhang2002`. |\n++---------------------------+--------------------------------------------------+\n+| ``CHASE`` | See the common :ref:`dec-common-dec-type` |\n+| | parameter. |\n++---------------------------+--------------------------------------------------+\n+| ``ML`` | See the common :ref:`dec-common-dec-type` |\n+| | parameter. |\n++---------------------------+--------------------------------------------------+\n.. TODO: BP_HORIZONTAL_LAYERED_LEGACY and __cpp_aligned_new\n-\n.. _dec-ldpc-dec-implem:\n``--dec-implem``\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: text\n- :Allowed values: ``AMS`` ``GALA`` ``LSPA`` ``MS`` ``NMS`` ``OMS``\n- ``SPA`` ``STD`` ``WBF``\n+ :Allowed values: ``STD`` ``GALA`` ``WBF`` ``SPA`` ``LSPA`` ``AMS`` ``MS``\n+ ``NMS`` ``OMS``\n:Default: ``SPA``\n:Examples: ``--dec-implem AMS``\n@@ -74,81 +79,62 @@ Select the implementation of the algorithm to decode.\nDescription of the allowed values:\n-+-----------+--------------------------+\n++-----------+------------------------------------------------------------------+\n| Value | Description |\n-+===========+==========================+\n-| ``AMS`` | |dec-implem_descr_ams| |\n-+-----------+--------------------------+\n-| ``GALA`` | |dec-implem_descr_gala| |\n-+-----------+--------------------------+\n-| ``MS`` | |dec-implem_descr_ms| |\n-+-----------+--------------------------+\n-| ``NMS`` | |dec-implem_descr_nms| |\n-+-----------+--------------------------+\n-| ``OMS`` | |dec-implem_descr_oms| |\n-+-----------+--------------------------+\n-| ``SPA`` | |dec-implem_descr_spa| |\n-+-----------+--------------------------+\n-| ``LSPA`` | |dec-implem_descr_lspa| |\n-+-----------+--------------------------+\n-| ``STD`` | |dec-implem_descr_std| |\n-+-----------+--------------------------+\n-| ``WBF`` | |dec-implem_descr_wbf| |\n-+-----------+--------------------------+\n-\n-.. |dec-implem_descr_ams| replace:: The Approximate Min Star algorithm.\n-.. |dec-implem_descr_gala| replace:: The Gallager A algorithm.\n-.. |dec-implem_descr_ms| replace:: The Min-Sum algorithm.\n-.. |dec-implem_descr_nms| replace:: The Normalized Min-Sum algorithm.\n-.. |dec-implem_descr_oms| replace:: The Offset Min-Sum algorithm.\n-.. |dec-implem_descr_spa| replace:: The Sum-Product Algorithm.\n-.. |dec-implem_descr_lspa| replace:: The Log Sum-Product Algorithm.\n-.. |dec-implem_descr_std| replace:: A standard implementation of the decoder.\n-.. |dec-implem_descr_wbf| replace:: The Weighted Bit Flipping algorithm\n-\n-\n-The ``MS``, ``NMS`` and ``OMS`` implementations come from the *Offset-Normalized\n-Min-Sum* algorithm. The ``MS`` force the norm to 1 and the offset to 0.\n-The ``NMS`` leaves the norm free to the user to choose, when it is the offset\n-for the ``OMS``.\n-\n-\n-\n-The following table shows the different decoder types and their matching\n-implementation when no |SIMD| strategy is used:\n-\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-| Value | ``AMS``|``GALA``|``MS``|``NMS``|``OMS``|``SPA``|``LSPA``|``STD``|``WBF`` |\n-+===========================+========+========+======+=======+=======+=======+========+=======+========+\n-| ``BIT_FLIPPING`` | | | | | | | | | |OK| |\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-| ``BP_FLOODING`` | |OK| | |OK| | |OK| | |OK| | |OK| | |OK| | |OK| | | |\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-| ``BP_HORIZONTAL_LAYERED`` | |OK| | | |OK| | |OK| | |OK| | |OK| | |OK| | | |\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-| ``BP_VERTICAL_LAYERED`` | |OK| | | |OK| | |OK| | |OK| | |OK| | |OK| | | |\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-| ``BP_PEELING`` | | | | | | | | |OK| | |\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-\n-The following table shows the different decoder types and their matching\n-implementation when the ``INTER`` |SIMD| strategy is used:\n-\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-| Value | ``AMS``|``GALA``|``MS``|``NMS``|``OMS``|``SPA``|``LSPA``|``STD``|``WBF`` |\n-+===========================+========+========+======+=======+=======+=======+========+=======+========+\n-| ``BIT_FLIPPING`` | | | | | | | | | |\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-| ``BP_FLOODING`` | | | | | | | | | |\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-| ``BP_HORIZONTAL_LAYERED`` | | | |OK| | |OK| | |OK| | | | | |\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-| ``BP_VERTICAL_LAYERED`` | | | | | | | | | |\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-| ``BP_PEELING`` | | | | | | | | | |\n-+---------------------------+--------+--------+------+-------+-------+-------+--------+-------+--------+\n-\n-.. |OK| replace:: OK\n++===========+==================================================================+\n+| ``STD`` | Select the |STD| implementation. |\n++-----------+------------------------------------------------------------------+\n+| ``GALA`` | Select the |GALA| algorithm :cite:`Ryan2009`. |\n++-----------+------------------------------------------------------------------+\n+| ``WBF`` | Select the |WBF| algorithm :cite:`Wadayama2010`. |\n++-----------+------------------------------------------------------------------+\n+| ``SPA`` | Select the |SPA| update rules :cite:`MacKay1995`. |\n++-----------+------------------------------------------------------------------+\n+| ``LSPA`` | Select the |LSPA| update rules :cite:`MacKay1995`. |\n++-----------+------------------------------------------------------------------+\n+| ``AMS`` | Select the |AMS| update rules. |\n++-----------+------------------------------------------------------------------+\n+| ``MS`` | Select the |MS| update rules :cite:`Fossorier1999`. |\n++-----------+------------------------------------------------------------------+\n+| ``NMS`` | Select the |NMS| update rules :cite:`Chen2002`. |\n++-----------+------------------------------------------------------------------+\n+| ``OMS`` | Select the |OMS| update rules :cite:`Chen2002`. |\n++-----------+------------------------------------------------------------------+\n+\n+:numref:`tab_ldpc_dec_implem` shows the different decoder types and their\n+corresponding available implementations.\n+\n+.. _tab_ldpc_dec_implem:\n+\n+.. table:: |LDPC| decoder types and available implementations.\n+ :align: center\n+\n+ +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n+ | Decoder ||STD|||GALA|||WBF|||SPA|||LSPA|||AMS|||MS|||NMS|||OMS||\n+ +=========+=====+======+=====+=====+======+=====+====+=====+=====+\n+ | |BF| | | ||K| | | | | | | |\n+ +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-P| ||K| | | | | | | | | |\n+ +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-F| | ||K| | ||K2| ||K2| ||K2| ||K2|||K2| ||K2| |\n+ +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-HL| | | | ||K2| ||K2| ||K2| ||K1|||K1| ||K1| |\n+ +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-VL| | | | ||K2| ||K2| ||K2| ||K2|||K2| ||K2| |\n+ +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n+\n+.. |K| replace:: :math:`\\checkmark`\n+.. |K1| replace:: :math:`\\checkmark^{*}`\n+.. |K2| replace:: :math:`\\checkmark^{**}`\n+\n+:math:`^{*}/^{**}`: compatible with the :ref:`dec-ldpc-dec-simd`\n+``INTER`` parameter.\n+\n+:math:`^{**}`: require the C++ compiler to support the **dynamic memory\n+allocation for over-aligned data**, see the\n+`P0035R4 paper <http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2016/p0035r4.html>`_.\n+This feature is a part of the C++17 standard (working on the C++ GNU compiler\n+version 8.1.0).\n.. _dec-ldpc-dec-simd:\n@@ -173,7 +159,6 @@ Description of the allowed values:\n.. |dec-simd_descr_inter| replace:: The decoder processes several frames at the\nsame time.\n-\n.. _dec-ldpc-dec-h-reorder:\n``--dec-h-reorder``\n@@ -259,7 +244,6 @@ Description of the allowed values:\nfunction. ``MIN`` for *Min* is the simplest approximation with\nonly a :math:`\\min` function.\n-\n.. _dec-ldpc-dec-norm:\n``--dec-norm``\n@@ -313,7 +297,6 @@ is valid for several consecutive iterations.\nDisable the syndrome detection and so the stop criterion iteration after\niteration.\n-\nReferences\n\"\"\"\"\"\"\"\"\"\"\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/encoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/encoder.rst",
"diff": ":Type: integer\n:Examples: ``--enc-cw-size 1024``\n-Set the codeword size :math:`N`. This argument is not required as the size is\n-known through the parity matrix given with the :ref:`dec-ldpc-dec-h-path`\n-parameter or through the generator matrix given with the\n-:ref:`enc-ldpc-enc-g-path` parameter.\n+Set the codeword size :math:`N`.\n+\n+.. note:: This parameter value is automatically deduced if the :math:`H` parity\n+ matrix is given with the :ref:`dec-ldpc-dec-h-path` parameter or if the\n+ :math:`G` generator matrix is given with the :ref:`enc-ldpc-enc-g-path`\n+ parameter.\n.. _enc-ldpc-enc-info-bits:\n@@ -24,12 +26,16 @@ parameter or through the generator matrix given with the\n:Type: integer\n:Examples: ``--enc-info-bits 512``\n-Set the number of information bits :math:`K`. This argument is not required as\n-the size is known through the generator matrix when given with the\n-:ref:`enc-ldpc-enc-g-path` parameter. If not it is calculated from the parity\n-matrix given with the :ref:`dec-ldpc-dec-h-path` parameter, as :math:`K = N - M`\n-where :math:`N` and :math:`M` are the parity matrix dimensions, considering then\n-a regular matrix. For *non-regular matrices*, :math:`K` has to be given.\n+Set the number of information bits :math:`K`.\n+\n+.. note:: This parameter value is automatically deduced if the :math:`G`\n+ generator matrix is given with the :ref:`enc-ldpc-enc-g-path` parameter.\n+\n+.. note:: In some cases, this parameter value can be automatically deduced if\n+ the :math:`H` parity matrix is given with the :ref:`dec-ldpc-dec-h-path`\n+ parameter. For regular matrices, :math:`K = N - M` where :math:`N` and\n+ :math:`M` are the :math:`H` parity matrix dimensions. For *non-regular\n+ matrices*, :math:`K` has to be given.\n.. _enc-ldpc-enc-type:\n@@ -104,7 +110,7 @@ Description of the allowed values:\n:Rights: read only\n:Examples: ``--enc-g-path example/path/to/the/G_matrix.alist``\n-Give the path to the :math:`G` generator matrix in a AList or |QC| formated\n+Give the path to the :math:`G` generator matrix in an AList or |QC| formated\nfile.\n.. _enc-ldpc-enc-g-method:\n@@ -132,10 +138,10 @@ Description of the allowed values:\n.. _LU decomposition: https://en.wikipedia.org/wiki/LU_decomposition\n-.. |enc-g-method_descr_identity| replace:: Generate an identity on H to get the\n- parity part\n-.. |enc-g-method_descr_lu_dec| replace:: Generate a hollow G thanks to the\n- `LU decomposition`_ with a guarantee to have the systematic identity.\n+.. |enc-g-method_descr_identity| replace:: Generate an identity on :math:`H` to\n+ get the parity part.\n+.. |enc-g-method_descr_lu_dec| replace:: Generate a hollow :math:`G` thanks to\n+ the `LU decomposition`_ with a guarantee to have the systematic identity.\nDo not work with irregular matrices.\n``LU_DEC`` method is faster than ``IDENTITY``.\n@@ -149,10 +155,13 @@ Description of the allowed values:\n:Rights: write only\n:Examples: ``--enc-save-g example/path/to/the/generated/G_matrix.alist``\n-Set the path where the :math:`G` generator matrix will be saved (AList\n+Set the file path where the :math:`G` generator matrix will be saved (AList\nfile format). To use with the ``LDPC_H`` encoder.\n-.. hint:: It is useful to not have to generate again and again this matrix\n- simulation after simulation. Use this option the first time but pay attention\n- to generate it only on a single thread with :ref:`sim-sim-threads`\n- to not write the file several times.\n+.. hint:: When running the ``LDPC_H`` encoder, the generation of the :math:`G`\n+ matrix can take a non-negligible part of the simulation time. With this\n+ option the :math:`G` matrix can be saved once for all and used in the\n+ standard ``LDPC`` decoder after.\n+\n+.. warning:: This option is not thread-safe, please run it on a single thread\n+ with the :ref:`sim-sim-threads` parameter.\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: improve the LDPC parameters.
|
8,483 |
03.12.2018 08:39:00
| -3,600 |
61bb740597b8a5d22daf24e86110eb0bef4f79e0
|
Create Gallager B class, but still a simple copy of Gallager A
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Decoder/LDPC/Decoder_LDPC.cpp",
"new_path": "src/Factory/Module/Decoder/LDPC/Decoder_LDPC.cpp",
"diff": "#include \"Module/Decoder/LDPC/BP/Horizontal_layered/ONMS/Decoder_LDPC_BP_horizontal_layered_ONMS_inter.hpp\"\n#include \"Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_A.hpp\"\n+#include \"Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_B.hpp\"\n#include \"Module/Decoder/LDPC/BP/Peeling/Decoder_LDPC_BP_peeling.hpp\"\n#include \"Module/Decoder/LDPC/BF/OMWBF/Decoder_LDPC_bit_flipping_OMWBF.hpp\"\n@@ -75,7 +76,7 @@ void Decoder_LDPC::parameters\n#ifdef __cpp_aligned_new\ntools::add_options(args.at({p+\"-type\", \"D\"}), 0, \"BP_HORIZONTAL_LAYERED_LEGACY\");\n#endif\n- tools::add_options(args.at({p+\"-implem\" }), 0, \"SPA\", \"LSPA\", \"MS\", \"OMS\", \"NMS\", \"AMS\", \"GALA\", \"WBF\");\n+ tools::add_options(args.at({p+\"-implem\" }), 0, \"SPA\", \"LSPA\", \"MS\", \"OMS\", \"NMS\", \"AMS\", \"GALA\", \"GALB\", \"WBF\");\nargs.add(\n{p+\"-ite\", \"i\"},\n@@ -382,6 +383,7 @@ module::Decoder_SIHO<B,Q>* Decoder_LDPC::parameters\nif ((this->type == \"BP\" || this->type == \"BP_FLOODING\") && this->simd_strategy.empty())\n{\nif (this->implem == \"GALA\") return new module::Decoder_LDPC_BP_flooding_GALA<B,Q>(this->K, this->N_cw, this->n_ite, H, info_bits_pos, this->enable_syndrome, this->syndrome_depth, this->n_frames);\n+ if (this->implem == \"GALB\") return new module::Decoder_LDPC_BP_flooding_GALB<B,Q>(this->K, this->N_cw, this->n_ite, H, info_bits_pos, this->enable_syndrome, this->syndrome_depth, this->n_frames);\n}\nelse if (this->type == \"BP_PEELING\")\n{\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "src/Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_B.cpp",
"diff": "+#include <chrono>\n+#include <limits>\n+#include <sstream>\n+\n+#include \"Tools/Perf/common/hard_decide.h\"\n+#include \"Tools/Exception/exception.hpp\"\n+#include \"Tools/Math/utils.h\"\n+\n+#include \"Decoder_LDPC_BP_flooding_Gallager_B.hpp\"\n+\n+using namespace aff3ct;\n+using namespace aff3ct::module;\n+\n+template <typename B, typename R>\n+Decoder_LDPC_BP_flooding_Gallager_B<B,R>\n+::Decoder_LDPC_BP_flooding_Gallager_B(const int K, const int N, const int n_ite, const tools::Sparse_matrix &_H,\n+ const std::vector<unsigned> &info_bits_pos, const bool enable_syndrome,\n+ const int syndrome_depth, const int n_frames)\n+: Decoder (K, N, n_frames, 1 ),\n+ Decoder_SIHO_HIHO<B,R>(K, N, n_frames, 1 ),\n+ Decoder_LDPC_BP (K, N, n_ite, _H, enable_syndrome, syndrome_depth),\n+ info_bits_pos (info_bits_pos ),\n+ HY_N (N ),\n+ V_N (N ),\n+ chk_to_var (this->H.get_n_connections(), 0 ),\n+ var_to_chk (this->H.get_n_connections(), 0 ),\n+ transpose (this->H.get_n_connections() )\n+{\n+ const std::string name = \"Decoder_LDPC_BP_flooding_Gallager_B\";\n+ this->set_name(name);\n+\n+ std::vector<unsigned char> connections(this->H.get_n_rows(), 0);\n+\n+ const auto &chk_to_var_id = this->H.get_col_to_rows();\n+ const auto &var_to_chk_id = this->H.get_row_to_cols();\n+\n+ auto k = 0;\n+ for (auto i = 0; i < (int)chk_to_var_id.size(); i++)\n+ {\n+ for (auto j = 0; j < (int)chk_to_var_id[i].size(); j++)\n+ {\n+ auto var_id = chk_to_var_id[i][j];\n+\n+ auto branch_id = 0;\n+ for (auto ii = 0; ii < (int)var_id; ii++)\n+ branch_id += (int)var_to_chk_id[ii].size();\n+ branch_id += connections[var_id];\n+ connections[var_id]++;\n+\n+ if (connections[var_id] > (int)var_to_chk_id[var_id].size())\n+ {\n+ std::stringstream message;\n+ message << \"'connections[var_id]' has to be equal or smaller than 'var_to_chk_id[var_id].size()' \"\n+ << \"('var_id' = \" << var_id << \", 'connections[var_id]' = \" << connections[var_id]\n+ << \", 'var_to_chk_id[var_id].size()' = \" << var_to_chk_id[var_id].size() << \").\";\n+ throw tools::runtime_error(__FILE__, __LINE__, __func__, message.str());\n+ }\n+\n+ transpose[k] = branch_id;\n+ k++;\n+ }\n+ }\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_B<B,R>\n+::_decode_hiho(const B *Y_N, B *V_K, const int frame_id)\n+{\n+// auto t_decod = std::chrono::steady_clock::now(); // -------------------------------------------------------- DECODE\n+ this->_decode(Y_N);\n+// auto d_decod = std::chrono::steady_clock::now() - t_decod;\n+\n+// auto t_store = std::chrono::steady_clock::now(); // --------------------------------------------------------- STORE\n+ for (auto i = 0; i < this->K; i++)\n+ V_K[i] = (B)this->V_N[this->info_bits_pos[i]];\n+// auto d_store = std::chrono::steady_clock::now() - t_store;\n+\n+// (*this)[dec::tsk::decode_hiho].update_timer(dec::tm::decode_hiho::decode, d_decod);\n+// (*this)[dec::tsk::decode_hiho].update_timer(dec::tm::decode_hiho::store, d_store);\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_B<B,R>\n+::_decode_hiho_cw(const B *Y_N, B *V_N, const int frame_id)\n+{\n+// auto t_decod = std::chrono::steady_clock::now(); // -------------------------------------------------------- DECODE\n+ this->_decode(Y_N);\n+// auto d_decod = std::chrono::steady_clock::now() - t_decod;\n+\n+// auto t_store = std::chrono::steady_clock::now(); // --------------------------------------------------------- STORE\n+ std::copy(this->V_N.begin(), this->V_N.begin() + this->N, V_N);\n+// auto d_store = std::chrono::steady_clock::now() - t_store;\n+\n+// (*this)[dec::tsk::decode_hiho_cw].update_timer(dec::tm::decode_hiho_cw::decode, d_decod);\n+// (*this)[dec::tsk::decode_hiho_cw].update_timer(dec::tm::decode_hiho_cw::store, d_store);\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_B<B,R>\n+::_decode_siho(const R *Y_N, B *V_K, const int frame_id)\n+{\n+// auto t_load = std::chrono::steady_clock::now(); // ---------------------------------------------------------- LOAD\n+ tools::hard_decide(Y_N, HY_N.data(), this->N);\n+// auto d_load = std::chrono::steady_clock::now() - t_load;\n+\n+// auto t_decod = std::chrono::steady_clock::now(); // -------------------------------------------------------- DECODE\n+ this->_decode(HY_N.data());\n+// auto d_decod = std::chrono::steady_clock::now() - t_decod;\n+\n+// auto t_store = std::chrono::steady_clock::now(); // --------------------------------------------------------- STORE\n+ for (auto i = 0; i < this->K; i++)\n+ V_K[i] = (B)this->V_N[this->info_bits_pos[i]];\n+// auto d_store = std::chrono::steady_clock::now() - t_store;\n+\n+// (*this)[dec::tsk::decode_siho].update_timer(dec::tm::decode_siho::load, d_load);\n+// (*this)[dec::tsk::decode_siho].update_timer(dec::tm::decode_siho::decode, d_decod);\n+// (*this)[dec::tsk::decode_siho].update_timer(dec::tm::decode_siho::store, d_store);\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_B<B,R>\n+::_decode_siho_cw(const R *Y_N, B *V_N, const int frame_id)\n+{\n+// auto t_load = std::chrono::steady_clock::now(); // ---------------------------------------------------------- LOAD\n+ tools::hard_decide(Y_N, HY_N.data(), this->N);\n+// auto d_load = std::chrono::steady_clock::now() - t_load;\n+\n+// auto t_decod = std::chrono::steady_clock::now(); // -------------------------------------------------------- DECODE\n+ this->_decode(HY_N.data());\n+// auto d_decod = std::chrono::steady_clock::now() - t_decod;\n+\n+// auto t_store = std::chrono::steady_clock::now(); // --------------------------------------------------------- STORE\n+ std::copy(this->V_N.begin(), this->V_N.begin() + this->N, V_N);\n+// auto d_store = std::chrono::steady_clock::now() - t_store;\n+\n+// (*this)[dec::tsk::decode_siho_cw].update_timer(dec::tm::decode_siho_cw::load, d_load);\n+// (*this)[dec::tsk::decode_siho_cw].update_timer(dec::tm::decode_siho_cw::decode, d_decod);\n+// (*this)[dec::tsk::decode_siho_cw].update_timer(dec::tm::decode_siho_cw::store, d_store);\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_B<B,R>\n+::_decode(const B *Y_N)\n+{\n+ auto ite = 0;\n+ for (; ite < this->n_ite; ite++)\n+ {\n+ this->_initialize_var_to_chk(Y_N, chk_to_var, var_to_chk, ite == 0);\n+ this->_decode_single_ite(this->var_to_chk, this->chk_to_var);\n+\n+ if (this->enable_syndrome && ite != this->n_ite -1)\n+ {\n+ // for the K variable nodes (make a majority vote with the entering messages)\n+ this->_make_majority_vote(Y_N, this->V_N);\n+ if (this->check_syndrome_hard(this->V_N.data()))\n+ break;\n+ }\n+ }\n+ if (ite == this->n_ite)\n+ this->_make_majority_vote(Y_N, this->V_N);\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_B<B,R>\n+::_initialize_var_to_chk(const B *Y_N, const std::vector<int8_t> &chk_to_var, std::vector<int8_t> &var_to_chk,\n+ const bool first_ite)\n+{\n+ auto chk_to_var_ptr = chk_to_var.data();\n+ auto var_to_chk_ptr = var_to_chk.data();\n+\n+ // for each variable nodes\n+ const auto n_var_nodes = (int)this->H.get_n_rows();\n+ for (auto v = 0; v < n_var_nodes; v++)\n+ {\n+ const auto var_degree = (int)this->H.get_row_to_cols()[v].size();\n+\n+ for (auto c = 0; c < var_degree; c++)\n+ {\n+ auto cur_state = Y_N[v];\n+ if (!first_ite)\n+ {\n+ auto count = 0;\n+ for (auto cc = 0; cc < var_degree; cc++)\n+ if (cc != c && chk_to_var_ptr[cc] != cur_state)\n+ count++;\n+\n+ cur_state = count == (var_degree -1) ? !cur_state : cur_state;\n+ }\n+\n+ var_to_chk_ptr[c] = (int8_t)cur_state;\n+ }\n+\n+ chk_to_var_ptr += var_degree;\n+ var_to_chk_ptr += var_degree;\n+ }\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_B<B,R>\n+::_decode_single_ite(const std::vector<int8_t> &var_to_chk, std::vector<int8_t> &chk_to_var)\n+{\n+ auto transpose_ptr = this->transpose.data();\n+\n+ // for each check nodes\n+ const auto n_chk_nodes = (int)this->H.get_n_cols();\n+ for (auto c = 0; c < n_chk_nodes; c++)\n+ {\n+ const auto chk_degree = (int)this->H.get_col_to_rows()[c].size();\n+\n+ auto acc = 0;\n+ for (auto v = 0; v < chk_degree; v++)\n+ acc ^= var_to_chk[transpose_ptr[v]];\n+\n+ for (auto v = 0; v < chk_degree; v++)\n+ chk_to_var[transpose_ptr[v]] = acc ^ var_to_chk[transpose_ptr[v]];\n+\n+ transpose_ptr += chk_degree;\n+ }\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_B<B,R>\n+::_make_majority_vote(const B *Y_N, std::vector<int8_t> &V_N)\n+{\n+ auto chk_to_var_ptr = this->chk_to_var.data();\n+\n+ // for the K variable nodes (make a majority vote with the entering messages)\n+ const auto n_var_nodes = (int)this->H.get_n_rows();\n+ for (auto v = 0; v < n_var_nodes; v++)\n+ {\n+ const auto var_degree = (int)this->H.get_row_to_cols()[v].size();\n+ auto count = 0;\n+\n+ for (auto c = 0; c < var_degree; c++)\n+ count += chk_to_var_ptr[c] ? 1 : -1;\n+\n+ if (var_degree % 2 == 0)\n+ count += Y_N[v] ? 1 : -1;\n+\n+ // take the hard decision\n+ V_N[v] = count > 0 ? 1 : 0;\n+\n+ chk_to_var_ptr += var_degree;\n+ }\n+}\n+\n+// ==================================================================================== explicit template instantiation\n+#include \"Tools/types.h\"\n+#ifdef AFF3CT_MULTI_PREC\n+template class aff3ct::module::Decoder_LDPC_BP_flooding_Gallager_B<B_8,Q_8>;\n+template class aff3ct::module::Decoder_LDPC_BP_flooding_Gallager_B<B_16,Q_16>;\n+template class aff3ct::module::Decoder_LDPC_BP_flooding_Gallager_B<B_32,Q_32>;\n+template class aff3ct::module::Decoder_LDPC_BP_flooding_Gallager_B<B_64,Q_64>;\n+#else\n+template class aff3ct::module::Decoder_LDPC_BP_flooding_Gallager_B<B,Q>;\n+#endif\n+// ==================================================================================== explicit template instantiation\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "src/Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_B.hpp",
"diff": "+#ifndef DECODER_LDPC_BP_FLOODING_GALLAGER_B_HPP_\n+#define DECODER_LDPC_BP_FLOODING_GALLAGER_B_HPP_\n+\n+#include <cstdint>\n+\n+#include \"../../../../Decoder_SIHO_HIHO.hpp\"\n+#include \"../../Decoder_LDPC_BP.hpp\"\n+\n+namespace aff3ct\n+{\n+namespace module\n+{\n+template <typename B = int, typename R = float>\n+class Decoder_LDPC_BP_flooding_Gallager_B : public Decoder_SIHO_HIHO<B,R>, public Decoder_LDPC_BP\n+{\n+protected:\n+ const std::vector<uint32_t> &info_bits_pos;\n+\n+ std::vector<B > HY_N; // input LLRs (transformed in bit)\n+ std::vector<int8_t > V_N; // decoded bits\n+ std::vector<int8_t > chk_to_var; // check nodes to variable nodes messages\n+ std::vector<int8_t > var_to_chk; // variable nodes to check nodes messages\n+ std::vector<unsigned> transpose;\n+\n+public:\n+ Decoder_LDPC_BP_flooding_Gallager_B(const int K, const int N, const int n_ite, const tools::Sparse_matrix &H,\n+ const std::vector<unsigned> &info_bits_pos,\n+ const bool enable_syndrome = true,\n+ const int syndrome_depth = 1,\n+ const int n_frames = 1);\n+ virtual ~Decoder_LDPC_BP_flooding_Gallager_B() = default;\n+\n+protected:\n+ void _decode_hiho (const B *Y_N, B *V_K, const int frame_id);\n+ void _decode_hiho_cw(const B *Y_N, B *V_K, const int frame_id);\n+ void _decode_siho (const R *Y_N, B *V_K, const int frame_id);\n+ void _decode_siho_cw(const R *Y_N, B *V_K, const int frame_id);\n+\n+ void _decode (const B *Y_N);\n+ void _initialize_var_to_chk(const B *Y_N, const std::vector<int8_t> &chk_to_var, std::vector<int8_t> &var_to_chk,\n+ const bool first_ite);\n+ void _decode_single_ite (const std::vector<int8_t> &var_to_chk, std::vector<int8_t> &chk_to_var);\n+ void _make_majority_vote (const B *Y_N, std::vector<int8_t> &V_N);\n+};\n+\n+template <typename B = int, typename R = float>\n+using Decoder_LDPC_BP_flooding_GALB = Decoder_LDPC_BP_flooding_Gallager_B<B,R>;\n+}\n+}\n+\n+#endif /* DECODER_LDPC_BP_FLOODING_GALLAGER_B_HPP_ */\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Create Gallager B class, but still a simple copy of Gallager A
|
8,483 |
03.12.2018 10:29:57
| -3,600 |
839be96b05119f4be08b451dc41debedc181b4ac
|
Doc : Change ref to Gallager A
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"diff": "@@ -84,7 +84,7 @@ Description of the allowed values:\n+===========+==================================================================+\n| ``STD`` | Select the |STD| implementation. |\n+-----------+------------------------------------------------------------------+\n-| ``GALA`` | Select the |GALA| algorithm :cite:`Ryan2009`. |\n+| ``GALA`` | Select the |GALA| algorithm :cite:`BazziRichardsonUrbanke2004`. |\n+-----------+------------------------------------------------------------------+\n| ``WBF`` | Select the |WBF| algorithm :cite:`Wadayama2010`. |\n+-----------+------------------------------------------------------------------+\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/references.bib",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/references.bib",
"diff": "@@ -122,3 +122,18 @@ are also included to test and enhance learning, making this an essential resourc\nISSN = {1089-7798},\nmonth = may,\n}\n+\n+@Article{BazziRichardsonUrbanke2004,\n+ author = {L. Bazzi ; T.J. Richardson ; R.L. Urbanke},\n+ journal = {IEEE Transactions on Information Theory},\n+ title = {Exact thresholds and optimal codes for the binary-symmetric channel and Gallager's decoding algorithm A},\n+ year = {2004},\n+ volume = {50},\n+ number = {9},\n+ pages = {2010 - 2021},\n+ abstract = {We show that for the case of the binary-symmetric channel and Gallager's decoding algorithm A the threshold can, in many cases, be determined analytically. More precisely, we show that the threshold is always upper-bounded by the minimum of (1-/spl lambda//sub 2//spl rho/'(1))/(/spl lambda/'(1)/spl rho/'(1)-/spl lambda//sub 2//spl rho/'(1)) and the smallest positive real root /spl tau/ of a specific polynomial p(x) and we observe that for most cases this bound is tight, i.e., it determines the threshold exactly. We also present optimal degree distributions for a large range of rates. In the case of rate one-half codes, for example, the threshold x/sub 0//sup */ of the optimal degree distribution is given by x/sup *//sub 0//spl sim/0.0513663. Finally, we outline how thresholds of more complicated decoders might be determined analytically.},\n+ keywords = {Parity check codes,Iterative algorithms,Iterative decoding,Communication channels,Belief propagation,Algorithm design and analysis,Polynomials,Turbo codes,Bipartite graph,Information theory},\n+ doi = {10.1109/TIT.2004.833352},\n+ ISSN = {1557-9654},\n+ month = sep,\n+}\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc : Change ref to Gallager A
|
8,490 |
03.12.2018 10:35:00
| -3,600 |
e2ecad29436f0162d83313cc205525c2fd318661
|
Doc: add the turbo encoder parameters.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/conf.py",
"new_path": "doc/sphinx/source/conf.py",
"diff": "@@ -291,6 +291,7 @@ rst_epilog = \"\"\"\n.. |IRA| replace:: :abbr:`IRA (Irregular Repeat Accumulate)`\n.. |ISA| replace:: :abbr:`ISA (Instruction Set Architecture)`\n.. |ISAs| replace:: :abbr:`ISAs (Instruction Set Architectures)`\n+.. |JSON| replace:: :abbr:`JSON (JavaScript Object Notation)`\n.. |LDPC| replace:: :abbr:`LDPC (Low-Density Parity-Check)`\n.. |LLRs| replace:: :abbr:`LLRs (Log Likelihood Ratios)`\n.. |LLR| replace:: :abbr:`LLR (Log Likelihood Ratio)`\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo/encoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo/encoder.rst",
"diff": "@@ -11,7 +11,10 @@ Turbo Encoder parameters\n:Type: integer\n:Examples: ``--enc-info-bits 1``\n-Useful number of bit transmitted (information bits).\n+Set the number of information bits :math:`K`.\n+The codeword size :math:`N` is automatically deduced:\n+:math:`N = 3 \\times K + 4 \\times \\log_2(ts)` where :math:`ts` is the trellis\n+size.\n.. _enc-turbo-enc-type:\n@@ -22,7 +25,7 @@ Useful number of bit transmitted (information bits).\n:Allowed values: ``TURBO`` ``AZCW`` ``COSET`` ``USER``\n:Examples: ``--enc-type AZCW``\n-Type of the encoder to use in the simulation.\n+Select the encoder type.\nDescription of the allowed values:\n@@ -38,7 +41,7 @@ Description of the allowed values:\n| ``USER`` | |enc-type_descr_user| |\n+-----------+------------------------+\n-.. |enc-type_descr_turbo| replace:: TODO VALUE TURBO\n+.. |enc-type_descr_turbo| replace:: Select the standard Turbo encoder.\n.. |enc-type_descr_azcw| replace:: See the common :ref:`enc-common-enc-type`\nparameter.\n.. |enc-type_descr_coset| replace:: See the common :ref:`enc-common-enc-type`\n@@ -51,33 +54,7 @@ Description of the allowed values:\n``--enc-sub-type``\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n- :Type: text\n- :Allowed values: ``RSC`` ``AZCW`` ``COSET`` ``USER``\n- :Examples: ``--enc-sub-type AZCW``\n-\n-Type of the encoder to use in the simulation.\n-\n-Description of the allowed values:\n-\n-+-----------+----------------------------+\n-| Value | Description |\n-+===========+============================+\n-| ``RSC`` | |enc-sub-type_descr_rsc| |\n-+-----------+----------------------------+\n-| ``AZCW`` | |enc-sub-type_descr_azcw| |\n-+-----------+----------------------------+\n-| ``COSET`` | |enc-sub-type_descr_coset| |\n-+-----------+----------------------------+\n-| ``USER`` | |enc-sub-type_descr_user| |\n-+-----------+----------------------------+\n-\n-.. |enc-sub-type_descr_rsc| replace:: TODO VALUE RSC\n-.. |enc-sub-type_descr_azcw| replace:: See the common :ref:`enc-common-enc-type`\n- parameter.\n-.. |enc-sub-type_descr_coset| replace:: See the common :ref:`enc-common-enc-type`\n- parameter.\n-.. |enc-sub-type_descr_user| replace:: See the common :ref:`enc-common-enc-type`\n- parameter.\n+Please refer to the |RSC| :ref:`enc-rsc-enc-type` parameter.\n.. _enc-turbo-enc-json-path:\n@@ -88,7 +65,12 @@ Description of the allowed values:\n:Rights: write only\n:Examples: ``--enc-json-path example/path/to/the/right/file``\n-Path to store the encoder and decoder traces formated in JSON.\n+Select the file path to dump the encoder and decoder internal values (in |JSON|\n+format). Those values can be observed with the dedicated `Turbo Code Reader`\n+available on the |AFF3CT| website: http://aff3ct.github.io/turbo_reader.html.\n+\n+.. note:: Using this parameter will **slowdown considerably the encoder and\n+ decoder throughputs**.\n.. _enc-turbo-enc-sub-no-buff:\n@@ -97,15 +79,30 @@ Path to store the encoder and decoder traces formated in JSON.\nDisable the buffered encoding.\n+**Without the buffered encoding**, considering the following sequence of\n+:math:`K` information bits: :math:`U_0, U_1, [...], U_{K-1}`, the encoded bits\n+will be organized as follow:\n+:math:`X_0^{sn}, X_0^{pn}, X_0^{pi}, [...], X_{K-1}^{sn}, X_{K-1}^{pn}, X_{K-1}^{pi}, X_{0}^{sn^t}, X_{0}^{pn^t}, [...], X_{\\log_2(ts)-1}^{sn^t}, X_{\\log_2(ts)-1}^{pn^t}, X_{0}^{si^t}, X_{0}^{pi^t}, [...], X_{\\log_2(ts)-1}^{si^t}, X_{\\log_2(ts)-1}^{pi^t}`,\n+where :math:`sn` and :math:`pn` are respectively *systematic* and *parity* bits\n+in the *natural domain*, :math:`si` and :math:`pi` are respectively\n+*systematic* and *parity* bits in the *interleaved domain*, :math:`t` the\n+*tail bits* and and :math:`ts` the *trellis size*.\n+\n+**With the buffered encoding**, considering the following sequence of :math:`K`\n+information bits: :math:`U_0, U_1, [...], U_{K-1}`, the encoded bits will be\n+organized as follow:\n+:math:`X_0^{sn}, [...], X_{K-1}^{sn}, X_{0}^{sn^t}, [...], X_{\\log_2(ts)-1}^{sn^t}, X_0^{pn}, [...], X_{K-1}^{pn}, X_{0}^{pn^t}, [...], X_{\\log_2(ts)-1}^{pn^t}, X_{0}^{si^t}, [...], X_{\\log_2(ts)-1}^{si^t}, X_0^{pi}, [...], X_{K-1}^pi, X_{0}^{pi^t}, [...], X_{\\log_2(ts)-1}^{pi^t}`.\n+where :math:`sn` and :math:`pn` are respectively *systematic* and *parity* bits\n+in the *natural domain*, :math:`si` and :math:`pi` are respectively\n+*systematic* and *parity* bits in the *interleaved domain*, :math:`t` the\n+*tail bits* and and :math:`ts` the *trellis size*.\n+\n.. _enc-turbo-enc-sub-poly:\n``--enc-sub-poly``\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n- :Type: text\n- :Examples: ``--enc-sub-poly \"TODO CHECK VALUE\"``\n-\n-The polynomials describing RSC code, should be of the form \"{A,B}\".\n+Please refer to the |RSC| :ref:`enc-rsc-enc-poly` parameter.\n.. _enc-turbo-enc-sub-std:\n@@ -116,7 +113,7 @@ The polynomials describing RSC code, should be of the form \"{A,B}\".\n:Allowed values: ``CCSDS`` ``LTE``\n:Examples: ``--enc-sub-std CCSDS``\n-Select a standard and set automatically some parameters (overwritten with user\n+Select a standard: set automatically some parameters (can be overwritten by user\ngiven arguments).\nDescription of the allowed values:\n@@ -129,5 +126,10 @@ Description of the allowed values:\n| ``LTE`` | |enc-sub-std_descr_lte| |\n+-----------+---------------------------+\n-.. |enc-sub-std_descr_ccsds| replace:: TODO VALUE CCSDS\n-.. |enc-sub-std_descr_lte| replace:: TODO VALUE LTE\n\\ No newline at end of file\n+.. |enc-sub-std_descr_ccsds| replace:: Set the :ref:`enc-turbo-enc-sub-poly`\n+ parameter to ``{023,033}`` according to the |CCSDS| standard (16-stage\n+ trellis) and select the |CCSDS| interleaver (see the :ref:`itl-itl-type`\n+ parameter).\n+.. |enc-sub-std_descr_lte| replace:: Set the :ref:`enc-turbo-enc-sub-poly`\n+ parameter to ``{013,015}`` according to the |LTE| standard (8-stage trellis)\n+ and select the |LTE| interleaver (see the :ref:`itl-itl-type` parameter).\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: add the turbo encoder parameters.
|
8,490 |
03.12.2018 17:33:11
| -3,600 |
996c79225f9dcb351578ab40812398c8981cd09f
|
Doc: disable the classes.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/developer/classes/classes.rst",
"new_path": "doc/sphinx/source/developer/classes/classes.rst",
"diff": "Classes\n*******\n-This section details the |AFF3CT| source code classes and it is currently under\n-construction.\n+Work in progress...\n-.. toctree::\n- :caption: Contents\n- :maxdepth: 2\n+.. This section details the |AFF3CT| source code classes and it is currently under\n+.. construction.\n- factory/factory\n- launcher/launcher\n- module/module\n- simulation/simulation\n- tools/tools\n\\ No newline at end of file\n+.. .. toctree::\n+.. :caption: Contents\n+.. :maxdepth: 2\n+\n+.. factory/factory\n+.. launcher/launcher\n+.. module/module\n+.. simulation/simulation\n+.. tools/tools\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: disable the classes.
|
8,483 |
04.12.2018 08:57:47
| -3,600 |
a1eeb460da31ce63b39eec915f4b8410258e2c79
|
Doc: Change the example of monitor err hist parameter.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/monitor/monitor.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/monitor/monitor.rst",
"diff": "@@ -25,7 +25,7 @@ Set the maximum number of frame errors to simulated for each noise point.\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--mnt-err-hist 1``\n+ :Examples: ``--mnt-err-hist 0``\nEnable the construction of the errors per frame histogram. Set also the maximum\nnumber of bit errors per frame included in the histogram (0 means no limit).\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: Change the example of monitor err hist parameter.
|
8,483 |
04.12.2018 08:50:53
| -3,600 |
9924028f04c10db863f4867bd59bdd7c47de4d12
|
Doc: Fix interleaver read order ROW_COL title.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/interleaver/interleaver.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/interleaver/interleaver.rst",
"diff": "@@ -216,7 +216,7 @@ Description of the allowed values (see also the figures just bellow):\n:align: center\n:scale: 65\n- Interleaver ``COL_ROW`` read orders.\n+ Interleaver ``ROW_COL`` read orders.\n.. _itl-itl-uni:\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: Fix interleaver read order ROW_COL title.
|
8,490 |
04.12.2018 10:14:51
| -3,600 |
52ef48bf737240c83e8c0c02f45f1c77ba842156
|
Doc: add the LDPC SPA intra decoder.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"diff": "@@ -116,7 +116,7 @@ corresponding available implementations.\n+---------+-----+------+-----+-----+------+-----+----+-----+-----+\n| |BP-P| ||K| | | | | | | | | |\n+---------+-----+------+-----+-----+------+-----+----+-----+-----+\n- | |BP-F| | ||K| | ||K2| ||K2| ||K2| ||K2|||K2| ||K2| |\n+ | |BP-F| | ||K| | ||K3| ||K2| ||K2| ||K2|||K2| ||K2| |\n+---------+-----+------+-----+-----+------+-----+----+-----+-----+\n| |BP-HL| | | | ||K2| ||K2| ||K2| ||K1|||K1| ||K1| |\n+---------+-----+------+-----+-----+------+-----+----+-----+-----+\n@@ -126,8 +126,9 @@ corresponding available implementations.\n.. |K| replace:: :math:`\\checkmark`\n.. |K1| replace:: :math:`\\checkmark^{*}`\n.. |K2| replace:: :math:`\\checkmark^{**}`\n+.. |K3| replace:: :math:`\\checkmark^{**+}`\n-:math:`^{*}/^{**}`: compatible with the :ref:`dec-ldpc-dec-simd`\n+:math:`^{*}/^{**}/^{***}`: compatible with the :ref:`dec-ldpc-dec-simd`\n``INTER`` parameter.\n:math:`^{**}`: require the C++ compiler to support the **dynamic memory\n@@ -136,6 +137,8 @@ allocation for over-aligned data**, see the\nThis feature is a part of the C++17 standard (working on the C++ GNU compiler\nversion 8.1.0).\n+:math:`^{+}`: compatible with the :ref:`dec-ldpc-dec-simd` ``INTRA`` parameter.\n+\n.. _dec-ldpc-dec-simd:\n``--dec-simd``\n@@ -153,9 +156,12 @@ Description of the allowed values:\n+-----------+------------------------+\n| Value | Description |\n+===========+========================+\n+| ``INTRA`` | |dec-simd_descr_intra| |\n++-----------+------------------------+\n| ``INTER`` | |dec-simd_descr_inter| |\n+-----------+------------------------+\n+.. |dec-simd_descr_intra| replace:: Select the intra-frame strategy.\n.. |dec-simd_descr_inter| replace:: Select the inter-frame strategy.\n.. note:: In **the intra-frame strategy**, |SIMD| units process several LLRs in\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: add the LDPC SPA intra decoder.
|
8,490 |
04.12.2018 11:15:00
| -3,600 |
84038b48925feacaebe34954565fd11342a9b55c
|
Doc: add the GCC option to enable aligned new allocator.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"diff": "@@ -135,7 +135,8 @@ corresponding available implementations.\nallocation for over-aligned data**, see the\n`P0035R4 paper <http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2016/p0035r4.html>`_.\nThis feature is a part of the C++17 standard (working on the C++ GNU compiler\n-version 8.1.0).\n+version 8.1.0). When compiling with the GNU compiler in C++11 mode, the\n+``-faligned-new`` option enables specifically the required feature.\n:math:`^{+}`: compatible with the :ref:`dec-ldpc-dec-simd` ``INTRA`` parameter.\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: add the GCC option to enable aligned new allocator.
|
8,490 |
04.12.2018 11:25:56
| -3,600 |
b6f8de686cc462fd64a877b10921077331d3041e
|
Rm the --enc-json-path in the Turbo DB encoder, it was not used.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Encoder/Turbo_DB/Encoder_turbo_DB.cpp",
"new_path": "src/Factory/Module/Encoder/Turbo_DB/Encoder_turbo_DB.cpp",
"diff": "@@ -72,11 +72,6 @@ void Encoder_turbo_DB::parameters\ntools::add_options(args.at({p+\"-type\"}), 0, \"TURBO_DB\");\n- args.add(\n- {p+\"-json-path\"},\n- tools::File(tools::openmode::write),\n- \"path to store the encoder and decoder traces formated in JSON.\");\n-\nsub->get_description(args);\nauto ps = sub->get_prefix();\n@@ -131,9 +126,6 @@ void Encoder_turbo_DB::parameters\nif (this->tail_length)\nheaders[p].push_back(std::make_pair(\"Tail length\", std::to_string(this->tail_length)));\n- if (!this->json_path.empty())\n- headers[p].push_back(std::make_pair(\"Path to the JSON file\", this->json_path));\n-\nsub->get_headers(headers, full);\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Encoder/Turbo_DB/Encoder_turbo_DB.hpp",
"new_path": "src/Factory/Module/Encoder/Turbo_DB/Encoder_turbo_DB.hpp",
"diff": "@@ -25,9 +25,6 @@ struct Encoder_turbo_DB : public Encoder\n{\npublic:\n// ------------------------------------------------------------------------------------------------- PARAMETERS\n- // optional\n- std::string json_path = \"\";\n-\n// depending parameters\ntools::auto_cloned_unique_ptr<Interleaver ::parameters> itl;\ntools::auto_cloned_unique_ptr<Encoder_RSC_DB::parameters> sub;\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Rm the --enc-json-path in the Turbo DB encoder, it was not used.
|
8,490 |
04.12.2018 13:11:42
| -3,600 |
5caa3b6d6dab2da5510f17f07c1ba37611cef753
|
Rm the decoder NO from the generic encoders.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Codec/Uncoded/Codec_uncoded.cpp",
"new_path": "src/Factory/Module/Codec/Uncoded/Codec_uncoded.cpp",
"diff": "#include \"Codec_uncoded.hpp\"\n+#include \"Factory/Module/Encoder/NO/Encoder_NO.hpp\"\n#include \"Factory/Module/Decoder/NO/Decoder_NO.hpp\"\nusing namespace aff3ct;\n@@ -13,7 +14,7 @@ Codec_uncoded::parameters\n: Codec ::parameters(Codec_uncoded_name, prefix),\nCodec_SISO_SIHO::parameters(Codec_uncoded_name, prefix)\n{\n- Codec::parameters::set_enc(new Encoder ::parameters(\"enc\"));\n+ Codec::parameters::set_enc(new Encoder_NO::parameters(\"enc\"));\nCodec::parameters::set_dec(new Decoder_NO::parameters(\"dec\"));\n}\n@@ -35,9 +36,6 @@ void Codec_uncoded::parameters\nauto pdec = dec->get_prefix();\nargs.erase({penc+\"-type\" });\n- args.erase({penc+\"-cw-size\", \"N\"});\n- args.erase({penc+\"-path\" });\n- args.erase({penc+\"-seed\", \"S\"});\nargs.erase({pdec+\"-cw-size\", \"N\"});\nargs.erase({pdec+\"-info-bits\", \"K\"});\nargs.erase({pdec+\"-fra\", \"F\"});\n@@ -80,7 +78,8 @@ template <typename B, typename Q>\nmodule::Codec_uncoded<B,Q>* Codec_uncoded::parameters\n::build(module::CRC<B>* crc) const\n{\n- return new module::Codec_uncoded<B,Q>(*enc, dynamic_cast<const Decoder_NO::parameters&>(*dec));\n+ return new module::Codec_uncoded<B,Q>(dynamic_cast<const Encoder_NO::parameters&>(*enc),\n+ dynamic_cast<const Decoder_NO::parameters&>(*dec));\n}\ntemplate <typename B, typename Q>\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Encoder/Encoder.cpp",
"new_path": "src/Factory/Module/Encoder/Encoder.cpp",
"diff": "#include \"Tools/Exception/exception.hpp\"\n-#include \"Module/Encoder/NO/Encoder_NO.hpp\"\n#include \"Module/Encoder/AZCW/Encoder_AZCW.hpp\"\n#include \"Module/Encoder/Coset/Encoder_coset.hpp\"\n#include \"Module/Encoder/User/Encoder_user.hpp\"\n@@ -55,7 +54,7 @@ void Encoder::parameters\nargs.add(\n{p+\"-type\"},\n- tools::Text(tools::Including_set(\"NO\", \"USER\", \"AZCW\", \"COSET\")),\n+ tools::Text(tools::Including_set(\"AZCW\", \"COSET\", \"USER\")),\n\"type of the encoder to use in the simulation.\");\nargs.add(\n@@ -112,7 +111,6 @@ template <typename B>\nmodule::Encoder<B>* Encoder::parameters\n::build() const\n{\n- if (this->type == \"NO\" ) return new module::Encoder_NO <B>(this->K, this->n_frames);\nif (this->type == \"AZCW\" ) return new module::Encoder_AZCW <B>(this->K, this->N_cw, this->n_frames);\nif (this->type == \"COSET\") return new module::Encoder_coset<B>(this->K, this->N_cw, this->seed, this->n_frames);\nif (this->type == \"USER\" ) return new module::Encoder_user <B>(this->K, this->N_cw, this->path, this->n_frames, this->start_idx);\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Encoder/Encoder.hpp",
"new_path": "src/Factory/Module/Encoder/Encoder.hpp",
"diff": "@@ -24,7 +24,7 @@ struct Encoder : public Factory\nint N_cw = 0;\n// optional parameters\n- std::string type = \"NO\";\n+ std::string type = \"AZCW\";\nstd::string path = \"\";\nbool systematic = true;\nint n_frames = 1;\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Module/Codec/Uncoded/Codec_uncoded.cpp",
"new_path": "src/Module/Codec/Uncoded/Codec_uncoded.cpp",
"diff": "#include \"Tools/Exception/exception.hpp\"\n-#include \"Factory/Module/Encoder/Encoder.hpp\"\n+#include \"Factory/Module/Encoder/NO/Encoder_NO.hpp\"\n#include \"Factory/Module/Decoder/NO/Decoder_NO.hpp\"\n#include \"Factory/Module/Puncturer/Puncturer.hpp\"\n@@ -13,7 +13,7 @@ using namespace aff3ct::module;\ntemplate <typename B, typename Q>\nCodec_uncoded<B,Q>\n-::Codec_uncoded(const factory::Encoder ::parameters &enc_params,\n+::Codec_uncoded(const factory::Encoder_NO::parameters &enc_params,\nconst factory::Decoder_NO::parameters &dec_params)\n: Codec <B,Q>(enc_params.K, enc_params.N_cw, enc_params.N_cw, enc_params.tail_length, enc_params.n_frames),\nCodec_SISO_SIHO<B,Q>(enc_params.K, enc_params.N_cw, enc_params.N_cw, enc_params.tail_length, enc_params.n_frames)\n@@ -63,7 +63,7 @@ Codec_uncoded<B,Q>\npct_params.n_frames = enc_params.n_frames;\nthis->set_puncturer(factory::Puncturer::build<B,Q>(pct_params));\n- this->set_encoder (factory::Encoder::build<B>(enc_params));\n+ this->set_encoder (factory::Encoder_NO::build<B>(enc_params));\ntry\n{\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Module/Codec/Uncoded/Codec_uncoded.hpp",
"new_path": "src/Module/Codec/Uncoded/Codec_uncoded.hpp",
"diff": "#ifndef CODEC_UNCODED_HPP_\n#define CODEC_UNCODED_HPP_\n-#include \"Factory/Module/Encoder/Encoder.hpp\"\n+#include \"Factory/Module/Encoder/NO/Encoder_NO.hpp\"\n#include \"Factory/Module/Decoder/NO/Decoder_NO.hpp\"\n#include \"../Codec_SISO_SIHO.hpp\"\n@@ -14,7 +14,7 @@ template <typename B = int, typename Q = float>\nclass Codec_uncoded : public Codec_SISO_SIHO<B,Q>\n{\npublic:\n- Codec_uncoded(const factory::Encoder ::parameters &enc_params,\n+ Codec_uncoded(const factory::Encoder_NO::parameters &enc_params,\nconst factory::Decoder_NO::parameters &dec_params);\nvirtual ~Codec_uncoded() = default;\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Rm the decoder NO from the generic encoders.
|
8,490 |
04.12.2018 13:12:25
| -3,600 |
1c384ee3fd95614ac99ae9baee04a4a0010f049d
|
Rename the REPETITON encoder in REP encoder like the codec.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Encoder/Repetition/Encoder_repetition.cpp",
"new_path": "src/Factory/Module/Encoder/Repetition/Encoder_repetition.cpp",
"diff": "@@ -14,7 +14,7 @@ Encoder_repetition::parameters\n::parameters(const std::string &prefix)\n: Encoder::parameters(Encoder_repetition_name, prefix)\n{\n- this->type = \"REPETITION\";\n+ this->type = \"REP\";\n}\nEncoder_repetition::parameters* Encoder_repetition::parameters\n@@ -30,7 +30,7 @@ void Encoder_repetition::parameters\nauto p = this->get_prefix();\n- tools::add_options(args.at({p+\"-type\"}), 0, \"REPETITION\");\n+ tools::add_options(args.at({p+\"-type\"}), 0, \"REP\");\nargs.add(\n{p+\"-no-buff\"},\n@@ -62,7 +62,7 @@ template <typename B>\nmodule::Encoder_repetition_sys<B>* Encoder_repetition::parameters\n::build() const\n{\n- if (this->type == \"REPETITION\") return new module::Encoder_repetition_sys<B>(this->K, this->N_cw, this->buffered, this->n_frames);\n+ if (this->type == \"REP\") return new module::Encoder_repetition_sys<B>(this->K, this->N_cw, this->buffered, this->n_frames);\nthrow tools::cannot_allocate(__FILE__, __LINE__, __func__);\n}\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Rename the REPETITON encoder in REP encoder like the codec.
|
8,490 |
04.12.2018 13:13:33
| -3,600 |
4956048d0740cbfc2219955a746f5fbf68604a5f
|
Forgot the Encoder_NO factory in the previous commit.
|
[
{
"change_type": "ADD",
"old_path": null,
"new_path": "src/Factory/Module/Encoder/NO/Encoder_NO.cpp",
"diff": "+#include \"Tools/Exception/exception.hpp\"\n+\n+#include \"Module/Encoder/NO/Encoder_NO.hpp\"\n+\n+#include \"Encoder_NO.hpp\"\n+\n+using namespace aff3ct;\n+using namespace aff3ct::factory;\n+\n+const std::string aff3ct::factory::Encoder_NO_name = \"Encoder NO\";\n+const std::string aff3ct::factory::Encoder_NO_prefix = \"enc\";\n+\n+Encoder_NO::parameters\n+::parameters(const std::string &prefix)\n+: Encoder::parameters(Encoder_NO_name, prefix)\n+{\n+ this->type = \"NO\";\n+}\n+\n+Encoder_NO::parameters* Encoder_NO::parameters\n+::clone() const\n+{\n+ return new Encoder_NO::parameters(*this);\n+}\n+\n+void Encoder_NO::parameters\n+::get_description(tools::Argument_map_info &args) const\n+{\n+ auto p = this->get_prefix();\n+\n+ args.add(\n+ {p+\"-info-bits\", \"K\"},\n+ tools::Integer(tools::Positive(), tools::Non_zero()),\n+ \"useful number of bit transmitted (information bits).\",\n+ tools::arg_rank::REQ);\n+\n+ args.add(\n+ {p+\"-fra\", \"F\"},\n+ tools::Integer(tools::Positive(), tools::Non_zero()),\n+ \"set the number of inter frame level to process.\");\n+\n+ args.add(\n+ {p+\"-type\"},\n+ tools::Text(tools::Including_set(\"NO\")),\n+ \"type of the encoder to use in the simulation.\");\n+}\n+\n+void Encoder_NO::parameters\n+::store(const tools::Argument_map_value &vals)\n+{\n+ auto p = this->get_prefix();\n+\n+ if(vals.exist({p+\"-info-bits\", \"K\"})) this->K = vals.to_int({p+\"-info-bits\", \"K\"});\n+ if(vals.exist({p+\"-fra\", \"F\"})) this->n_frames = vals.to_int({p+\"-fra\", \"F\"});\n+ if(vals.exist({p+\"-type\" })) this->type = vals.at ({p+\"-type\" });\n+\n+ this->N_cw = this->K;\n+ this->R = 1.f;\n+}\n+\n+void Encoder_NO::parameters\n+::get_headers(std::map<std::string,header_list>& headers, const bool full) const\n+{\n+ auto p = this->get_prefix();\n+\n+ headers[p].push_back(std::make_pair(\"Type\", this->type));\n+ if (full) headers[p].push_back(std::make_pair(\"Info. bits (K)\", std::to_string(this->K)));\n+ if (full) headers[p].push_back(std::make_pair(\"Code rate (R)\", std::to_string(this->R)));\n+ if (full) headers[p].push_back(std::make_pair(\"Inter frame level\", std::to_string(this->n_frames)));\n+}\n+\n+template <typename B>\n+module::Encoder_NO<B>* Encoder_NO::parameters\n+::build() const\n+{\n+ if (this->type == \"NO\") return new module::Encoder_NO<B>(this->K, this->n_frames);\n+\n+ throw tools::cannot_allocate(__FILE__, __LINE__, __func__);\n+}\n+\n+template <typename B>\n+module::Encoder_NO<B>* Encoder_NO\n+::build(const parameters ¶ms)\n+{\n+ return params.template build<B>();\n+}\n+\n+// ==================================================================================== explicit template instantiation\n+#include \"Tools/types.h\"\n+#ifdef AFF3CT_MULTI_PREC\n+template aff3ct::module::Encoder_NO<B_8 >* aff3ct::factory::Encoder_NO::parameters::build<B_8 >() const;\n+template aff3ct::module::Encoder_NO<B_16>* aff3ct::factory::Encoder_NO::parameters::build<B_16>() const;\n+template aff3ct::module::Encoder_NO<B_32>* aff3ct::factory::Encoder_NO::parameters::build<B_32>() const;\n+template aff3ct::module::Encoder_NO<B_64>* aff3ct::factory::Encoder_NO::parameters::build<B_64>() const;\n+template aff3ct::module::Encoder_NO<B_8 >* aff3ct::factory::Encoder_NO::build<B_8 >(const aff3ct::factory::Encoder_NO::parameters&);\n+template aff3ct::module::Encoder_NO<B_16>* aff3ct::factory::Encoder_NO::build<B_16>(const aff3ct::factory::Encoder_NO::parameters&);\n+template aff3ct::module::Encoder_NO<B_32>* aff3ct::factory::Encoder_NO::build<B_32>(const aff3ct::factory::Encoder_NO::parameters&);\n+template aff3ct::module::Encoder_NO<B_64>* aff3ct::factory::Encoder_NO::build<B_64>(const aff3ct::factory::Encoder_NO::parameters&);\n+#else\n+template aff3ct::module::Encoder_NO<B>* aff3ct::factory::Encoder_NO::parameters::build<B>() const;\n+template aff3ct::module::Encoder_NO<B>* aff3ct::factory::Encoder_NO::build<B>(const aff3ct::factory::Encoder_NO::parameters&);\n+#endif\n+// ==================================================================================== explicit template instantiation\n+\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "src/Factory/Module/Encoder/NO/Encoder_NO.hpp",
"diff": "+#ifndef FACTORY_ENCODER_NO_HPP\n+#define FACTORY_ENCODER_NO_HPP\n+\n+#include <string>\n+\n+#include \"Module/Encoder/NO/Encoder_NO.hpp\"\n+\n+#include \"../Encoder.hpp\"\n+\n+namespace aff3ct\n+{\n+namespace factory\n+{\n+extern const std::string Encoder_NO_name;\n+extern const std::string Encoder_NO_prefix;\n+struct Encoder_NO : public Encoder\n+{\n+ class parameters : public Encoder::parameters\n+ {\n+ public:\n+ // ------------------------------------------------------------------------------------------------- PARAMETERS\n+ // empty\n+\n+ // ---------------------------------------------------------------------------------------------------- METHODS\n+ explicit parameters(const std::string &p = Encoder_NO_prefix);\n+ virtual ~parameters() = default;\n+ Encoder_NO::parameters* clone() const;\n+\n+ // parameters construction\n+ void get_description(tools::Argument_map_info &args) const;\n+ void store (const tools::Argument_map_value &vals);\n+ void get_headers (std::map<std::string,header_list>& headers, const bool full = true) const;\n+\n+ // builder\n+ template <typename B = int>\n+ module::Encoder_NO<B>* build() const;\n+ };\n+\n+ template <typename B = int>\n+ static module::Encoder_NO<B>* build(const parameters ¶ms);\n+};\n+}\n+}\n+\n+#endif /* FACTORY_ENCODER_NO_HPP */\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Forgot the Encoder_NO factory in the previous commit.
|
8,490 |
04.12.2018 13:17:54
| -3,600 |
787891605cbb4f11a54c15bf9f8ef883dc381d7c
|
Doc: rename REPETITION encoder in REP.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/rep/encoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/rep/encoder.rst",
"diff": "@@ -29,7 +29,7 @@ Set the number of infomation bits :math:`K`.\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: text\n- :Allowed values: ``REPETITION`` ``AZCW`` ``COSET`` ``USER``\n+ :Allowed values: ``REP`` ``AZCW`` ``COSET`` ``USER``\n:Examples: ``--enc-type AZCW``\nType of the encoder to use in the simulation.\n@@ -39,7 +39,7 @@ Description of the allowed values:\n+----------------+-----------------------------+\n| Value | Description |\n+================+=============================+\n-| ``REPETITION`` | |enc-type_descr_repetition| |\n+| ``REP`` | |enc-type_descr_repetition| |\n+----------------+-----------------------------+\n| ``AZCW`` | |enc-type_descr_azcw| |\n+----------------+-----------------------------+\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: rename REPETITION encoder in REP.
|
8,490 |
04.12.2018 13:53:40
| -3,600 |
9a4ea9c190569e62e62bf482f3c86b00ecf8479c
|
Rename the '--mdm-ups' parameter in '--mdm-cpm-upf'.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/modem/modem.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/modem/modem.rst",
"diff": "@@ -154,17 +154,6 @@ with an anti-Gray mapping (the lines starting with a ``#`` are ignored):\ngiven constellation. In the previous example, ``--mdm-bps 4`` has be added\nto the command line.\n-.. _mdm-mdm-ups:\n-\n-``--mdm-ups``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: integer\n- :Default: 1\n- :Examples: ``--mdm-ups 1``\n-\n-Select the symbol upsampling factor (only relevant for the |CPM| |modem|).\n-\n.. _mdm-mdm-max:\n``--mdm-max``\n@@ -251,6 +240,17 @@ Set the |CPM| *index denominator*.\nSet the |CPM| *pulse width* (also called *memory depth*).\n+.. _mdm-mdm-cpm-upf:\n+\n+``--mdm-cpm-upf``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: integer\n+ :Default: 1\n+ :Examples: ``--mdm-cpm-upf 1``\n+\n+Select the symbol upsampling factor in the |CPM|.\n+\n.. _mdm-mdm-cpm-map:\n``--mdm-cpm-map``\n@@ -325,7 +325,7 @@ Description of the allowed values:\n| Value | Parameter | Value | Description |\n+=========+==========================+===============+=================================+\n| ``GSM`` | | :ref:`mdm-mdm-bps` | | 1 | | Bit per symbol. |\n-| | | :ref:`mdm-mdm-ups` | | 5 | | Upsampling factor. |\n+| | | :ref:`mdm-mdm-cpm-upf` | | 5 | | Upsampling factor. |\n| | | :ref:`mdm-mdm-cpm-k` | | 1 | | Modulation index numerator. |\n| | | :ref:`mdm-mdm-cpm-p` | | 2 | | Modulation index denominator. |\n| | | :ref:`mdm-mdm-cpm-L` | | 3 | | Memory depth. |\n"
},
{
"change_type": "MODIFY",
"old_path": "refs",
"new_path": "refs",
"diff": "-Subproject commit 7d8e2d724ca346c0f4ff07143b739a1a8b444c24\n+Subproject commit c1ea943cd2820f4ce42ff80e52c7af682c49382f\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Modem/Modem.cpp",
"new_path": "src/Factory/Module/Modem/Modem.cpp",
"diff": "@@ -66,11 +66,6 @@ void Modem::parameters\ntools::Integer(tools::Positive(), tools::Non_zero()),\n\"select the number of bits per symbol (default is 1).\");\n- args.add(\n- {p+\"-ups\"},\n- tools::Integer(tools::Positive(), tools::Non_zero()),\n- \"select the symbol sampling factor (default is 1).\");\n-\nargs.add(\n{p+\"-const-path\"},\ntools::File(tools::openmode::read_write),\n@@ -97,6 +92,11 @@ void Modem::parameters\ntools::Integer(tools::Positive(), tools::Non_zero()),\n\"modulation index denominator (default is 2).\");\n+ args.add(\n+ {p+\"-cpm-upf\"},\n+ tools::Integer(tools::Positive(), tools::Non_zero()),\n+ \"select the symbol sampling factor (default is 1).\");\n+\nargs.add(\n{p+\"-cpm-map\"},\ntools::Text(tools::Including_set(\"NATURAL\", \"GRAY\")),\n@@ -155,9 +155,9 @@ void Modem::parameters\nthis->cpm_k = 1;\nthis->cpm_p = 2;\nthis->bps = 1;\n- this->upf = 5;\n- this->mapping = \"NATURAL\";\n- this->wave_shape = \"GMSK\";\n+ this->cpm_upf = 5;\n+ this->cpm_mapping = \"NATURAL\";\n+ this->cpm_wave_shape = \"GMSK\";\n}\nelse\n{\n@@ -171,13 +171,13 @@ void Modem::parameters\nif(vals.exist({p+\"-fra-size\", \"N\"})) this->N = vals.to_int({p+\"-fra-size\", \"N\"});\nif(vals.exist({p+\"-fra\", \"F\"})) this->n_frames = vals.to_int({p+\"-fra\", \"F\"});\nif(vals.exist({p+\"-bps\" })) this->bps = vals.to_int({p+\"-bps\" });\n- if(vals.exist({p+\"-ups\" })) this->upf = vals.to_int({p+\"-ups\" });\nif(vals.exist({p+\"-const-path\" })) this->const_path = vals.at ({p+\"-const-path\" });\nif(vals.exist({p+\"-cpm-L\" })) this->cpm_L = vals.to_int({p+\"-cpm-L\" });\nif(vals.exist({p+\"-cpm-p\" })) this->cpm_p = vals.to_int({p+\"-cpm-p\" });\nif(vals.exist({p+\"-cpm-k\" })) this->cpm_k = vals.to_int({p+\"-cpm-k\" });\n- if(vals.exist({p+\"-cpm-map\" })) this->mapping = vals.at ({p+\"-cpm-map\" });\n- if(vals.exist({p+\"-cpm-ws\" })) this->wave_shape = vals.at ({p+\"-cpm-ws\" });\n+ if(vals.exist({p+\"-cpm-upf\" })) this->cpm_upf = vals.to_int({p+\"-cpm-upf\" });\n+ if(vals.exist({p+\"-cpm-map\" })) this->cpm_mapping = vals.at ({p+\"-cpm-map\" });\n+ if(vals.exist({p+\"-cpm-ws\" })) this->cpm_wave_shape = vals.at ({p+\"-cpm-ws\" });\n// force the number of bits per symbol to 1 when BPSK mod\nif (this->type == \"BPSK\" || this->type == \"OOK\")\n@@ -191,7 +191,7 @@ void Modem::parameters\nthis->N_mod = get_buffer_size_after_modulation(this->type,\nthis->N,\nthis->bps,\n- this->upf,\n+ this->cpm_upf,\nthis->cpm_L,\nthis->cpm_p);\n@@ -227,12 +227,12 @@ void Modem::parameters\nheaders[p].push_back(std::make_pair(\"CPM L memory\", std::to_string(this->cpm_L)));\nheaders[p].push_back(std::make_pair(\"CPM h index\", (std::to_string(this->cpm_k) + std::string(\"/\") +\nstd::to_string(this->cpm_p))));\n- headers[p].push_back(std::make_pair(\"CPM wave shape\", this->wave_shape));\n- headers[p].push_back(std::make_pair(\"CPM mapping\", this->mapping));\n+ headers[p].push_back(std::make_pair(\"CPM wave shape\", this->cpm_wave_shape));\n+ headers[p].push_back(std::make_pair(\"CPM mapping\", this->cpm_mapping));\n+ headers[p].push_back(std::make_pair(\"CPM sampling factor\", std::to_string(this->cpm_upf)));\n}\nheaders[p].push_back(std::make_pair(\"Bits per symbol\", std::to_string(this->bps)));\n- headers[p].push_back(std::make_pair(\"Sampling factor\", std::to_string(this->upf)));\n// --------------------------------------------------------------------------------------------------- demodulator\nstd::string demod_sig2 = (this->no_sig2) ? \"off\" : \"on\";\n@@ -267,7 +267,7 @@ module::Modem<B,R,Q>* Modem::parameters\nif (this->type == \"QAM\" && this->implem == \"STD\" ) return new module::Modem_QAM <B,R,Q,MAX>(this->N, tools::Sigma<R>((R)this->noise), this->bps, this->no_sig2, this->n_frames);\nif (this->type == \"PSK\" && this->implem == \"STD\" ) return new module::Modem_PSK <B,R,Q,MAX>(this->N, tools::Sigma<R>((R)this->noise), this->bps, this->no_sig2, this->n_frames);\nif (this->type == \"USER\" && this->implem == \"STD\" ) return new module::Modem_user <B,R,Q,MAX>(this->N, this->const_path, tools::Sigma<R>((R)this->noise), this->bps, this->no_sig2, this->n_frames);\n- if (this->type == \"CPM\" && this->implem == \"STD\" ) return new module::Modem_CPM <B,R,Q,MAX>(this->N, tools::Sigma<R>((R)this->noise), this->bps, this->upf, this->cpm_L, this->cpm_k, this->cpm_p, this->mapping, this->wave_shape, this->no_sig2, this->n_frames);\n+ if (this->type == \"CPM\" && this->implem == \"STD\" ) return new module::Modem_CPM <B,R,Q,MAX>(this->N, tools::Sigma<R>((R)this->noise), this->bps, this->cpm_upf, this->cpm_L, this->cpm_k, this->cpm_p, this->cpm_mapping, this->cpm_wave_shape, this->no_sig2, this->n_frames);\nthrow tools::cannot_allocate(__FILE__, __LINE__, __func__);\n}\n@@ -337,7 +337,7 @@ int Modem\n::get_buffer_size_after_modulation(const std::string &type,\nconst int N,\nconst int bps,\n- const int upf,\n+ const int cpm_upf,\nconst int cpm_L,\nconst int cpm_p)\n{\n@@ -348,7 +348,7 @@ int Modem\nif (type == \"QAM\" ) return module::Modem_QAM <>::size_mod(N, bps );\nif (type == \"PSK\" ) return module::Modem_PSK <>::size_mod(N, bps );\nif (type == \"USER\") return module::Modem_user <>::size_mod(N, bps );\n- if (type == \"CPM\" ) return module::Modem_CPM <>::size_mod(N, bps, cpm_L, cpm_p, upf);\n+ if (type == \"CPM\" ) return module::Modem_CPM <>::size_mod(N, bps, cpm_L, cpm_p, cpm_upf);\nthrow tools::cannot_allocate(__FILE__, __LINE__, __func__);\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Modem/Modem.hpp",
"new_path": "src/Factory/Module/Modem/Modem.hpp",
"diff": "@@ -33,15 +33,15 @@ struct Modem : public Factory\nstd::string const_path = \"\"; // PATH to constellation file (CSV file)\nbool complex = true; // true if the modulated signal is complex\nint bps = 1; // bits per symbol\n- int upf = 1; // samples per symbol\n// -------- CPM parameters\nstd::string cpm_std = \"\"; // the selection of a default cpm standard hardly implemented (GSM)\n- std::string mapping = \"NATURAL\"; // symbol mapping layout (natural, gray)\n- std::string wave_shape = \"GMSK\"; // wave shape (gmsk, rcos, rec)\n+ std::string cpm_mapping = \"NATURAL\"; // symbol mapping layout (natural, gray)\n+ std::string cpm_wave_shape = \"GMSK\"; // wave shape (gmsk, rcos, rec)\nint cpm_L = 2; // cpm pulse width or cpm memory\nint cpm_k = 1; // modulation index numerator\nint cpm_p = 2; // modulation index denumerator\n+ int cpm_upf = 1; // samples per symbol\nint N_mod = 0; // frame size at the output of the modulator\n// ------- demodulator parameters\n@@ -93,7 +93,7 @@ struct Modem : public Factory\nstatic int get_buffer_size_after_modulation(const std::string &type,\nconst int N,\nconst int bps = 1,\n- const int upf = 5,\n+ const int cpm_upf = 5,\nconst int cpm_L = 3,\nconst int cpm_p = 2);\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Simulation/BFER/BFER.cpp",
"new_path": "src/Simulation/BFER/BFER.cpp",
"diff": "@@ -99,7 +99,7 @@ void BFER<B,R,Q>\nfor (auto noise_idx = noise_begin; noise_idx != noise_end; noise_idx += noise_step)\n{\nthis->noise.reset(params_BFER.noise->template build<R>(params_BFER.noise->range[noise_idx], bit_rate,\n- params_BFER.mdm->bps, params_BFER.mdm->upf));\n+ params_BFER.mdm->bps, params_BFER.mdm->cpm_upf));\n// manage noise distributions to be sure it exists\nif (this->distributions != nullptr)\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Simulation/EXIT/EXIT.cpp",
"new_path": "src/Simulation/EXIT/EXIT.cpp",
"diff": "@@ -64,7 +64,7 @@ void EXIT<B,R>\nconst auto K_mod = factory::Modem::get_buffer_size_after_modulation(params_EXIT.mdm->type,\nparams_EXIT.cdc->K,\nparams_EXIT.mdm->bps,\n- params_EXIT.mdm->upf,\n+ params_EXIT.mdm->cpm_upf,\nparams_EXIT.mdm->cpm_L);\n// build the objects\n@@ -110,7 +110,7 @@ void EXIT<B,R>\n// For EXIT simulation, NOISE is considered as Es/N0\nconst R bit_rate = 1.;\nR esn0 = tools::ebn0_to_esn0 (ebn0, bit_rate, params_EXIT.mdm->bps);\n- R sigma = tools::esn0_to_sigma(esn0, params_EXIT.mdm->upf);\n+ R sigma = tools::esn0_to_sigma(esn0, params_EXIT.mdm->cpm_upf);\nthis->noise.set_noise(sigma, ebn0, esn0);\n@@ -145,7 +145,7 @@ void EXIT<B,R>\n{\nconst R bit_rate = 1.;\nauto sig_a_2 = (R)2. / sig_a;\n- R sig_a_esn0 = tools::sigma_to_esn0(sig_a_2, params_EXIT.mdm->upf);\n+ R sig_a_esn0 = tools::sigma_to_esn0(sig_a_2, params_EXIT.mdm->cpm_upf);\nR sig_a_ebn0 = tools::esn0_to_ebn0 (sig_a_esn0, bit_rate, params_EXIT.mdm->bps);\nthis->noise_a.set_noise(sig_a_2, sig_a_ebn0, sig_a_esn0);\n@@ -380,7 +380,7 @@ std::unique_ptr<module::Channel<R>> EXIT<B,R>\nchn_params->N = factory::Modem::get_buffer_size_after_modulation(params_EXIT.mdm->type,\nparams_EXIT.cdc->K,\nparams_EXIT.mdm->bps,\n- params_EXIT.mdm->upf,\n+ params_EXIT.mdm->cpm_upf,\nparams_EXIT.mdm->cpm_L);\nreturn std::unique_ptr<module::Channel<R>>(chn_params->template build<R>());\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Rename the '--mdm-ups' parameter in '--mdm-cpm-upf'.
|
8,490 |
04.12.2018 14:03:36
| -3,600 |
024fad0e46e33c6d2526664bb7e0cb1235ee081a
|
Doc: disable the Doxygen compilation for now.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/conf.py",
"new_path": "doc/sphinx/source/conf.py",
"diff": "@@ -81,15 +81,16 @@ pygments_style = None\n# -- Configure Breathe (Developer doc from Doxygen XML files) ----------------\n-# Are we on a Readthedocs server ?\n-read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'\n-# If we are on a Readthedocs server\n-if read_the_docs_build:\n- # Generate the Doxygen XML files\n- subprocess.call('cd ../../doxygen; doxygen config.txt', shell=True)\n-\n-breathe_projects = { \"AFF3CT\": \"../../doxygen/xml/\" }\n-breathe_default_project = \"AFF3CT\"\n+# # Uncomment the following lines to enable the Doxygen compilation\n+# # Are we on a Readthedocs server ?\n+# read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'\n+# # If we are on a Readthedocs server\n+# if read_the_docs_build:\n+# # Generate the Doxygen XML files\n+# subprocess.call('cd ../../doxygen; doxygen config.txt', shell=True)\n+#\n+# breathe_projects = { \"AFF3CT\": \"../../doxygen/xml/\" }\n+# breathe_default_project = \"AFF3CT\"\n# -- Options for HTML output -------------------------------------------------\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: disable the Doxygen compilation for now.
|
8,490 |
04.12.2018 14:04:58
| -3,600 |
66aa90691df94de1f532d7d4c6c97c539317ca9d
|
Rename the '--enc-save-g' parameter in '--enc-g-save-path'.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/encoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/encoder.rst",
"diff": "@@ -146,14 +146,14 @@ Description of the allowed values:\n``LU_DEC`` method is faster than ``IDENTITY``.\n-.. _enc-ldpc-enc-save-g:\n+.. _enc-ldpc-enc-g-save-path:\n-``--enc-save-g``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+``--enc-g-save-path``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: file\n:Rights: write only\n- :Examples: ``--enc-save-g example/path/to/the/generated/G_matrix.alist``\n+ :Examples: ``--enc-g-save-path example/path/to/the/generated/G_matrix.alist``\nSet the file path where the :math:`G` generator matrix will be saved (AList\nfile format). To use with the ``LDPC_H`` encoder.\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Encoder/LDPC/Encoder_LDPC.cpp",
"new_path": "src/Factory/Module/Encoder/LDPC/Encoder_LDPC.cpp",
"diff": "@@ -67,7 +67,7 @@ void Encoder_LDPC::parameters\n\"matrices) when the 'IDENTITY' method generate an identity on H to get the parity part.\");\nargs.add(\n- {p+\"-save-g\"},\n+ {p+\"-g-save-path\"},\ntools::File(tools::openmode::write),\n\"path where the generated G matrix with the 'LDPC_H' encoder type will be saved.\");\n}\n@@ -81,7 +81,7 @@ void Encoder_LDPC::parameters\nif(vals.exist({p+\"-g-path\" })) this->G_path = vals.at({p+\"-g-path\" });\nif(vals.exist({p+\"-h-reorder\" })) this->H_reorder = vals.at({p+\"-h-reorder\" });\nif(vals.exist({p+\"-g-method\" })) this->G_method = vals.at({p+\"-g-method\" });\n- if(vals.exist({p+\"-save-g\" })) this->G_save = vals.at({p+\"-save-g\" });\n+ if(vals.exist({p+\"-g-save-path\"})) this->G_save_path = vals.at({p+\"-g-save-path\"});\nif (!this->G_path.empty())\n{\n@@ -123,8 +123,8 @@ void Encoder_LDPC::parameters\nif (this->type == \"LDPC_H\")\n{\nheaders[p].push_back(std::make_pair(\"G build method\", this->G_method));\n- if (this->G_save != \"\")\n- headers[p].push_back(std::make_pair(\"G save path\", this->G_save));\n+ if (this->G_save_path != \"\")\n+ headers[p].push_back(std::make_pair(\"G save path\", this->G_save_path));\n}\n}\n@@ -133,7 +133,7 @@ module::Encoder_LDPC<B>* Encoder_LDPC::parameters\n::build(const tools::Sparse_matrix &G, const tools::Sparse_matrix &H) const\n{\nif (this->type == \"LDPC\" ) return new module::Encoder_LDPC <B>(this->K, this->N_cw, G, this->n_frames);\n- if (this->type == \"LDPC_H\" ) return new module::Encoder_LDPC_from_H <B>(this->K, this->N_cw, H, this->G_method, this->G_save, this->n_frames);\n+ if (this->type == \"LDPC_H\" ) return new module::Encoder_LDPC_from_H <B>(this->K, this->N_cw, H, this->G_method, this->G_save_path, this->n_frames);\nif (this->type == \"LDPC_QC\" ) return new module::Encoder_LDPC_from_QC <B>(this->K, this->N_cw, H, this->n_frames);\nif (this->type == \"LDPC_IRA\") return new module::Encoder_LDPC_from_IRA<B>(this->K, this->N_cw, H, this->n_frames);\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Encoder/LDPC/Encoder_LDPC.hpp",
"new_path": "src/Factory/Module/Encoder/LDPC/Encoder_LDPC.hpp",
"diff": "@@ -31,7 +31,7 @@ struct Encoder_LDPC : public Encoder\n// G generator method\nstd::string G_method = \"IDENTITY\";\n- std::string G_save = \"\";\n+ std::string G_save_path = \"\";\n// ---------------------------------------------------------------------------------------------------- METHODS\nexplicit parameters(const std::string &p = Encoder_LDPC_prefix);\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Rename the '--enc-save-g' parameter in '--enc-g-save-path'.
|
8,490 |
04.12.2018 15:31:18
| -3,600 |
3623b3b5e1691cd098cd9bd8d2679be8597a96a8
|
Rename the '--dec-fnc-crc-ite' in '--dec-crc-start' (Turbo).
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo/decoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo/decoder.rst",
"diff": "@@ -77,6 +77,20 @@ Please refer to the |RSC| :ref:`dec-rsc-dec-implem` parameter.\nPlease refer to the |RSC| :ref:`dec-rsc-dec-simd` parameter.\n+.. _dec-turbo-dec-crc-start:\n+\n+``--dec-crc-start``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: integer\n+ :Default: ``2``\n+ :Examples: ``--dec-fnc-crc-ite 1``\n+\n+Set the first iteration to start the |CRC| checking.\n+\n+.. note:: This parameter requires the Turbo code to be concatenated with a |CRC|\n+ to work, see the :ref:`crc-crc-parameters`.\n+\n.. _dec-turbo-dec-fnc:\n``--dec-fnc``\n@@ -87,15 +101,17 @@ Enable the |FNC| post processing technique from :cite:`Tonnellier2016b`.\n.. note:: This parameter requires the Turbo code to be concatenated with a |CRC|\nto work, see the :ref:`crc-crc-parameters`.\n-.. _dec-turbo-dec-fnc-crc-ite:\n+.. _dec-turbo-dec-fnc-ite-min:\n-``--dec-fnc-crc-ite``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+``--dec-fnc-ite-m``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-fnc-crc-ite 1``\n+ :Default: ``3``\n+ :Examples: ``--dec-fnc-ite-m 2``\n-Set the first iteration to start the |CRC| checking.\n+Set the first iteration at which the |FNC| is used (c.f the\n+:ref:`dec-turbo-dec-fnc` parameter).\n.. _dec-turbo-dec-fnc-ite-max:\n@@ -103,29 +119,20 @@ Set the first iteration to start the |CRC| checking.\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-fnc-ite-M 1``\n+ :Default: ``10``\n+ :Examples: ``--dec-fnc-ite-M 6``\nSet the last iteration at which the |FNC| is used (c.f the\n:ref:`dec-turbo-dec-fnc` parameter).\n-.. _dec-turbo-dec-fnc-ite-min:\n-\n-``--dec-fnc-ite-m``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: integer\n- :Examples: ``--dec-fnc-ite-m 1``\n-\n-Set the first iteration at which the |FNC| is used (c.f the\n-:ref:`dec-turbo-dec-fnc` parameter).\n-\n.. _dec-turbo-dec-fnc-ite-s:\n``--dec-fnc-ite-s``\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-fnc-ite-s 1``\n+ :Default: ``1``\n+ :Examples: ``--dec-fnc-ite-s 2``\nSet the iteration step for the |FNC| technique (c.f the\n:ref:`dec-turbo-dec-fnc` parameter).\n@@ -136,7 +143,8 @@ Set the iteration step for the |FNC| technique (c.f the\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-fnc-q 1``\n+ :Default: ``10``\n+ :Examples: ``--dec-fnc-q 6``\nSet the search space for the |FNC| technique (c.f the\n:ref:`dec-turbo-dec-fnc` parameter).\n@@ -147,7 +155,8 @@ Set the search space for the |FNC| technique (c.f the\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-ite 1``\n+ :Default: ``6``\n+ :Examples: ``--dec-ite 8``\nSet the maximal number of iterations in the Turbo decoder. If the Turbo code\nis concatenated with a |CRC| and if the |CRC| is checked, the decoder can stop\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo_db/decoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo_db/decoder.rst",
"diff": "@@ -69,6 +69,20 @@ Please refer to the |RSC| |DB| :ref:`dec-rsc_db-dec-type` parameter.\nPlease refer to the |RSC| |DB| :ref:`dec-rsc_db-dec-implem` parameter.\n+.. _dec-turbo_db-dec-crc-start:\n+\n+``--dec-crc-start``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: integer\n+ :Default: ``2``\n+ :Examples: ``--dec-fnc-crc-ite 1``\n+\n+Set the first iteration to start the |CRC| checking.\n+\n+.. note:: This parameter requires the Turbo code to be concatenated with a |CRC|\n+ to work, see the :ref:`crc-crc-parameters`.\n+\n.. _dec-turbo_db-dec-fnc:\n``--dec-fnc``\n@@ -79,15 +93,17 @@ Enable the |FNC| post processing technique from :cite:`Tonnellier2016a`.\n.. note:: This parameter requires the Turbo code to be concatenated with a |CRC|\nto work, see the :ref:`crc-crc-parameters`.\n-.. _dec-turbo_db-dec-fnc-crc-ite:\n+.. _dec-turbo_db-dec-fnc-ite-min:\n-``--dec-fnc-crc-ite``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+``--dec-fnc-ite-m``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-fnc-crc-ite 1``\n+ :Default: ``3``\n+ :Examples: ``--dec-fnc-ite-m 2``\n-Set the first iteration to start the |CRC| checking.\n+Set the first iteration at which the |FNC| is used (c.f the\n+:ref:`dec-turbo_db-dec-fnc` parameter).\n.. _dec-turbo_db-dec-fnc-ite-max:\n@@ -95,29 +111,20 @@ Set the first iteration to start the |CRC| checking.\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-fnc-ite-M 1``\n+ :Default: ``10``\n+ :Examples: ``--dec-fnc-ite-M 6``\nSet the last iteration at which the |FNC| is used (c.f the\n:ref:`dec-turbo_db-dec-fnc` parameter).\n-.. _dec-turbo_db-dec-fnc-ite-min:\n-\n-``--dec-fnc-ite-m``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n- :Type: integer\n- :Examples: ``--dec-fnc-ite-m 1``\n-\n-Set the first iteration at which the |FNC| is used (c.f the\n-:ref:`dec-turbo_db-dec-fnc` parameter).\n-\n.. _dec-turbo_db-dec-fnc-ite-s:\n``--dec-fnc-ite-s``\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-fnc-ite-s 1``\n+ :Default: ``1``\n+ :Examples: ``--dec-fnc-ite-s 2``\nSet the iteration step for the |FNC| technique (c.f the\n:ref:`dec-turbo_db-dec-fnc` parameter).\n@@ -128,7 +135,8 @@ Set the iteration step for the |FNC| technique (c.f the\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-fnc-q 1``\n+ :Default: ``10``\n+ :Examples: ``--dec-fnc-q 6``\nSet the search space for the |FNC| technique (c.f the\n:ref:`dec-turbo_db-dec-fnc` parameter).\n@@ -139,7 +147,8 @@ Set the search space for the |FNC| technique (c.f the\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: integer\n- :Examples: ``--dec-ite 1``\n+ :Default: ``6``\n+ :Examples: ``--dec-ite 8``\nSet the maximal number of iterations in the Turbo decoder. If the Turbo code\nis concatenated with a |CRC| and if the |CRC| is checked, the decoder can stop\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Decoder/Turbo/Decoder_turbo.hpp",
"new_path": "src/Factory/Module/Decoder/Turbo/Decoder_turbo.hpp",
"diff": "@@ -35,6 +35,7 @@ struct Decoder_turbo : public Decoder\nbool self_corrected = false;\nbool enable_json = false;\nint n_ite = 6;\n+ int crc_start_ite = 2;\n// depending parameters\ntools::auto_cloned_unique_ptr<typename D1 ::parameters> sub1;\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Decoder/Turbo/Decoder_turbo.hxx",
"new_path": "src/Factory/Module/Decoder/Turbo/Decoder_turbo.hxx",
"diff": "@@ -107,6 +107,10 @@ void Decoder_turbo::parameters<D1,D2>\ntools::None(),\n\"enable the json output trace.\");\n+ args.add(\n+ {p+\"-crc-start\"},\n+ tools::Integer(tools::Positive(), tools::Non_zero()),\n+ \"set the iteration to start the CRC checking.\");\nsf->get_description(args);\n@@ -121,6 +125,7 @@ void Decoder_turbo::parameters<D1,D2>\nargs.erase({pfnc+\"-size\" });\nargs.erase({pfnc+\"-fra\", \"F\"});\nargs.erase({pfnc+\"-ite\", \"i\"});\n+ args.erase({pfnc+\"-crc-ite\" });\nsub1->get_description(args);\n@@ -151,6 +156,7 @@ void Decoder_turbo::parameters<D1,D2>\nif(vals.exist({p+\"-ite\", \"i\" })) this->n_ite = vals.to_int({p+\"-ite\", \"i\"});\nif(vals.exist({p+\"-sc\" })) this->self_corrected = true;\nif(vals.exist({p+\"-json\" })) this->enable_json = true;\n+ if(vals.exist({p+\"-crc-start\"})) this->crc_start_ite = vals.to_int({p+\"-crc-start\"});\nthis->sub1->K = this->K;\nthis->sub2->K = this->K;\n@@ -193,6 +199,7 @@ void Decoder_turbo::parameters<D1,D2>\nthis->fnc->size = this->K;\nthis->fnc->n_frames = this->n_frames;\nthis->fnc->n_ite = this->n_ite;\n+ this->fnc->crc_start_ite = this->crc_start_ite;\nfnc->store(vals);\n}\n@@ -211,6 +218,7 @@ void Decoder_turbo::parameters<D1,D2>\nauto p = this->get_prefix();\nheaders[p].push_back(std::make_pair(\"Num. of iterations (i)\", std::to_string(this->n_ite)));\n+ headers[p].push_back(std::make_pair(\"CRC start iteration\", std::to_string(this->crc_start_ite)));\nif (this->tail_length && full)\nheaders[p].push_back(std::make_pair(\"Tail length\", std::to_string(this->tail_length)));\nheaders[p].push_back(std::make_pair(\"Enable json\", ((this->enable_json) ? \"on\" : \"off\")));\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Decoder/Turbo_DB/Decoder_turbo_DB.cpp",
"new_path": "src/Factory/Module/Decoder/Turbo_DB/Decoder_turbo_DB.cpp",
"diff": "@@ -88,6 +88,11 @@ void Decoder_turbo_DB::parameters\ntools::Integer(tools::Positive(), tools::Non_zero()),\n\"maximal number of iterations in the turbo.\");\n+ args.add(\n+ {p+\"-crc-start\"},\n+ tools::Integer(tools::Positive(), tools::Non_zero()),\n+ \"set the iteration to start the CRC checking.\");\n+\nsf->get_description(args);\nauto psf = sf->get_prefix();\n@@ -101,6 +106,7 @@ void Decoder_turbo_DB::parameters\nargs.erase({pfnc+\"-size\" });\nargs.erase({pfnc+\"-fra\", \"F\"});\nargs.erase({pfnc+\"-ite\", \"i\"});\n+ args.erase({pfnc+\"-crc-ite\" });\nsub->get_description(args);\n@@ -119,6 +125,7 @@ void Decoder_turbo_DB::parameters\nauto p = this->get_prefix();\nif(vals.exist({p+\"-ite\", \"i\"})) this->n_ite = vals.to_int({p+\"-ite\", \"i\"});\n+ if(vals.exist({p+\"-crc-start\"})) this->crc_start_ite = vals.to_int({p+\"-crc-start\"});\nthis->sub->K = this->K;\nthis->sub->n_frames = this->n_frames;\n@@ -149,6 +156,7 @@ void Decoder_turbo_DB::parameters\nthis->fnc->size = this->K;\nthis->fnc->n_frames = this->n_frames;\nthis->fnc->n_ite = this->n_ite;\n+ this->fnc->crc_start_ite = this->crc_start_ite;\nfnc->store(vals);\n}\n@@ -166,6 +174,7 @@ void Decoder_turbo_DB::parameters\nitl->get_headers(headers, full);\nheaders[p].push_back(std::make_pair(\"Num. of iterations (i)\", std::to_string(this->n_ite)));\n+ headers[p].push_back(std::make_pair(\"CRC start iteration\", std::to_string(this->crc_start_ite)));\nif (this->tail_length && full)\nheaders[p].push_back(std::make_pair(\"Tail length\", std::to_string(this->tail_length)));\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Decoder/Turbo_DB/Decoder_turbo_DB.hpp",
"new_path": "src/Factory/Module/Decoder/Turbo_DB/Decoder_turbo_DB.hpp",
"diff": "@@ -32,6 +32,7 @@ struct Decoder_turbo_DB : public Decoder\n// ------------------------------------------------------------------------------------------------- PARAMETERS\n// optional parameters\nint n_ite = 6;\n+ int crc_start_ite = 2;\n// depending parameters\ntools::auto_cloned_unique_ptr<Decoder_RSC_DB ::parameters> sub;\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Tools/Code/Turbo/Flip_and_check.cpp",
"new_path": "src/Factory/Tools/Code/Turbo/Flip_and_check.cpp",
"diff": "@@ -73,7 +73,7 @@ void Flip_and_check::parameters\n\"maximal number of iterations in the turbo.\");\nargs.add(\n- {p+\"-crc-ite\"},\n+ {p+\"-crc-start\"},\ntools::Integer(tools::Positive()),\n\"set the iteration to start the CRC checking.\");\n}\n@@ -86,7 +86,7 @@ void Flip_and_check::parameters\nif(vals.exist({p })) this->enable = true;\nif(vals.exist({p+\"-size\" })) this->size = vals.to_int({p+\"-size\" });\nif(vals.exist({p+\"-q\" })) this->q = vals.to_int({p+\"-q\" });\n- if(vals.exist({p+\"-crc-ite\" })) this->start_crc_check_ite = vals.to_int({p+\"-crc-ite\" });\n+ if(vals.exist({p+\"-crc-start\"})) this->crc_start_ite = vals.to_int({p+\"-crc-ite\" });\nif(vals.exist({p+\"-fra\", \"F\"})) this->n_frames = vals.to_int({p+\"-fra\", \"F\" });\nif(vals.exist({p+\"-ite-s\" })) this->ite_step = vals.to_int({p+\"-ite-s\" });\nif(vals.exist({p+\"-ite\", \"i\"})) this->n_ite = vals.to_int({p+\"-ite\", \"i\"});\n@@ -117,7 +117,7 @@ tools::Flip_and_check<B,Q>* Flip_and_check::parameters\nif (!this->enable)\nthrow tools::cannot_allocate(__FILE__, __LINE__, __func__);\n- return new tools::Flip_and_check<B,Q>(this->size, this->n_ite, crc, this->start_crc_check_ite, this->q, this->ite_min, this->ite_max, this->ite_step, this->n_frames);\n+ return new tools::Flip_and_check<B,Q>(this->size, this->n_ite, crc, this->crc_start_ite, this->q, this->ite_min, this->ite_max, this->ite_step, this->n_frames);\n}\ntemplate<typename B, typename Q>\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Tools/Code/Turbo/Flip_and_check.hpp",
"new_path": "src/Factory/Tools/Code/Turbo/Flip_and_check.hpp",
"diff": "@@ -29,7 +29,7 @@ struct Flip_and_check : public Factory\nint ite_min = 3;\nint ite_max = 10;\nint ite_step = 1;\n- int start_crc_check_ite = 2;\n+ int crc_start_ite = 2;\nint n_frames = 1;\n// ---------------------------------------------------------------------------------------------------- METHODS\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Tools/Code/Turbo/Flip_and_check_DB.cpp",
"new_path": "src/Factory/Tools/Code/Turbo/Flip_and_check_DB.cpp",
"diff": "@@ -45,7 +45,7 @@ tools::Flip_and_check_DB<B,Q>* Flip_and_check_DB::parameters\nif (!this->enable)\nthrow tools::cannot_allocate(__FILE__, __LINE__, __func__);\n- return new tools::Flip_and_check_DB<B,Q>(this->size, this->n_ite, crc, this->start_crc_check_ite, this->q, this->ite_min, this->ite_max, this->ite_step, this->n_frames);\n+ return new tools::Flip_and_check_DB<B,Q>(this->size, this->n_ite, crc, this->crc_start_ite, this->q, this->ite_min, this->ite_max, this->ite_step, this->n_frames);\n}\ntemplate<typename B, typename Q>\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Rename the '--dec-fnc-crc-ite' in '--dec-crc-start' (Turbo).
|
8,490 |
04.12.2018 15:32:03
| -3,600 |
bd7fb9907b345f8a5c4a43aae37c092f09e147b8
|
Enable the '--dec-crc-start' parameter for Turbo + CRC without FNC.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Module/Codec/Turbo/Codec_turbo.cpp",
"new_path": "src/Module/Codec/Turbo/Codec_turbo.cpp",
"diff": "@@ -131,7 +131,9 @@ Codec_turbo<B,Q>\nadd_post_pro(factory::Flip_and_check::build<B,Q>(*dec_params.fnc, *crc));\n}\nelse if (crc != nullptr && crc->get_size() > 0)\n- add_post_pro(new tools::CRC_checker<B,Q>(*crc, 2, decoder_turbo->get_simd_inter_frame_level()));\n+ add_post_pro(new tools::CRC_checker<B,Q>(*crc,\n+ dec_params.crc_start_ite,\n+ decoder_turbo->get_simd_inter_frame_level()));\nif (dec_params.self_corrected)\nadd_post_pro(new tools::Self_corrected<B,Q>(dec_params.K,\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Module/Codec/Turbo_DB/Codec_turbo_DB.cpp",
"new_path": "src/Module/Codec/Turbo_DB/Codec_turbo_DB.cpp",
"diff": "@@ -127,7 +127,9 @@ Codec_turbo_DB<B,Q>\nadd_post_pro(factory::Flip_and_check_DB::build<B,Q>(*dec_params.fnc, *crc));\n}\nelse if (crc != nullptr && crc->get_size() > 0)\n- add_post_pro(new tools::CRC_checker_DB<B,Q>(*crc, 2, decoder_turbo->get_simd_inter_frame_level()));\n+ add_post_pro(new tools::CRC_checker_DB<B,Q>(*crc,\n+ dec_params.crc_start_ite,\n+ decoder_turbo->get_simd_inter_frame_level()));\nfor (auto i = 0; i < (int)post_pros.size(); i++)\n{\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Enable the '--dec-crc-start' parameter for Turbo + CRC without FNC.
|
8,490 |
04.12.2018 16:02:46
| -3,600 |
b10c7498118b4a7655edfe5deac8d05120353b3a
|
Add the compilation options in when using the '-v' parameter.
|
[
{
"change_type": "MODIFY",
"old_path": "src/main.cpp",
"new_path": "src/main.cpp",
"diff": "@@ -71,8 +71,73 @@ void print_version()\n#endif\nstd::string affect_version = version() == \"GIT-NOTFOUND\" ? \"\" : version();\n+#if defined(AFF3CT_MULTI_PREC)\n+ std::string precision = \"8/16/32/64-bit\";\n+#elif defined(AFF3CT_8BIT_PREC)\n+ std::string precision = \"8-bit\";\n+#elif defined(AFF3CT_16BIT_PREC)\n+ std::string precision = \"16-bit\";\n+#elif defined(AFF3CT_32BIT_PREC)\n+ std::string precision = \"32-bit\";\n+#elif defined(AFF3CT_64BIT_PREC)\n+ std::string precision = \"64-bit\";\n+#else\n+ std::string precision = \"Unknown\";\n+#endif\n+\n+#if defined(AFF3CT_POLAR_BIT_PACKING)\n+ std::string bit_packing = \"on\";\n+#else\n+ std::string bit_packing = \"off\";\n+#endif\n+\n+#if defined(AFF3CT_COLORS)\n+ std::string terminal_colors = \"on\";\n+#else\n+ std::string terminal_colors = \"off\";\n+#endif\n+\n+#if defined(AFF3CT_BACKTRACE)\n+ std::string backtrace = \"on\";\n+#else\n+ std::string backtrace = \"off\";\n+#endif\n+\n+#if defined(AFF3CT_ENABLE_MPI)\n+ std::string mpi = \"on\";\n+#else\n+ std::string mpi = \"off\";\n+#endif\n+\n+#if defined(AFF3CT_CHANNEL_GSL)\n+ std::string gsl = \"on\";\n+#else\n+ std::string gsl = \"off\";\n+#endif\n+\n+#if defined(AFF3CT_CHANNEL_MKL)\n+ std::string mkl = \"on\";\n+#else\n+ std::string mkl = \"off\";\n+#endif\n+\n+#if defined(AFF3CT_SYSTEMC_SIMU)\n+ std::string systemc = \"on\";\n+#else\n+ std::string systemc = \"off\";\n+#endif\n+\nstd::cout << \"aff3ct (\" << os << prec << \", \" << compiler << \" \" << compiler_version << \", \"\n<< mipp::InstructionFullType << \") \" << affect_version << std::endl;\n+ std::cout << \"Compilation options:\" << std::endl;\n+ std::cout << \" * Precision: \" << precision << std::endl;\n+ std::cout << \" * Polar bit packing: \" << bit_packing << std::endl;\n+ std::cout << \" * Terminal colors: \" << terminal_colors << std::endl;\n+ std::cout << \" * Backtrace: \" << backtrace << std::endl;\n+ std::cout << \" * MPI: \" << mpi << std::endl;\n+ std::cout << \" * GSL: \" << gsl << std::endl;\n+ std::cout << \" * MKL: \" << mkl << std::endl;\n+ std::cout << \" * SystemC: \" << systemc << std::endl;\nstd::cout << \"Copyright (c) 2016-2018 - MIT license.\" << std::endl;\nstd::cout << \"This is free software; see the source for copying conditions. There is NO\" << std::endl;\nstd::cout << \"warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\" << std::endl;\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add the compilation options in when using the '-v' parameter.
|
8,490 |
04.12.2018 18:04:34
| -3,600 |
95a79c8d50e8642f0dfe1b20ed7e8052584b7653
|
Fix a link in the README.
|
[
{
"change_type": "MODIFY",
"old_path": "README.rst",
"new_path": "README.rst",
"diff": "@@ -73,7 +73,7 @@ Contribute\n----------\n- Source Code: https://github.com/aff3ct/aff3ct\n-- Contributing guidelines: https://github.com/aff3ct/aff3ct/blob/master/CONTRIBUTING.md\n+- Contributing guidelines: https://github.com/aff3ct/aff3ct/blob/master/CONTRIBUTING.rst\nSupport\n-------\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix a link in the README.
|
8,490 |
04.12.2018 22:51:41
| -3,600 |
d5fe3e46bc597288021fafab67906800eef8e348
|
Regen the AFF3CT headers.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/tools/git-branch.sh",
"new_path": "ci/tools/git-branch.sh",
"diff": "# export GIT_BRANCH\n# fi\n-export GIT_BRANCH=master\n+export GIT_BRANCH=development\n"
},
{
"change_type": "MODIFY",
"old_path": "src/aff3ct.hpp",
"new_path": "src/aff3ct.hpp",
"diff": "#ifndef CHANNEL_AWGN_LLR_HPP_\n#include <Module/Channel/AWGN/Channel_AWGN_LLR.hpp>\n#endif\n-#ifndef CHANNELS_USER_HPP_\n+#ifndef CHANNEL_USER_ADD_HPP_\n+#include <Module/Channel/User/Channel_user_add.hpp>\n+#endif\n+#ifndef CHANNEL_USER_HPP_\n#include <Module/Channel/User/Channel_user.hpp>\n#endif\n+#ifndef CHANNEL_USER_BE_HPP_\n+#include <Module/Channel/User/Channel_user_be.hpp>\n+#endif\n+#ifndef CHANNEL_USER_BS_HPP_\n+#include <Module/Channel/User/Channel_user_bs.hpp>\n+#endif\n#ifndef CHANNEL_OPTICAL_HPP_\n#include <Module/Channel/Optical/Channel_optical.hpp>\n#endif\n#ifndef DECODER_LDPC_BP_FLOODING_INTER_HPP_\n#include <Module/Decoder/LDPC/BP/Flooding/Decoder_LDPC_BP_flooding_inter.hpp>\n#endif\n+#ifndef DECODER_LDPC_BP_FLOODING_SPA_HPP_\n+#include <Module/Decoder/LDPC/BP/Flooding/SPA/Decoder_LDPC_BP_flooding_SPA.hpp>\n+#endif\n#ifndef DECODER_LDPC_BP_FLOODING_HPP_\n#include <Module/Decoder/LDPC/BP/Flooding/Decoder_LDPC_BP_flooding.hpp>\n#endif\n#ifndef FACTORY_ENCODER_HPP\n#include <Factory/Module/Encoder/Encoder.hpp>\n#endif\n+#ifndef FACTORY_ENCODER_NO_HPP\n+#include <Factory/Module/Encoder/NO/Encoder_NO.hpp>\n+#endif\n#ifndef FACTORY_ENCODER_RA_HPP\n#include <Factory/Module/Encoder/RA/Encoder_RA.hpp>\n#endif\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Regen the AFF3CT headers.
|
8,483 |
05.12.2018 14:18:59
| -3,600 |
a3be493a83ae2f8e71e916c679b948218a0e3717
|
Fix mutual unique.
|
[
{
"change_type": "MODIFY",
"old_path": "refs",
"new_path": "refs",
"diff": "-Subproject commit 411b2d626104c03c00bc6e0c4fd594a13d7c2a3f\n+Subproject commit 7f32c432d86f7b11f49e396415865a814d0aac3d\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/general_utils.hxx",
"new_path": "src/Tools/general_utils.hxx",
"diff": "@@ -94,6 +94,9 @@ void mutual_unique(std::vector<Ta>& vec_abscissa, std::vector<To>& vec_ordinate)\n}\n}\n+ if (vec_abscissa.size() != 0 && r == 0)\n+ r = 1;\n+\nvec_abscissa.resize(r);\nvec_ordinate.resize(r);\n}\n@@ -119,6 +122,12 @@ void mutual_unique(std::vector<Ta>& vec_abscissa, std::vector<std::vector<To>>&\nvec_ordinate[k][r] = std::move(vec_ordinate[k][i]);\n}\n}\n+\n+ if (vec_abscissa.size() != 0 && r == 0)\n+ r = 1;\n+\n+ vec_abscissa.resize(r);\n+ vec_ordinate.resize(r);\n}\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix mutual unique.
|
8,483 |
05.12.2018 18:06:37
| -3,600 |
6e8264ec6c668124f48fa3c9fdfa562418a28ba9
|
Add Modem OOK ROP estimate that estimates the ROP from an amount of known bits, instead of demodulating from a known applied ROP.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Modem/Modem.cpp",
"new_path": "src/Factory/Module/Modem/Modem.cpp",
"diff": "#include \"Module/Modem/OOK/Modem_OOK_BEC.hpp\"\n#include \"Module/Modem/OOK/Modem_OOK_AWGN.hpp\"\n#include \"Module/Modem/OOK/Modem_OOK_optical.hpp\"\n+#include \"Module/Modem/OOK/Modem_OOK_optical_rop_estimate.hpp\"\n#include \"Module/Modem/BPSK/Modem_BPSK.hpp\"\n#include \"Module/Modem/BPSK/Modem_BPSK_fast.hpp\"\n#include \"Module/Modem/PAM/Modem_PAM.hpp\"\n@@ -133,6 +134,11 @@ void Modem::parameters\n{p+\"-ite\"},\ntools::Integer(tools::Positive(), tools::Non_zero()),\n\"number of iteration in the demodulator.\");\n+\n+ args.add(\n+ {p+\"-rop-est\"},\n+ tools::Integer(tools::Positive()),\n+ \"set the number of known bits for the ROP estimation in the OOK demodulator on an optical channel (when 0, the ROP is known).\");\n}\nvoid Modem::parameters\n@@ -178,6 +184,7 @@ void Modem::parameters\nif(vals.exist({p+\"-cpm-upf\" })) this->cpm_upf = vals.to_int({p+\"-cpm-upf\" });\nif(vals.exist({p+\"-cpm-map\" })) this->cpm_mapping = vals.at ({p+\"-cpm-map\" });\nif(vals.exist({p+\"-cpm-ws\" })) this->cpm_wave_shape = vals.at ({p+\"-cpm-ws\" });\n+ if(vals.exist({p+\"-rop-est\" })) this->rop_est_bits = vals.to_int({p+\"-rop-est\" });\n// force the number of bits per symbol to 1 when BPSK mod\nif (this->type == \"BPSK\" || this->type == \"OOK\")\n@@ -255,6 +262,14 @@ void Modem::parameters\n}\nif (full) headers[p].push_back(std::make_pair(\"Channel type\", channel_type));\n+\n+ if (this->type == \"OOK\")\n+ {\n+ std::string str_est = \"known\";\n+ if (this->rop_est_bits >= 0)\n+ str_est = \"on \" + std::to_string(this->rop_est_bits) + \" bits\";\n+ headers[p].push_back(std::make_pair(\"ROP estimation\", str_est));\n+ }\n}\ntemplate <typename B, typename R, typename Q, tools::proto_max<Q> MAX>\n@@ -314,8 +329,12 @@ module::Modem<B,R,Q>* Modem::parameters\n::build(const tools::Distributions<R>& dist) const\n{\nif (this->type == \"OOK\" && this->implem == \"STD\" && channel_type == \"OPTICAL\")\n+ {\n+ if (this->rop_est_bits == 0)\nreturn new module::Modem_OOK_optical<B,R,Q>(this->N, dist, tools::ROP<R>((R)this->noise), this->n_frames);\n-\n+ else\n+ return new module::Modem_OOK_optical_rop_estimate<B,R,Q>(this->N, rop_est_bits, dist, this->n_frames);\n+ }\nreturn build<B,R,Q>();\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Modem/Modem.hpp",
"new_path": "src/Factory/Module/Modem/Modem.hpp",
"diff": "@@ -51,6 +51,8 @@ struct Modem : public Factory\nint n_ite = 1; // number of demodulations/decoding sessions to perform in the BFERI simulations\nint N_fil = 0; // frame size at the output of the filter\nfloat noise = -1.f; // noise value\n+ int rop_est_bits = 0; // The number of bits known by the Modem_OOK_optical_rop_estimate demodulator\n+ // to estimate the ROP\n// ------- common parameters\nint n_frames = 1;\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "src/Module/Modem/OOK/Modem_OOK_optical_rop_estimate.cpp",
"diff": "+#include <type_traits>\n+#include <sstream>\n+#include <cmath>\n+#include <algorithm>\n+\n+#include \"Tools/Exception/exception.hpp\"\n+#include \"Tools/general_utils.h\"\n+\n+#include \"Modem_OOK_optical_rop_estimate.hpp\"\n+\n+using namespace aff3ct;\n+using namespace aff3ct::module;\n+\n+//#define ROP_KNOWN_BITS_MEAN0\n+\n+template <typename B, typename R, typename Q>\n+Modem_OOK_optical_rop_estimate<B,R,Q>\n+::Modem_OOK_optical_rop_estimate(const int N, std::vector<size_t> ROP_known_bits,\n+ const tools::Distributions<R>& dist, const int n_frames)\n+: module::Modem_OOK<B,R,Q>(N, tools::ROP<R>(0), n_frames),\n+ ROP_known_bits(std::move(ROP_known_bits)),\n+ dist(dist)\n+{\n+ const std::string name = \"Modem_OOK_optical_rop_estimate\";\n+ this->set_name(name);\n+\n+ init();\n+}\n+\n+template <typename B, typename R, typename Q>\n+Modem_OOK_optical_rop_estimate<B,R,Q>\n+::Modem_OOK_optical_rop_estimate(const int N, int n_known_bits,\n+ const tools::Distributions<R>& dist, const int n_frames)\n+: module::Modem_OOK<B,R,Q>(N, tools::ROP<R>(0), n_frames),\n+ ROP_known_bits(n_known_bits),\n+ dist(dist)\n+{\n+ const std::string name = \"Modem_OOK_optical_rop_estimate\";\n+ this->set_name(name);\n+\n+ std::iota(ROP_known_bits.begin(), ROP_known_bits.end(), 0);\n+\n+ init();\n+}\n+\n+template <typename B, typename R, typename Q>\n+void Modem_OOK_optical_rop_estimate<B,R,Q>\n+::init()\n+{\n+ dist_ROP_range = dist.get_noise_range();\n+ dist_meanvoltage_p0.resize(dist_ROP_range.size(), 0);\n+ dist_meanvoltage_p1.resize(dist_ROP_range.size(), 0);\n+\n+ // compute meanvoltage of distributions\n+ for (unsigned i = 0; i < this->dist_ROP_range.size(); i++)\n+ {\n+ const auto& d = dist.get_distribution(this->dist_ROP_range[i]);\n+\n+ const auto& pdf_x = d.get_pdf_x();\n+ const auto& pdf_y0 = d.get_pdf_y()[0];\n+ const auto& pdf_y1 = d.get_pdf_y()[1];\n+\n+ for (unsigned j = 0; j < pdf_x.size(); j++)\n+ {\n+ this->dist_meanvoltage_p0[i] += pdf_x[j] * pdf_y0[j];\n+ this->dist_meanvoltage_p1[i] += pdf_x[j] * pdf_y1[j];\n+ }\n+ }\n+}\n+\n+template <typename B, typename R, typename Q>\n+void Modem_OOK_optical_rop_estimate<B,R,Q>\n+::_demodulate_wg(const R *X_N, const Q *Y_N1, Q *Y_N2, const int frame_id)\n+{\n+ if (!std::is_same<R,Q>::value)\n+ throw tools::invalid_argument(__FILE__, __LINE__, __func__, \"Type 'R' and 'Q' have to be the same.\");\n+\n+ if (!std::is_floating_point<Q>::value)\n+ throw tools::invalid_argument(__FILE__, __LINE__, __func__, \"Type 'Q' has to be float or double.\");\n+\n+ // ROP estimation\n+ Q mean1 = 0;\n+ unsigned n_val1 = 0;\n+#ifdef ROP_KNOWN_BITS_MEAN0\n+ Q mean0 = 0;\n+ unsigned n_val0 = 0;\n+#endif\n+\n+ for (unsigned i = 0; i < ROP_known_bits.size(); i++)\n+ {\n+ auto pos = ROP_known_bits[i];\n+\n+ if (X_N[pos] == (R)1.0)\n+ {\n+ mean1 += Y_N1[pos];\n+ n_val1 ++;\n+ }\n+#ifdef ROP_KNOWN_BITS_MEAN0\n+ else\n+ {\n+ mean0 += Y_N1[pos];\n+ n_val0 ++;\n+ }\n+#endif\n+ }\n+\n+ mean1 /= n_val1;\n+ auto idx_ROP1 = tools::get_closest_index(dist_meanvoltage_p1.begin(), dist_meanvoltage_p1.end(), mean1);\n+\n+#ifdef ROP_KNOWN_BITS_MEAN0\n+ mean0 /= n_val0;\n+ auto idx_ROP0 = tools::get_closest_index(dist_meanvoltage_p0.begin(), dist_meanvoltage_p0.end(), mean0);\n+#endif\n+\n+ const auto estimated_ROP = this->dist_ROP_range[idx_ROP1];\n+\n+ // LLR computation\n+ const auto& d = dist.get_distribution(estimated_ROP);\n+ const auto& pdf_x = d.get_pdf_x();\n+ const auto& pdf_y0 = d.get_pdf_y()[0];\n+ const auto& pdf_y1 = d.get_pdf_y()[1];\n+\n+ const auto min_value = (Q)1e-10; // when prob_1 ou prob_0 = 0;\n+\n+ for (auto i = 0; i < this->N_fil; i++)\n+ {\n+ auto x_pos = tools::get_closest_index(pdf_x.begin(), pdf_x.end(), Y_N1[i]);\n+\n+ auto prob_0 = pdf_y0[x_pos] == (Q)0 ? min_value : pdf_y0[x_pos];\n+ auto prob_1 = pdf_y1[x_pos] == (Q)0 ? min_value : pdf_y1[x_pos];\n+\n+ Y_N2[i] = std::log(prob_0/prob_1);\n+ }\n+}\n+\n+// ==================================================================================== explicit template instantiation\n+#include \"Tools/types.h\"\n+#ifdef AFF3CT_MULTI_PREC\n+template class aff3ct::module::Modem_OOK_optical_rop_estimate<B_8, R_8, Q_8>;\n+template class aff3ct::module::Modem_OOK_optical_rop_estimate<B_8, R_8, R_8>;\n+template class aff3ct::module::Modem_OOK_optical_rop_estimate<B_16,R_16,Q_16>;\n+template class aff3ct::module::Modem_OOK_optical_rop_estimate<B_16,R_16,R_16>;\n+template class aff3ct::module::Modem_OOK_optical_rop_estimate<B_32,R_32,Q_32>;\n+template class aff3ct::module::Modem_OOK_optical_rop_estimate<B_64,R_64,Q_64>;\n+#else\n+template class aff3ct::module::Modem_OOK_optical_rop_estimate<B,R,Q>;\n+#if !defined(AFF3CT_32BIT_PREC) && !defined(AFF3CT_64BIT_PREC)\n+template class aff3ct::module::Modem_OOK_optical_rop_estimate<B,R,R>;\n+#endif\n+#endif\n+// ==================================================================================== explicit template instantiation\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "src/Module/Modem/OOK/Modem_OOK_optical_rop_estimate.hpp",
"diff": "+#ifndef MODEM_OOK_OPTICAL_ROP_ESTIMATE_HPP_\n+#define MODEM_OOK_OPTICAL_ROP_ESTIMATE_HPP_\n+\n+#include <vector>\n+\n+#include \"Tools/Math/Distribution/Distributions.hpp\"\n+\n+#include \"Modem_OOK.hpp\"\n+\n+namespace aff3ct\n+{\n+namespace module\n+{\n+template <typename B = int, typename R = float, typename Q = R>\n+class Modem_OOK_optical_rop_estimate : public Modem_OOK<B,R,Q>\n+{\n+protected:\n+ std::vector<size_t> ROP_known_bits;\n+ const tools::Distributions<R>& dist;\n+\n+ std::vector<R> dist_ROP_range;\n+\n+ std::vector<R> dist_meanvoltage_p0;\n+ std::vector<R> dist_meanvoltage_p1;\n+\n+public:\n+ /*\n+ * The 'ROP_known_bits' positions of the original frame are used for the ROP estimation\n+ */\n+ Modem_OOK_optical_rop_estimate(const int N, std::vector<size_t> ROP_known_bits,\n+ const tools::Distributions<R>& dist, const int n_frames);\n+\n+ /*\n+ * The 'n_known_bits' first bits are supposed known for the ROP estimation\n+ */\n+ Modem_OOK_optical_rop_estimate(const int N, int n_known_bits,\n+ const tools::Distributions<R>& dist, const int n_frames);\n+ virtual ~Modem_OOK_optical_rop_estimate() = default;\n+\n+protected:\n+ // H_N is replaced by X_N, that is the output of the modulation in order to estimate values\n+ void _demodulate_wg(const R *X_N, const Q *Y_N1, Q *Y_N2, const int frame_id = -1);\n+\n+private:\n+ void init();\n+};\n+}\n+}\n+#endif /* MODEM_OOK_OPTICAL_ROP_ESTIMATE_HPP_ */\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Simulation/BFER/BFER.cpp",
"new_path": "src/Simulation/BFER/BFER.cpp",
"diff": "@@ -49,7 +49,9 @@ BFER<B,R,Q>\n}\nif (!params_BFER.noise->pdf_path.empty())\n- distributions.reset(new tools::Distributions<R>(params_BFER.noise->pdf_path));\n+ distributions.reset(new tools::Distributions<R>(params_BFER.noise->pdf_path,\n+ tools::Distribution_mode::SUMMATION,\n+ params_BFER.mdm->rop_est_bits > 0));\nthis->build_monitors ();\nthis->build_reporters();\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Simulation/BFER/Standard/Threads/BFER_std_threads.cpp",
"new_path": "src/Simulation/BFER/Standard/Threads/BFER_std_threads.cpp",
"diff": "@@ -154,6 +154,16 @@ void BFER_std_threads<B,R,Q>\nmdm[mdm::sck::demodulate_wg::Y_N1](mdm[mdm::sck::filter ::Y_N2]);\nqnt[qnt::sck::process ::Y_N1](mdm[mdm::sck::demodulate_wg::Y_N2]);\n}\n+ else if (this->params_BFER_std.chn->type == \"OPTICAL\" && this->params_BFER_std.mdm->rop_est_bits > 0)\n+ {\n+ chn[chn::sck::add_noise ::X_N ](mdm[mdm::sck::modulate ::X_N2]);\n+ mdm[mdm::sck::demodulate_wg::H_N ](mdm[mdm::sck::modulate ::X_N2]);\n+ mdm[mdm::sck::demodulate_wg::Y_N1](chn[chn::sck::add_noise ::Y_N ]);\n+ qnt[qnt::sck::process ::Y_N1](mdm[mdm::sck::demodulate_wg::Y_N2]);\n+\n+ if (this->params_BFER_std.qnt->type == \"NO\")\n+ qnt[qnt::sck::process::Y_N2](qnt[qnt::sck::process::Y_N1]);\n+ }\nelse\n{\nif (this->params_BFER_std.chn->type == \"NO\")\n@@ -302,6 +312,13 @@ void BFER_std_threads<B,R,Q>\nif (this->params_BFER_std.qnt->type != \"NO\")\nquantizer[qnt::tsk::process].exec();\n}\n+ else if (this->params_BFER_std.chn->type == \"OPTICAL\" && this->params_BFER_std.mdm->rop_est_bits > 0)\n+ {\n+ channel[chn::tsk::add_noise].exec();\n+ modem[mdm::tsk::demodulate_wg].exec();\n+ if (this->params_BFER_std.qnt->type != \"NO\")\n+ quantizer[qnt::tsk::process].exec();\n+ }\nelse\n{\nif (this->params_BFER_std.chn->type != \"NO\")\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add Modem OOK ROP estimate that estimates the ROP from an amount of known bits, instead of demodulating from a known applied ROP.
|
8,483 |
05.12.2018 18:30:06
| -3,600 |
d01ba7af098ed13bba98155834c95734d7d57bd7
|
Add a verification of the number of bits used to estimate the ROP (not bigger than N)
|
[
{
"change_type": "MODIFY",
"old_path": "src/Module/Modem/OOK/Modem_OOK_optical_rop_estimate.cpp",
"new_path": "src/Module/Modem/OOK/Modem_OOK_optical_rop_estimate.cpp",
"diff": "@@ -47,6 +47,14 @@ template <typename B, typename R, typename Q>\nvoid Modem_OOK_optical_rop_estimate<B,R,Q>\n::init()\n{\n+ if (ROP_known_bits.size() > this->N)\n+ {\n+ std::stringstream message;\n+ message << \"'ROP_known_bits.size()' has to be smaller than 'N' ('ROP_known_bits.size()' = \"\n+ << ROP_known_bits.size() << \", 'N' = \" << this->N << \").\";\n+ throw tools::invalid_argument(__FILE__, __LINE__, __func__, message.str());\n+ }\n+\ndist_ROP_range = dist.get_noise_range();\ndist_meanvoltage_p0.resize(dist_ROP_range.size(), 0);\ndist_meanvoltage_p1.resize(dist_ROP_range.size(), 0);\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add a verification of the number of bits used to estimate the ROP (not bigger than N)
|
8,483 |
05.12.2018 18:31:13
| -3,600 |
775f883d8f7d59a9f713d077f424ad5f1515bd21
|
Doc: Add --mdm-rop-est
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/modem/modem.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/modem/modem.rst",
"diff": "@@ -388,6 +388,21 @@ Where |n0_equation|\nSee the :ref:`mdm-mdm-no-sig2` parameter to disable the division by\n:math:`\\sigma^2`.\n+.. _mdm-mdm-rop-est:\n+\n+``--mdm-rop-est``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: integer\n+ :Default: 0\n+ :Examples: ``--mdm-rop-est 256``\n+\n+Set the number of known bits for the |ROP| estimation in the |OOK| demodulator\n+on an optical channel. The estimation is done from a known set of bits\n+that is the output of the modulation.\n+\n+If left to 0, the demodulation is done with the exact applied |ROP| in the\n+channel.\nReferences\n\"\"\"\"\"\"\"\"\"\"\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: Add --mdm-rop-est
|
8,490 |
05.12.2018 11:52:17
| -3,600 |
2a44fb40ea429c57cd0270844accfd3619da8579
|
CI: add a test to validate the AFF3CT headers.
|
[
{
"change_type": "MODIFY",
"old_path": ".gitlab-ci.yml",
"new_path": ".gitlab-ci.yml",
"diff": "@@ -24,6 +24,19 @@ analysis-cppcheck:\nscript:\n- ./ci/analysis-cppcheck.sh\n+analysis-headers:\n+ stage: analysis\n+ artifacts:\n+ name: analysis-headers\n+ when: always\n+ paths:\n+ - aff3ct.hpp\n+ tags:\n+ - linux\n+ script:\n+ - ./scripts/generate_aff3ct_header.sh aff3ct.hpp\n+ - diff aff3ct.hpp src/aff3ct.hpp\n+\nbuild-linux-gcc-nointr:\nstage: build\ntags:\n"
},
{
"change_type": "MODIFY",
"old_path": "scripts/generate_aff3ct_header.sh",
"new_path": "scripts/generate_aff3ct_header.sh",
"diff": "#!/bin/bash\nSRC_DIR=\".\\/src\"\n+if [ -z \"$1\" ]; then\nAFF3CT_HEADER=.\\/src\\/aff3ct.hpp\n+else\n+ AFF3CT_HEADER=\"$1\"\n+fi\necho -e \"#ifndef AFF3CT_HPP\\n#define AFF3CT_HPP\\n\" > $AFF3CT_HEADER # create the aff3ct header file with the c++ header\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: add a test to validate the AFF3CT headers.
|
8,490 |
05.12.2018 14:11:26
| -3,600 |
b70983b833debc1d43d05239c90cb506c042b043
|
Add the 'development' branch for the pull requests.
|
[
{
"change_type": "MODIFY",
"old_path": "CONTRIBUTING.rst",
"new_path": "CONTRIBUTING.rst",
"diff": "@@ -16,7 +16,9 @@ Submitting changes\n.. _pull requests: https://help.github.com/articles/about-pull-requests/\nPlease send a `GitHub Pull Request to AFF3CT`_ with a clear list of what you've\n-done (read more about `pull requests`_).\n+done (read more about `pull requests`_). Please make your modifications on the\n+``development`` branch, any pull to the ``master`` branch will be refused (the\n+``master`` is dedecated to the releases).\nAlways write a clear log message for your commits. One-line messages are fine\nfor small changes, but bigger changes should look like this:\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add the 'development' branch for the pull requests.
|
8,490 |
05.12.2018 14:18:12
| -3,600 |
48a324853664d8fbb8eedce8666176cb911992be
|
Fix the headers script to be deterministic.
|
[
{
"change_type": "MODIFY",
"old_path": "scripts/generate_aff3ct_header.sh",
"new_path": "scripts/generate_aff3ct_header.sh",
"diff": "@@ -20,7 +20,7 @@ headershpp=$(find .\\/src\\/ -type f -follow -print | # find all source files\nheaders=\"$headersh $headershpp\"\n# sort the header by alphabetical order\n-headers=$(echo $headers | tr \" \" \"\\n\" | sort | tr \"\\n\" \" \" ; echo)\n+headers=$(echo $headers | tr \" \" \"\\n\" | sort -f | tr \"\\n\" \" \" ; echo)\nfor f in $headers; do\ngrep -m1 \"#ifndef\" < $f >> $AFF3CT_HEADER # add a guard to the header file to accelerate compilation\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix the headers script to be deterministic.
|
8,490 |
05.12.2018 14:24:26
| -3,600 |
52ecb91fc196cc97001e39c575c1dc7abd5140eb
|
Same than prev. commit.
|
[
{
"change_type": "MODIFY",
"old_path": "scripts/generate_aff3ct_header.sh",
"new_path": "scripts/generate_aff3ct_header.sh",
"diff": "@@ -20,7 +20,7 @@ headershpp=$(find .\\/src\\/ -type f -follow -print | # find all source files\nheaders=\"$headersh $headershpp\"\n# sort the header by alphabetical order\n-headers=$(echo $headers | tr \" \" \"\\n\" | sort -f | tr \"\\n\" \" \" ; echo)\n+headers=$(echo $headers | tr \" \" \"\\n\" | sort -f -d | tr \"\\n\" \" \" ; echo)\nfor f in $headers; do\ngrep -m1 \"#ifndef\" < $f >> $AFF3CT_HEADER # add a guard to the header file to accelerate compilation\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Same than prev. commit.
|
8,490 |
05.12.2018 16:05:05
| -3,600 |
42dd0b5af35a3eb6a104d900fc988c77d236858d
|
CI: add a stage to compile the doc in the pipeline.
|
[
{
"change_type": "MODIFY",
"old_path": ".gitlab-ci.yml",
"new_path": ".gitlab-ci.yml",
"diff": "stages:\n- analysis\n- build\n+ - documentation\n- test\n- coverage\n- deploy\n@@ -37,6 +38,21 @@ analysis-headers:\n- ./scripts/generate_aff3ct_header.sh aff3ct.hpp\n- diff aff3ct.hpp src/aff3ct.hpp\n+documentation-sphinx:\n+ stage: documentation\n+ artifacts:\n+ name: documentation-sphinx\n+ when: always\n+ paths:\n+ - doc/sphinx/build/html\n+ - doc/sphinx/build/latex\n+ tags:\n+ - sphinx latex\n+ script:\n+ - cd doc/sphinx\n+ - make html\n+ - make latexpdf\n+\nbuild-linux-gcc-nointr:\nstage: build\ntags:\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: add a stage to compile the doc in the pipeline.
|
8,490 |
05.12.2018 16:30:40
| -3,600 |
2a90e9348c39d347e8870d6865359b882601ead7
|
CI: add the doc in the builds.
|
[
{
"change_type": "MODIFY",
"old_path": ".gitlab-ci.yml",
"new_path": ".gitlab-ci.yml",
"diff": "@@ -548,6 +548,7 @@ deploy-builds-linux:\n- build-windows-gcc-x86-sse4.2\n- build-windows-gcc-x64-avx2\n- build-macos-clang-x64-sse4.2\n+ - documentation-sphinx\ntags:\n- linux\n- github\n"
},
{
"change_type": "MODIFY",
"old_path": "ci/deploy-builds-linux.sh",
"new_path": "ci/deploy-builds-linux.sh",
"diff": "@@ -52,8 +52,18 @@ do\nZIP_NAME=$(echo \"${BUILD/build/$PREFIX}\")\nZIP_NAME=$(echo \"${ZIP_NAME/\\./\\_}_$GIT_HASH.zip\")\n+ # prepare headers\nfind $BUILD/include/aff3ct/ -type f -follow -print | grep \"[.]cpp$\" | xargs rm -f\nfind $BUILD/include/aff3ct/ -type f -follow -print | grep \"[.]cpp.in$\" | xargs rm -f\n+ cp -r lib/date/include/date $BUILD/include/\n+ mkdir $BUILD/include/MIPP\n+ cp -r lib/MIPP/src/* $BUILD/include/MIPP/\n+ mkdir $BUILD/include/dirent\n+ cp lib/MSVC/include/dirent.h $BUILD/include/dirent/\n+ mkdir $BUILD/include/rang\n+ cp lib/rang/include/rang.hpp $BUILD/include/rang/\n+\n+ # prepare conf and refs files\nmkdir $BUILD/share\nmkdir $BUILD/share/aff3ct\ncp -r conf $BUILD/share/aff3ct/\n@@ -61,6 +71,12 @@ do\nrm -rf $BUILD/share/aff3ct/conf/.git\nrm -rf $BUILD/share/aff3ct/refs/.git\n+ # prepare doc\n+ mkdir $BUILD/share/aff3ct/doc\n+ cp -r doc/sphinx/build/html $BUILD/share/aff3ct/doc/\n+ mkdir $BUILD/share/aff3ct/doc/pdf\n+ cp doc/sphinx/build/latexpdf/AFF3CT.pdf $BUILD/share/aff3ct/doc/pdf\n+\nzip -r $ZIP_NAME $BUILD\ncp $ZIP_NAME ${REPO_WEB}/${REPO_RESSOURCES}/aff3ct_builds/\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: add the doc in the builds.
|
8,490 |
05.12.2018 17:22:49
| -3,600 |
27e503969d5a43e1771ab2b43d017c3babb033fb
|
Add an error message if AFF3CT is not in a Git repo.
|
[
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -6,6 +6,12 @@ cmake_minimum_required (VERSION 3.0.2)\ncmake_policy(SET CMP0054 NEW)\nproject (aff3ct)\n+if (NOT EXISTS \"${CMAKE_CURRENT_SOURCE_DIR}/.git\")\n+ message(FATAL_ERROR \"The '.git' folder can't be found, AFF3CT can't be compiled if it is not cloned \"\n+ \"from a Git repository. Please do not download ZIP from GitHub and make a Git \"\n+ \"clone instead (git clone https://github.com/aff3ct/MIPP.git).\")\n+endif()\n+\n# ---------------------------------------------------------------------------------------------------------------------\n# ------------------------------------------------------------------------------------------------------- CMAKE OPTIONS\n# ---------------------------------------------------------------------------------------------------------------------\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add an error message if AFF3CT is not in a Git repo.
|
8,490 |
05.12.2018 19:04:58
| -3,600 |
912c796810ba4548e9e521c75ab0e70d2a110641
|
Fix compilation error and warning.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Module/Modem/OOK/Modem_OOK_optical_rop_estimate.cpp",
"new_path": "src/Module/Modem/OOK/Modem_OOK_optical_rop_estimate.cpp",
"diff": "#include <sstream>\n#include <cmath>\n#include <algorithm>\n+#include <numeric>\n#include \"Tools/Exception/exception.hpp\"\n#include \"Tools/general_utils.h\"\n@@ -47,7 +48,7 @@ template <typename B, typename R, typename Q>\nvoid Modem_OOK_optical_rop_estimate<B,R,Q>\n::init()\n{\n- if (ROP_known_bits.size() > this->N)\n+ if (ROP_known_bits.size() > (size_t)this->N)\n{\nstd::stringstream message;\nmessage << \"'ROP_known_bits.size()' has to be smaller than 'N' ('ROP_known_bits.size()' = \"\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix compilation error and warning.
|
8,490 |
05.12.2018 21:14:13
| -3,600 |
3ccd7de1b66c5a149fafcbde6bc8d34ddf777abb
|
Fix under scope variable issue + pad frame ids with zeros instead of spaces.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Module/Task.cpp",
"new_path": "src/Module/Task.cpp",
"diff": "@@ -124,19 +124,6 @@ Hexfloat hexfloat;\nstd::ostream& operator<<(std::ostream &os, const std::Hexfloat &obj) { obj.message(os); return os; }\n#endif\n-uint32_t n_digits_dec(uint32_t v)\n-{\n- uint32_t count = 0;\n- while (v)\n- {\n- count++;\n- v /= 10;\n- }\n-\n- return count;\n-}\n-\n-\ntemplate <typename T>\nstatic inline void display_data(const T *data,\nconst size_t fra_size, const size_t n_fra, const size_t limit, const size_t max_frame,\n@@ -170,12 +157,29 @@ static inline void display_data(const T *data,\nfor (uint8_t s = 0; s < n_spaces -1; s++)\nspaces += \" \";\n+ auto n_digits_dec = [](size_t f) -> size_t\n+ {\n+ size_t count = 0;\n+ while (f && ++count)\n+ f /= 10;\n+ return count;\n+ };\n+\nconst auto n_digits = n_digits_dec(max_frame);\n+ auto ftos = [&n_digits_dec,&n_digits](size_t f) -> std::string\n+ {\n+ auto n_zero = n_digits - n_digits_dec(f);\n+ std::string f_str = \"\";\n+ for (size_t z = 0; z < n_zero; z++)\n+ f_str += \"0\";\n+ f_str += std::to_string(f);\n+ return f_str;\n+ };\nfor (size_t f = 0; f < max_frame; f++)\n{\n- std::cout << (f >= 1 ? spaces : \"\") << rang::style::bold << rang::fg::gray << \"f\" << std::setw(n_digits)\n- << f+1 << rang::style::reset << \"(\";\n+ std::cout << (f >= 1 ? spaces : \"\") << rang::style::bold << rang::fg::gray << \"f\" << ftos(f+1)\n+ << rang::style::reset << \"(\";\nfor (size_t i = 0; i < limit; i++)\n{\n@@ -189,10 +193,9 @@ static inline void display_data(const T *data,\n}\nif (max_frame < n_fra)\n- {\n- std::cout << (f >= 1 ? spaces : \"\") << rang::style::bold << rang::fg::gray << \"f\" << std::setw(n_digits)\n- << max_frame + 1 << \"->\" << \"f\" << n_fra << \":\" << rang::style::reset << \"(...)\";\n- }\n+ std::cout << (max_frame >= 1 ? spaces : \"\") << rang::style::bold << rang::fg::gray << \"f\"\n+ << std::setw(n_digits) << max_frame + 1 << \"->\" << \"f\" << n_fra << \":\"\n+ << rang::style::reset << \"(...)\";\n}\nstd::cout.flags(f);\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix under scope variable issue + pad frame ids with zeros instead of spaces.
|
8,490 |
05.12.2018 21:55:07
| -3,600 |
e2328ed763e3cf2a45d6e21fa0f849c5d771eb05
|
CI: fix wrong PDF path.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/deploy-builds-linux.sh",
"new_path": "ci/deploy-builds-linux.sh",
"diff": "@@ -75,7 +75,7 @@ do\nmkdir $BUILD/share/aff3ct/doc\ncp -r doc/sphinx/build/html $BUILD/share/aff3ct/doc/\nmkdir $BUILD/share/aff3ct/doc/pdf\n- cp doc/sphinx/build/latexpdf/AFF3CT.pdf $BUILD/share/aff3ct/doc/pdf\n+ cp doc/sphinx/build/latex/AFF3CT.pdf $BUILD/share/aff3ct/doc/pdf\nzip -r $ZIP_NAME $BUILD\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: fix wrong PDF path.
|
8,490 |
05.12.2018 23:48:53
| -3,600 |
87cad9d80f5f707a9d2b8ad2477fbf322af707bf
|
CI: rm 'readers' folder from the refs in the builds.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/deploy-builds-linux.sh",
"new_path": "ci/deploy-builds-linux.sh",
"diff": "@@ -70,6 +70,7 @@ do\ncp -r refs $BUILD/share/aff3ct/\nrm -rf $BUILD/share/aff3ct/conf/.git\nrm -rf $BUILD/share/aff3ct/refs/.git\n+ rm -rf $BUILD/share/aff3ct/refs/readers\n# prepare doc\nmkdir $BUILD/share/aff3ct/doc\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: rm 'readers' folder from the refs in the builds.
|
8,483 |
06.12.2018 08:49:37
| -3,600 |
72851659ae61ecdde0af490b1afc162d0815bd3b
|
Fix aff3ct.hpp and set refs to the right commit
|
[
{
"change_type": "MODIFY",
"old_path": "refs",
"new_path": "refs",
"diff": "-Subproject commit 7e1f9690fb24ec09f40492ea0bfe8dcd82aad908\n+Subproject commit 2e93075f332b879b37c595bbd833c20c6be2f1cf\n"
},
{
"change_type": "MODIFY",
"old_path": "src/aff3ct.hpp",
"new_path": "src/aff3ct.hpp",
"diff": "#ifndef MODEM_OOK_OPTICAL_HPP_\n#include <Module/Modem/OOK/Modem_OOK_optical.hpp>\n#endif\n+#ifndef MODEM_OOK_OPTICAL_ROP_ESTIMATE_HPP_\n+#include <Module/Modem/OOK/Modem_OOK_optical_rop_estimate.hpp>\n+#endif\n#ifndef MODEM_PAM_HPP_\n#include <Module/Modem/PAM/Modem_PAM.hpp>\n#endif\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix aff3ct.hpp and set refs to the right commit
|
8,483 |
06.12.2018 09:34:36
| -3,600 |
a5841cec2bb4f76bcce87c24c85a4b93069dcb83
|
Change the BFER std SC chain with the Optical ROP estimation channel and modem
|
[
{
"change_type": "MODIFY",
"old_path": "src/Simulation/BFER/Standard/SystemC/SC_BFER_std.cpp",
"new_path": "src/Simulation/BFER/Standard/SystemC/SC_BFER_std.cpp",
"diff": "@@ -62,6 +62,11 @@ void SC_BFER_std<B,R,Q>\nthis->channel[tid]->sc.create_module(+chn::tsk::add_noise_wg );\nthis->modem [tid]->sc.create_module(+mdm::tsk::demodulate_wg);\n}\n+ else if (this->params_BFER_std.chn->type == \"OPTICAL\" && this->params_BFER_std.mdm->rop_est_bits > 0)\n+ {\n+ this->channel[tid]->sc.create_module(+chn::tsk::add_noise );\n+ this->modem [tid]->sc.create_module(+mdm::tsk::demodulate_wg);\n+ }\nelse\n{\nthis->channel[tid]->sc.create_module(+chn::tsk::add_noise );\n@@ -147,6 +152,11 @@ void SC_BFER_std<B,R,Q>\nchn.sc[+chn::tsk::add_noise_wg ].s_out [+chn::sck::add_noise_wg ::Y_N ](mdm.sc[+mdm::tsk::filter ].s_in[+mdm::sck::filter ::Y_N1]);\nmdm.sc[+mdm::tsk::filter ].s_out [+mdm::sck::filter ::Y_N2](mdm.sc[+mdm::tsk::demodulate_wg].s_in[+mdm::sck::demodulate_wg::Y_N1]);\nmdm.sc[+mdm::tsk::demodulate_wg].s_out [+mdm::sck::demodulate_wg::Y_N2](qnt.sc[+qnt::tsk::process ].s_in[+qnt::sck::process ::Y_N1]);\n+ } else if (this->params_BFER_std.chn->type == \"OPTICAL\" && this->params_BFER_std.mdm->rop_est_bits > 0){ // optical channel with ROP estimation\n+ mdm.sc[+mdm::tsk::modulate ].s_out [+mdm::sck::modulate ::X_N2](chn.sc[+chn::tsk::add_noise ].s_out[+chn::sck::add_noise ::X_N ]);\n+ mdm.sc[+mdm::tsk::modulate ].s_out [+mdm::sck::modulate ::X_N2](mdm.sc[+mdm::tsk::demodulate_wg].s_out[+mdm::sck::demodulate_wg::H_N ]);\n+ chn.sc[+chn::tsk::add_noise ].s_out [+chn::sck::add_noise ::Y_N ](mdm.sc[+mdm::tsk::demodulate_wg].s_out[+mdm::sck::demodulate_wg::Y_N1]);\n+ mdm.sc[+mdm::tsk::demodulate_wg].s_out [+mdm::sck::demodulate_wg::Y_N2](qnt.sc[+qnt::tsk::process ].s_out[+qnt::sck::process ::Y_N1]);\n} else { // additive channel (AWGN, USER, NO)\nmdm.sc[+mdm::tsk::modulate ].s_out [+mdm::sck::modulate ::X_N2](chn.sc[+chn::tsk::add_noise ].s_in[+chn::sck::add_noise ::X_N ]);\nchn.sc[+chn::tsk::add_noise ].s_out [+chn::sck::add_noise ::Y_N ](mdm.sc[+mdm::tsk::filter ].s_in[+mdm::sck::filter ::Y_N1]);\n@@ -174,6 +184,11 @@ void SC_BFER_std<B,R,Q>\nchn.sc[+chn::tsk::add_noise_wg ].s_out [+chn::sck::add_noise_wg ::Y_N ](mdm.sc[+mdm::tsk::filter ].s_in[+mdm::sck::filter ::Y_N1]);\nmdm.sc[+mdm::tsk::filter ].s_out [+mdm::sck::filter ::Y_N2](mdm.sc[+mdm::tsk::demodulate_wg].s_in[+mdm::sck::demodulate_wg::Y_N1]);\nmdm.sc[+mdm::tsk::demodulate_wg].s_out [+mdm::sck::demodulate_wg::Y_N2](qnt.sc[+qnt::tsk::process ].s_in[+qnt::sck::process ::Y_N1]);\n+ } else if (this->params_BFER_std.chn->type == \"OPTICAL\" && this->params_BFER_std.mdm->rop_est_bits > 0){ // optical channel with ROP estimation\n+ mdm.sc[+mdm::tsk::modulate ].s_out [+mdm::sck::modulate ::X_N2](chn.sc[+chn::tsk::add_noise ].s_out[+chn::sck::add_noise ::X_N ]);\n+ mdm.sc[+mdm::tsk::modulate ].s_out [+mdm::sck::modulate ::X_N2](mdm.sc[+mdm::tsk::demodulate_wg].s_out[+mdm::sck::demodulate_wg::H_N ]);\n+ chn.sc[+chn::tsk::add_noise ].s_out [+chn::sck::add_noise ::Y_N ](mdm.sc[+mdm::tsk::demodulate_wg].s_out[+mdm::sck::demodulate_wg::Y_N1]);\n+ mdm.sc[+mdm::tsk::demodulate_wg].s_out [+mdm::sck::demodulate_wg::Y_N2](qnt.sc[+qnt::tsk::process ].s_out[+qnt::sck::process ::Y_N1]);\n} else { // additive channel (AWGN, USER, NO)\nmdm.sc[+mdm::tsk::modulate ].s_out [+mdm::sck::modulate ::X_N2](chn.sc[+chn::tsk::add_noise ].s_in[+chn::sck::add_noise ::X_N ]);\nchn.sc[+chn::tsk::add_noise ].s_out [+chn::sck::add_noise ::Y_N ](mdm.sc[+mdm::tsk::filter ].s_in[+mdm::sck::filter ::Y_N1]);\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Change the BFER std SC chain with the Optical ROP estimation channel and modem
|
8,483 |
06.12.2018 10:29:46
| -3,600 |
4b7ddd0d87e091532dd6eef72682cfac52fc6f9d
|
Fix factory display bug of the number of known bits for Modem OOK ROP estimation when it is null.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Modem/Modem.cpp",
"new_path": "src/Factory/Module/Modem/Modem.cpp",
"diff": "@@ -266,7 +266,7 @@ void Modem::parameters\nif (this->type == \"OOK\")\n{\nstd::string str_est = \"known\";\n- if (this->rop_est_bits >= 0)\n+ if (this->rop_est_bits > 0)\nstr_est = \"on \" + std::to_string(this->rop_est_bits) + \" bits\";\nheaders[p].push_back(std::make_pair(\"ROP estimation\", str_est));\n}\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix factory display bug of the number of known bits for Modem OOK ROP estimation when it is null.
|
8,490 |
06.12.2018 11:10:07
| -3,600 |
f7fe5b0cef496eb0a85950f82b06eaebab134c8a
|
Exclude 'readers' dir in the refs install.
|
[
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -447,5 +447,7 @@ if (EXISTS \"${CMAKE_CURRENT_SOURCE_DIR}/conf/cde/\")\nendif()\nif (EXISTS \"${CMAKE_CURRENT_SOURCE_DIR}/refs/BCH/\")\ninstall(DIRECTORY \"${CMAKE_CURRENT_SOURCE_DIR}/refs/\" DESTINATION share/aff3ct-${GIT_VERSION_RMV}/refs\n- FILES_MATCHING PATTERN \"*.txt\")\n+ FILES_MATCHING PATTERN \"*.txt\"\n+ PATTERN \"readers\" EXCLUDE\n+ PATTERN \"untracked\" EXCLUDE)\nendif()\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Exclude 'readers' dir in the refs install.
|
8,483 |
06.12.2018 11:52:31
| -3,600 |
7ae697f08164b9a950e8548dae656226badcbc49
|
Fix peeling decoder by setting the current syndrome depth to 0 when calling the decoder.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Module/Decoder/LDPC/BP/Peeling/Decoder_LDPC_BP_peeling.cpp",
"new_path": "src/Module/Decoder/LDPC/BP/Peeling/Decoder_LDPC_BP_peeling.cpp",
"diff": "@@ -29,6 +29,7 @@ template <typename B, typename R>\nbool Decoder_LDPC_BP_peeling<B,R>\n::_decode(const int frame_id)\n{\n+ this->cur_syndrome_depth = 0;\nauto links = this->H;\nauto& CN = this->check_nodes;\n@@ -92,7 +93,7 @@ bool Decoder_LDPC_BP_peeling<B,R>\nif (this->enable_syndrome && (all_check_nodes_done || no_modification))\n{\nthis->cur_syndrome_depth++;\n- if (this->cur_syndrome_depth == this->syndrome_depth)\n+ if (this->cur_syndrome_depth >= this->syndrome_depth)\nbreak;\n}\nelse\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix peeling decoder by setting the current syndrome depth to 0 when calling the decoder.
|
8,490 |
07.12.2018 11:32:39
| -3,600 |
7dd38b4fa4e35f5bbcd824652031917bcdf0440d
|
Replace 'TURBO_PROD' by 'TPC'.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo_prod/encoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/turbo_prod/encoder.rst",
"diff": "@@ -33,27 +33,27 @@ square of this value.\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: text\n- :Allowed values: ``TURBO_PROD`` ``AZCW`` ``COSET`` ``USER``\n- :Default: ``TURBO_PROD``\n- :Examples: ``--enc-type TURBO_PROD``\n+ :Allowed values: ``TPC`` ``AZCW`` ``COSET`` ``USER``\n+ :Default: ``TPC``\n+ :Examples: ``--enc-type AZCW``\nSet the type of the encoder to use in the simulation.\nDescription of the allowed values:\n-+----------------+-----------------------------+\n++-----------+------------------------+\n| Value | Description |\n-+================+=============================+\n-| ``TURBO_PROD`` | |enc-type_descr_turbo_prod| |\n-+----------------+-----------------------------+\n++===========+========================+\n+| ``TPC`` | |enc-type_descr_tpc| |\n++-----------+------------------------+\n| ``AZCW`` | |enc-type_descr_azcw| |\n-+----------------+-----------------------------+\n++-----------+------------------------+\n| ``COSET`` | |enc-type_descr_coset| |\n-+----------------+-----------------------------+\n++-----------+------------------------+\n| ``USER`` | |enc-type_descr_user| |\n-+----------------+-----------------------------+\n++-----------+------------------------+\n-.. |enc-type_descr_turbo_prod| replace:: The |TPC| encoder.\n+.. |enc-type_descr_tpc| replace:: The |TPC| encoder.\n.. |enc-type_descr_azcw| replace:: See the common :ref:`enc-common-enc-type`\nparameter.\n.. |enc-type_descr_coset| replace:: See the common :ref:`enc-common-enc-type`\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/other/other.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/other/other.rst",
"diff": "@@ -20,7 +20,7 @@ The latter change in function of the selected simulation type and code.\nUsage: ./bin/aff3ct -C <text> [optional args...]\nSimulation parameter(s):\n- {R} --sim-cde-type, -C <text:including set={BCH|LDPC|POLAR|RA|REP|RS|RSC|RSC_DB|TURBO|TURBO_DB|TURBO_PROD|UNCODED}>\n+ {R} --sim-cde-type, -C <text:including set={BCH|LDPC|POLAR|RA|REP|RS|RSC|RSC_DB|TPC|TURBO|TURBO_DB|UNCODED}>\nselect the code type you want to use.\n--sim-no-colors\ndisable the colors in the shell.\n@@ -53,7 +53,7 @@ Print the help with in more the advanced ``{A}`` arguments.\nUsage: ./bin/aff3ct -C <text> [optional args...]\nSimulation parameter(s):\n- {R} --sim-cde-type, -C <text:including set={BCH|LDPC|POLAR|RA|REP|RS|RSC|RSC_DB|TURBO|TURBO_DB|TURBO_PROD|UNCODED}>\n+ {R} --sim-cde-type, -C <text:including set={BCH|LDPC|POLAR|RA|REP|RS|RSC|RSC_DB|TPC|TURBO|TURBO_DB|UNCODED}>\nselect the code type you want to use.\n--sim-no-colors\ndisable the colors in the shell.\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/quantizer/quantizer.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/quantizer/quantizer.rst",
"diff": "@@ -110,27 +110,27 @@ Set the number of bits used in the fixed-point representation.\n.. table:: Default values of the total number of bits for the different codes.\n:align: center\n- +----------------+-----------------+\n+ +--------------+-----------+\n| Code | Value |\n- +================+=================+\n+ +==============+===========+\n| ``LDPC`` | 6 |\n- +----------------+-----------------+\n+ +--------------+-----------+\n| ``POLAR`` | 6 |\n- +----------------+-----------------+\n+ +--------------+-----------+\n| ``REP`` | 6 |\n- +----------------+-----------------+\n+ +--------------+-----------+\n| ``RSC`` | 6 |\n- +----------------+-----------------+\n+ +--------------+-----------+\n| ``RSC_DB`` | 6 |\n- +----------------+-----------------+\n+ +--------------+-----------+\n+ | ``TPC`` | |bit_tpc| |\n+ +--------------+-----------+\n| ``TURBO`` | 6 |\n- +----------------+-----------------+\n+ +--------------+-----------+\n| ``TURBO_DB`` | 6 |\n- +----------------+-----------------+\n- | ``TURBO_PROD`` | |bit_turboprod| |\n- +----------------+-----------------+\n+ +--------------+-----------+\n-.. |bit_turboprod| replace:: 6 on 8-bit and 8 on 16-bit\n+.. |bit_tpc| replace:: 6 on 8-bit and 8 on 16-bit\n.. _qnt-qnt-dec:\n@@ -148,28 +148,28 @@ Set the position of the decimal point in the quantified representation.\n.. table:: Default values of the decimal point position for the different codes.\n:align: center\n- +----------------+-----------------+\n+ +--------------+---------------+\n| Code | Value |\n- +================+=================+\n+ +==============+===============+\n| ``LDPC`` | 2 |\n- +----------------+-----------------+\n+ +--------------+---------------+\n| ``POLAR`` | 1 |\n- +----------------+-----------------+\n+ +--------------+---------------+\n| ``REP`` | 2 |\n- +----------------+-----------------+\n- | ``RSC`` | |dec_RSC| |\n- +----------------+-----------------+\n- | ``RSC_DB`` | |dec_RSCDB| |\n- +----------------+-----------------+\n+ +--------------+---------------+\n+ | ``RSC`` | |dec_rsc| |\n+ +--------------+---------------+\n+ | ``RSC_DB`` | |dec_rscdb| |\n+ +--------------+---------------+\n+ | ``TPC`` | |dec_tpc| |\n+ +--------------+---------------+\n| ``TURBO`` | |dec_turbo| |\n- +----------------+-----------------+\n+ +--------------+---------------+\n| ``TURBO_DB`` | |dec_turbodb| |\n- +----------------+-----------------+\n- | ``TURBO_PROD`` | |dec_turboprod| |\n- +----------------+-----------------+\n+ +--------------+---------------+\n-.. |dec_RSC| replace:: 1 on 8-bit and 3 on 16-bit\n-.. |dec_RSCDB| replace:: 1 on 8-bit and 3 on 16-bit\n+.. |dec_rsc| replace:: 1 on 8-bit and 3 on 16-bit\n+.. |dec_rscdb| replace:: 1 on 8-bit and 3 on 16-bit\n+.. |dec_tpc| replace:: 2 on 8-bit and 3 on 16-bit\n.. |dec_turbo| replace:: 2 on 8-bit and 3 on 16-bit\n.. |dec_turbodb| replace:: 2 on 8-bit and 3 on 16-bit\n\\ No newline at end of file\n-.. |dec_turboprod| replace:: 2 on 8-bit and 3 on 16-bit\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "refs",
"new_path": "refs",
"diff": "-Subproject commit 650cfe93a4370573ddaa88ea692d54b54198d59f\n+Subproject commit 8fa85f6f037d24f2c7368a8fa13685a82e7b04f0\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Launcher/Launcher.cpp",
"new_path": "src/Factory/Launcher/Launcher.cpp",
"diff": "@@ -73,7 +73,7 @@ void factory::Launcher::parameters\nargs.add(\n{p+\"-cde-type\", \"C\"},\n- tools::Text(tools::Including_set(\"POLAR\", \"TURBO\", \"TURBO_DB\", \"TURBO_PROD\", \"LDPC\", \"REP\", \"RA\", \"RSC\", \"RSC_DB\", \"BCH\", \"UNCODED\", \"RS\")),\n+ tools::Text(tools::Including_set(\"POLAR\", \"TURBO\", \"TURBO_DB\", \"TPC\", \"LDPC\", \"REP\", \"RA\", \"RSC\", \"RSC_DB\", \"BCH\", \"UNCODED\", \"RS\")),\n\"select the code type you want to use.\",\ntools::arg_rank::REQ);\n@@ -326,7 +326,7 @@ launcher::Launcher* factory::Launcher::parameters\nif (this->sim_type == \"BFER\") return new launcher::Turbo_DB<launcher::BFER_std<B,R,Q>,B,R,Q>(argc, argv);\n}\n- if (this->cde_type == \"TURBO_PROD\")\n+ if (this->cde_type == \"TPC\")\n{\nif (this->sim_type == \"BFER\") return new launcher::Turbo_product<launcher::BFER_std<B,R,Q>,B,R,Q>(argc, argv);\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Encoder/Turbo_product/Encoder_turbo_product.cpp",
"new_path": "src/Factory/Module/Encoder/Turbo_product/Encoder_turbo_product.cpp",
"diff": "@@ -16,7 +16,7 @@ Encoder_turbo_product::parameters\nsub(new Encoder_BCH::parameters(prefix+\"-sub\")),\nitl(new Interleaver::parameters(\"itl\"))\n{\n- this->type = \"TURBO_PROD\";\n+ this->type = \"TPC\";\n}\nEncoder_turbo_product::parameters* Encoder_turbo_product::parameters\n@@ -72,7 +72,7 @@ void Encoder_turbo_product::parameters\nargs.erase({pi+\"-fra\", \"F\"});\n}\n- tools::add_options(args.at({p+\"-type\"}), 0, \"TURBO_PROD\");\n+ tools::add_options(args.at({p+\"-type\"}), 0, \"TPC\");\nargs.add(\n{p+\"-ext\"},\n@@ -143,7 +143,7 @@ module::Encoder_turbo_product<B>* Encoder_turbo_product::parameters\nmodule::Encoder_BCH<B> &enc_r,\nmodule::Encoder_BCH<B> &enc_c) const\n{\n- if (this->type == \"TURBO_PROD\") return new module::Encoder_turbo_product<B>(itl, enc_r, enc_c, n_frames);\n+ if (this->type == \"TPC\") return new module::Encoder_turbo_product<B>(itl, enc_r, enc_c, n_frames);\nthrow tools::cannot_allocate(__FILE__, __LINE__, __func__);\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/main.cpp",
"new_path": "src/main.cpp",
"diff": "@@ -127,7 +127,7 @@ void print_version()\nstd::string systemc = \"off\";\n#endif\n- std::cout << \"aff3ct (\" << os << prec << \", \" << compiler << \" \" << compiler_version << \", \"\n+ std::cout << \"aff3ct (\" << os << prec << \", \" << compiler << \"-\" << compiler_version << \", \"\n<< mipp::InstructionFullType << \") \" << affect_version << std::endl;\nstd::cout << \"Compilation options:\" << std::endl;\nstd::cout << \" * Precision: \" << precision << std::endl;\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Replace 'TURBO_PROD' by 'TPC'.
|
8,483 |
07.12.2018 15:11:53
| -3,600 |
06ca47acfe1256fe5b98e883e85229328d012ac5
|
Work on Histogram
Seperate dump options from the method call to independant method to set them.
Add a method to add a given amount of times a unique value to the histogram.
Modify consequently the histogram call in BFER launcher.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Simulation/BFER/BFER.cpp",
"new_path": "src/Simulation/BFER/BFER.cpp",
"diff": "@@ -245,7 +245,7 @@ void BFER<B,R,Q>\nmax = err_hist.get_hist_max();\nelse\nmax = params_BFER.mnt_er->err_hist;\n- err_hist.dump(file_err_hist, 0, max, 0, false, false, false, \"; \");\n+ err_hist.dump(file_err_hist, 0, max);\n}\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Algo/Histogram.hpp",
"new_path": "src/Tools/Algo/Histogram.hpp",
"diff": "@@ -98,13 +98,43 @@ public:\nn_values += size;\n}\n+ /*\n+ * Add a value 'd' 'weight' times in the histogram\n+ */\n+ inline void add_value(const R& d, size_t weight)\n+ {\n+ auto x = calibrate_val(d);\n+\n+ auto it = hist.find(x);\n+ if (it == hist.end())\n+ hist[x] = weight;\n+ else\n+ it->second += weight;\n+\n+ n_values += weight;\n+ }\n+\n+\n+ inline void norm_sum_to_1 (bool val) { _norm_sum_to_1 = val;} // to normalize the values to a cumulative integration to 1.\n+ inline void norm_minus_1 (bool val) { _norm_minus_1 = val;} // only when norm_sum_to_1 == true, dump (1-x)\n+ inline void cumul_vals (bool val) { _cumul_vals = val;} // accumulate values rung after rung as for a CDF\n+ inline void cumul_borders (bool val) { _cumul_borders = val;} // accumulate the values over the given range [hist_min, hist_max] on those border values\n+ inline void n_rung (unsigned val) { _n_rung = val;} // the number of values plotted on the abscissa in the asked range (if 0 then dump directly the values)\n+ inline void data_separator(const std::string& val) { _data_separator = val;} // tag used to separate x from y when dumping them\n+\n+ inline bool norm_sum_to_1 () const { return _norm_sum_to_1; }\n+ inline bool norm_minus_1 () const { return _norm_minus_1; }\n+ inline bool cumul_vals () const { return _cumul_vals; }\n+ inline bool cumul_borders () const { return _cumul_borders; }\n+ inline unsigned n_rung () const { return _n_rung; }\n+ inline const std::string& data_separator() const { return _data_separator;}\n+\n/*\n* call dump by setting the hist_min and hist_max values as, respectively, get_hist_min() and get_hist_max()\n*/\n- int dump(std::ofstream& hist_file, unsigned n_rung = 0, bool norm_sum_to_1 = false, bool cumul_vals = false,\n- bool cumul_borders = false, const std::string& data_separator = \"; \") const\n+ int dump(std::ofstream& hist_file) const\n{\n- return dump(hist_file, get_hist_min(), get_hist_max(), n_rung, norm_sum_to_1, cumul_vals, cumul_borders, data_separator);\n+ return dump(hist_file, get_hist_min(), get_hist_max());\n}\n/*\n@@ -112,24 +142,22 @@ public:\n* @hist_min is the left border of the dump\n* @hist_max is the right border of the dump\n* @n_rung is the number of values plotted on the abscissa in the asked range (if 0 then dump directly the values)\n- * @norm_sum_to_1 is to normalize the values to a cumulative integration to 1.\n-+ * @cumul_vals option accumulates values rung after rung as for a CDF\n- * @cumul_borders is to accumulate the values over the given range [hist_min, hist_max] on those border values\n- * @data_separator is the tag used to separate x from y when dumping them\n* @return 1 when there is an error in given limits\n*/\n- int dump(std::ofstream& hist_file, R hist_min, R hist_max, unsigned n_rung = 0, bool norm_sum_to_1 = false,\n- bool cumul_vals = false, bool cumul_borders = false, const std::string& data_separator = \"; \") const\n+ int dump(std::ofstream& hist_file, R hist_min, R hist_max) const\n{\nif (hist_min >= hist_max)\nreturn 1;\n- if (n_rung == 0)\n- return dump_all_values(hist_file, hist_min, hist_max, norm_sum_to_1, cumul_vals, cumul_borders, data_separator);\n+ if (n_rung() == 0)\n+ return dump_all_values(hist_file, hist_min, hist_max);\nelse\n- return dump_intervals (hist_file, hist_min, hist_max, n_rung, norm_sum_to_1, cumul_vals, cumul_borders, data_separator);\n+ return dump_intervals (hist_file, hist_min, hist_max);\n}\n+ /*\n+ * Reset histogram values but not the options.\n+ */\ninline void reset()\n{\nn_values = 0;\n@@ -176,13 +204,12 @@ public:\n}\nprivate:\n- int dump_all_values(std::ofstream& hist_file, R hist_min, R hist_max, bool norm_sum_to_1 = false,\n- bool cumul_vals = false, bool cumul_borders = false, const std::string& data_separator = \"; \") const\n+ int dump_all_values(std::ofstream& hist_file, R hist_min, R hist_max) const\n{\nR factor = 1;\n- if (norm_sum_to_1)\n+ if (norm_sum_to_1())\n{\n- factor = (R)1 /(R)n_values;\n+ factor = (R)1 /(R)get_n_values();\n}\nsize_t cumul = 0;\n@@ -190,56 +217,69 @@ private:\nauto cal_hist_min = calibrate_val(hist_min);\nauto cal_hist_max = calibrate_val(hist_max);\n+ R value;\nfor (auto it = hist.begin(); it != hist.end(); it++)\n{\nif ((it->first > cal_hist_min) && (cal_hist_max > it->first))\n{\n+ value = (R)cumul * factor;\n+ if (norm_sum_to_1() && norm_minus_1())\n+ value = (R)1 - value;\n+\nif (!dumped_hist_min)\n{ // then end of the cumul border on the left\n- hist_file << hist_min << data_separator << std::scientific << (R)cumul * factor << std::endl;\n+ hist_file << hist_min << data_separator() << std::scientific << value << std::endl;\ndumped_hist_min = true;\n}\n- if (cumul_vals)\n+ if (cumul_vals())\ncumul += it->second;\nelse\ncumul = it->second;\n- hist_file << uncalibrate_val(it->first) << data_separator << std::scientific << (R)cumul * factor << std::endl;\n+ value = (R)cumul * factor;\n+ if (norm_sum_to_1() && norm_minus_1())\n+ value = (R)1 - value;\n+\n+ hist_file << uncalibrate_val(it->first) << data_separator() << std::scientific << value << std::endl;\n}\n- else if (cumul_borders || it->first == cal_hist_min || it->first == cal_hist_max)\n+ else if (cumul_borders() || it->first == cal_hist_min || it->first == cal_hist_max)\n{\ncumul += it->second;\n}\n}\nif (cumul != 0) // then end of the cumul border on the right\n- hist_file << hist_max << data_separator << std::scientific << (R)cumul * factor << std::endl;\n+ {\n+ value = (R)cumul * factor;\n+ if (norm_sum_to_1() && norm_minus_1())\n+ value = (R)1 - value;\n+ hist_file << hist_max << data_separator() << std::scientific << value << std::endl;\n+ }\nreturn 0;\n}\n- int dump_intervals(std::ofstream& hist_file, R hist_min, R hist_max, unsigned n_rung, bool norm_sum_to_1 = false,\n- bool cumul_vals = false, bool cumul_borders = false, const std::string& data_separator = \"; \") const\n+ int dump_intervals(std::ofstream& hist_file, R hist_min, R hist_max) const\n{\nR factor = 1;\n- if (norm_sum_to_1)\n+ if (norm_sum_to_1())\n{\n- factor = (R)1 /(R)n_values;\n+ factor = (R)1 /(R)get_n_values();\n}\n- R dump_step = (R)n_rung / (hist_max - hist_min);\n- std::vector<size_t> dump_hist(n_rung + 1, 0);\n+ R dump_step = (R)n_rung() / (hist_max - hist_min);\n+ std::vector<size_t> dump_hist(n_rung() + 1, 0);\nfor (auto it = hist.begin(); it != hist.end(); it++)\n{\nauto x = (int)round((uncalibrate_val(it->first) - hist_min) * dump_step);\n- if (x >= 0 && x <= (int)n_rung)\n+ if (x >= 0 && x <= (int)n_rung())\n{\ndump_hist[x] += it->second;\n}\n- else if (cumul_borders)\n+ else if (cumul_borders())\n{\nif (x < 0)\ndump_hist.front() += it->second;\n@@ -251,18 +291,30 @@ private:\nR _dump_step = (R)1/dump_step;\nsize_t cumul = 0;\n- for (unsigned i = 0; i <= n_rung; ++i)\n+ for (unsigned i = 0; i <= n_rung(); ++i)\n{\n- if (cumul_vals)\n+ if (cumul_vals())\ncumul += dump_hist[i];\nelse\ncumul = dump_hist[i];\n- hist_file << ((R) i * _dump_step + hist_min) << data_separator << std::scientific\n- << (R) cumul * factor << std::endl;\n+ auto value = (R)cumul * factor;\n+ if (norm_sum_to_1() && norm_minus_1())\n+ value = (R)1 - value;\n+\n+ hist_file << ((R) i * _dump_step + hist_min) << data_separator() << std::scientific << value << std::endl;\n}\nreturn 0;\n}\n+\n+private:\n+ bool _norm_sum_to_1 = false;\n+ bool _norm_minus_1 = false;\n+ bool _cumul_vals = false;\n+ bool _cumul_borders = false;\n+ unsigned _n_rung = 0;\n+ std::string _data_separator = \"; \";\n+\n};\n}\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Work on Histogram
Seperate dump options from the method call to independant method to set them.
Add a method to add a given amount of times a unique value to the histogram.
Modify consequently the histogram call in BFER launcher.
|
8,490 |
08.12.2018 13:51:10
| -3,600 |
8f81d7c841b9cde4c793d0aa6f371e9c321016a2
|
Self-contain the doc strings in the binary.
|
[
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -8,7 +8,7 @@ project (aff3ct)\nif (NOT EXISTS \"${CMAKE_CURRENT_SOURCE_DIR}/.git\")\nmessage(FATAL_ERROR \"The '.git' folder can't be found, AFF3CT can't be compiled if it is not cloned \"\n- \"from a Git repository. Please do not download ZIP from GitHub and make a Git \"\n+ \"from a Git repository. Please do not download archives from GitHub and make a Git \"\n\"clone instead (git clone https://github.com/aff3ct/MIPP.git).\")\nendif()\n@@ -115,6 +115,21 @@ configure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/src/Tools/version.cpp.in\"\nlist(APPEND source_files \"${CMAKE_CURRENT_SOURCE_DIR}/src/Tools/version.cpp\")\n+# ---------------------------------------------------------------------------------------------------------------------\n+# ----------------------------------------------------------------------------------------------- GENERATE STRINGS FILE\n+# ---------------------------------------------------------------------------------------------------------------------\n+\n+file(READ doc/sphinx/strings.rst AFF3CT_STRINGS)\n+\n+string(REPLACE \"\\\"\" \"\\\\\\\"\" AFF3CT_STRINGS \"${AFF3CT_STRINGS}\")\n+string(REPLACE \"\\n\" \"\\\\n\" AFF3CT_STRINGS \"${AFF3CT_STRINGS}\")\n+\n+# Auto generate a file containing the doc strings\n+configure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/src/Factory/strings.cpp.in\"\n+ \"${CMAKE_CURRENT_SOURCE_DIR}/src/Factory/strings.cpp\" @ONLY)\n+\n+list(APPEND source_files \"${CMAKE_CURRENT_SOURCE_DIR}/src/Factory/strings.cpp\")\n+\n# ---------------------------------------------------------------------------------------------------------------------\n# ------------------------------------------------------------------------------------------------------ CREATE FILTERS\n# ---------------------------------------------------------------------------------------------------------------------\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Factory.cpp",
"new_path": "src/Factory/Factory.cpp",
"diff": "#include \"Tools/Exception/exception.hpp\"\n#include \"Factory.hpp\"\n+#include \"strings.cpp\"\nusing namespace aff3ct;\nusing namespace aff3ct::factory;\n@@ -19,8 +20,6 @@ const std::string aff3ct::factory::Factory_name = \"Factory\";\nconst std::string aff3ct::factory::Factory_short_name = \"Factory\";\nconst std::string aff3ct::factory::Factory_prefix = \"fac\";\n-std::string Filename = \"../doc/sphinx/strings.rst\";\n-bool Found_file = false;\nstd::map<std::string,std::string> Documentation;\ntools::Argument_tag extract_tags(const std::string &key, const std::string &prefix)\n@@ -55,15 +54,12 @@ tools::Argument_tag extract_tags(const std::string &key, const std::string &pref\nreturn tags;\n}\n-void read_external_doc(const std::string filename)\n+void parse_documentation()\n{\n- std::ifstream rst_file(filename);\n+ const auto lines = tools::split(Strings, '\\n');\n- if (rst_file.is_open())\n- {\n- Found_file = true;\nstd::string line, key, value;\n- while (std::getline(rst_file, line) && !rst_file.eof() && !rst_file.fail() && !rst_file.bad())\n+ for (auto line : lines)\n{\nif (line.find(\".. |\") == 0)\n{\n@@ -95,20 +91,13 @@ void read_external_doc(const std::string filename)\nif (key.length() && value.length())\nDocumentation[key] = value;\n}\n-}\n-std::string get_external_doc(const std::string &key)\n+std::string extract_doc(const std::string &key)\n{\n- if (Documentation.empty()) // then read the documentation...\n- read_external_doc(Filename);\n+ if (Documentation.empty()) parse_documentation();\nif (Documentation.find(key) == Documentation.end())\n- {\n- if (!Found_file)\n- return \"Can't read the '\" + Filename + \"' file.\";\n- else\nreturn \"This parameter is not documented\";\n- }\nelse\nreturn Documentation[key];\n}\n@@ -120,7 +109,7 @@ void aff3ct::factory::add_arg( tools::Argument_map_info &args,\nconst tools::arg_rank rank)\n{\nconst tools::Argument_tag tags = extract_tags(key, prefix);\n- const std::string doc = get_external_doc(key);\n+ const std::string doc = extract_doc(key);\nargs.add(tags, arg_t, doc, rank);\n}\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "src/Factory/strings.cpp",
"diff": "+#include <string>\n+\n+const std::string Strings = \".. ------------------------------------------------ factory Launcher parameters\\n\\n.. |factory::Launcher::parameters::p+cde-type,C| replace::\\n select the code type you want to use.\\n\\n.. |factory::Launcher::parameters::p+type| replace::\\n select the type of simulation to launch (default is BFER).\\n\\n.. |factory::Launcher::parameters::p+prec,p| replace::\\n the simulation precision in bits.\\n\\n.. |factory::Launcher::parameters::help,h| replace::\\n print this help.\\n\\n.. |factory::Launcher::parameters::Help,H| replace::\\n print this help with the advanced arguments.\\n\\n.. |factory::Launcher::parameters::version,v| replace::\\n print informations about the version of the code.\\n\\n.. |factory::Launcher::parameters::except-no-bt| replace::\\n do not print the backtrace when displaying exception.\\n\\n.. |factory::Launcher::parameters::except-a2l| replace::\\n enhance the backtrace when displaying exception by changing program\\n addresses into file names and lines (may take some seconds).\\n\\n.. |factory::Launcher::parameters::p+no-legend| replace::\\n do not display any legend when launching the simulation.\\n\\n.. |factory::Launcher::parameters::p+no-colors| replace::\\n disable the colors in the shell.\\n\\n.. ---------------------------------------------- factory Simulation parameters\\n\\n.. |factory::Simulation::parameters::p+meta| replace::\\n print the output with metadata, takes the simulation title.\\n\\n.. |factory::Simulation::parameters::p+stop-time| replace::\\n time in sec after what the current simulated noise stops (0 is infinite).\\n\\n.. |factory::Simulation::parameters::p+max-fra,n| replace::\\n maximum number of frames to play after what the current simulated noise stops\\n (0 is infinite).\\n\\n.. |factory::Simulation::parameters::p+crit-nostop| replace::\\n The stop criteria arguments -stop-time or -max-fra kill the current simulated\\n noise point but not the simulation.\\n\\n.. |factory::Simulation::parameters::p+dbg| replace::\\n enable debug mode: print array values after each step.\\n\\n.. |factory::Simulation::parameters::p+dbg-hex| replace::\\n debug mode prints values in the hexadecimal format.\\n\\n.. |factory::Simulation::parameters::p+dbg-prec| replace::\\n set the precision of real elements when displayed in debug mode.\\n\\n.. |factory::Simulation::parameters::p+dbg-limit,d| replace::\\n set the max number of elements to display in the debug mode.\\n\\n.. |factory::Simulation::parameters::p+dbg-fra| replace::\\n set the max number of frames to display in the debug mode.\\n\\n.. |factory::Simulation::parameters::p+stats| replace::\\n display statistics module by module.\\n\\n.. |factory::Simulation::parameters::p+threads,t| replace::\\n enable multi-threaded mode and specify the number of threads (0 means the\\n maximum supported by the core.\\n\\n.. |factory::Simulation::parameters::p+seed,S| replace::\\n seed used in the simulation to initialize the pseudo random generators in\\n general.\\n\\n.. |factory::Simulation::parameters::p+mpi-comm| replace::\\n MPI communication frequency between the nodes (in millisec).\\n\\n.. ---------------------------------------------------- factory BFER parameters\\n\\n.. |factory::BFER::parameters::p+coset,c| replace::\\n enable the coset approach.\\n\\n.. |factory::BFER::parameters::p+err-trk| replace::\\n enable the tracking of the bad frames (by default the frames are stored in\\n the current folder).\\n\\n.. |factory::BFER::parameters::p+err-trk-rev| replace::\\n automatically replay the saved frames.\\n\\n.. |factory::BFER::parameters::p+err-trk-path| replace::\\n base path for the files where the bad frames will be stored or read.\\n\\n.. |factory::BFER::parameters::p+err-trk-thold| replace::\\n dump only frames with a bit error count above or equal to this threshold.\\n\\n.. |factory::BFER::parameters::p+coded| replace::\\n enable the coded monitoring (extends the monitored bits to the entire\\n codeword).\\n\\n.. |factory::BFER::parameters::p+mutinfo| replace::\\n allow the computation of the mutual information.\\n\\n.. ------------------------------------------------ factory BFER_ite parameters\\n\\n.. |factory::BFER_ite::parameters::p+ite,I| replace::\\n number of global iterations between the demodulator and the decoder.\\n\\n.. |factory::BFER_ite::parameters::p+crc-start| replace::\\n iteration number to start the CRC checking in the turbo demodulation process.\\n\\n.. ------------------------------------------------ factory BFER_std parameters\\n\\n.. ---------------------------------------------------- factory EXIT parameters\\n\\n.. |factory::EXIT::parameters::p+siga-range| replace::\\n sigma range used in EXIT charts (Matlab style: \\\"0.5:2.5,2.55,2.6:0.05:3\\\"\\n with a default step of 0.1).\\n\\n.. |factory::EXIT::parameters::p+siga-min,a| replace::\\n sigma min value used in EXIT charts.\\n\\n.. |factory::EXIT::parameters::p+siga-max,A| replace::\\n sigma max value used in EXIT charts.\\n\\n.. |factory::EXIT::parameters::p+siga-step| replace::\\n sigma step value used in EXIT charts.\\n\\n.. ------------------------------------------------- factory Channel parameters\\n\\n.. |factory::Channel::parameters::p+fra-size,N| replace::\\n number of symbols by frame.\\n\\n.. |factory::Channel::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Channel::parameters::p+type| replace::\\n type of the channel to use in the simulation ('USER' has an output got from a\\n file when 'USER_ADD' has an additive noise got from a file, 'USER_BEC' and\\n 'USER_BSC' have their event draws from the file).\\n\\n.. |factory::Channel::parameters::p+implem| replace::\\n select the implementation of the algorithm to generate noise.\\n\\n.. |factory::Channel::parameters::p+path| replace::\\n path to a noisy file, to use with \\\"--chn-type USER or USER_ADD\\\" or to a\\n gain file (used with \\\"--chn-type RAYLEIGH_USER\\\").\\n\\n.. |factory::Channel::parameters::p+blk-fad| replace::\\n block fading policy for the RAYLEIGH channel.\\n\\n.. |factory::Channel::parameters::p+noise| replace::\\n noise value (for SIGMA, ROP or EP noise type).\\n\\n.. |factory::Channel::parameters::p+seed,S| replace::\\n seed used to initialize the pseudo random generators.\\n\\n.. |factory::Channel::parameters::p+add-users| replace::\\n add all the users (= frames) before generating the noise.\\n\\n.. |factory::Channel::parameters::p+complex| replace::\\n enable complex noise generation.\\n\\n.. |factory::Channel::parameters::p+gain-occur| replace::\\n the number of times a gain is used on consecutive symbols (used with\\n \\\"--chn-type RAYLEIGH_USER\\\").\\n\\n.. --------------------------------------------------- factory Codec parameters\\n\\n.. ----------------------------------------------- factory Codec_BCH parameters\\n\\n.. ---------------------------------------------- factory Codec_LDPC parameters\\n\\n.. --------------------------------------------- factory Codec_polar parameters\\n\\n.. ------------------------------------------------ factory Codec_RA parameters\\n\\n.. ---------------------------------------- factory Codec_repetition parameters\\n\\n.. ------------------------------------------------ factory Codec_RS parameters\\n\\n.. ----------------------------------------------- factory Codec_RSC parameters\\n\\n.. -------------------------------------------- factory Codec_RSC_DB parameters\\n\\n.. --------------------------------------------- factory Codec_turbo parameters\\n\\n.. ------------------------------------------ factory Codec_turbo_DB parameters\\n\\n.. ------------------------------------- factory Codec_turbo_product parameters\\n\\n.. ------------------------------------------- factory Codec_uncoded parameters\\n\\n.. --------------------------------------------------- factory Coset parameters\\n\\n.. |factory::Coset::parameters::p+size,N| replace::\\n coset size.\\n\\n.. |factory::Coset::parameters::p+type| replace::\\n coset type.\\n\\n.. |factory::Coset::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. ----------------------------------------------------- factory CRC parameters\\n\\n.. |factory::CRC::parameters::p+info-bits,K| replace::\\n number of generated bits (information bits, the CRC is not included).\\n\\n.. |factory::CRC::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::CRC::parameters::p+type,p+poly| replace::\\n select the CRC type/polynomial you want to use (ex: \\\"8-DVB-S2\\\": 0xD5,\\n \\\"16-IBM\\\": 0x8005, \\\"24-LTEA\\\": 0x864CFB, \\\"32-GZIP\\\": 0x04C11DB7).\\n\\n.. |factory::CRC::parameters::p+implem| replace::\\n select the CRC implementation you want to use.\\n\\n.. |factory::CRC::parameters::p+size| replace::\\n size of the CRC (divisor size in bit -1), required if you selected an unknown\\n CRC.\\n\\n.. ------------------------------------------------- factory Decoder parameters\\n\\n.. |factory::Decoder::parameters::p+cw-size,N| replace::\\n the codeword size.\\n\\n.. |factory::Decoder::parameters::p+info-bits,K| replace::\\n useful number of bit transmitted (information bits).\\n\\n.. |factory::Decoder::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Decoder::parameters::p+type,D| replace::\\n select the algorithm you want to decode the codeword.\\n\\n.. |factory::Decoder::parameters::p+implem| replace::\\n select the implementation of the algorithm to decode.\\n\\n.. |factory::Decoder::parameters::p+hamming| replace::\\n enable the computation of the Hamming distance instead of the Euclidean\\n distance in the ML/CHASE decoders.\\n\\n.. |factory::Decoder::parameters::p+flips| replace::\\n set the maximum number of flips in the CHASE decoder.\\n\\n.. --------------------------------------------- factory Decoder_BCH parameters\\n\\n.. |factory::Decoder_BCH::parameters::p+corr-pow,T| replace::\\n correction power of the BCH code.\\n\\n.. -------------------------------------------- factory Decoder_LDPC parameters\\n\\n.. |factory::Decoder_LDPC::parameters::p+h-path| replace::\\n path to the H matrix (AList or QC formated file).\\n\\n.. |factory::Decoder_LDPC::parameters::p+ite,i| replace::\\n maximal number of iterations in the LDPC decoder.\\n\\n.. |factory::Decoder_LDPC::parameters::p+off| replace::\\n offset used in the offset min-sum BP algorithm (works only with\\n \\\"--dec-implem NMS\\\").\\n\\n.. |factory::Decoder_LDPC::parameters::p+mwbf| replace::\\n factor used in the modified WBF algorithm (works only with\\n \\\"--dec-implem WBF\\\"). Set 0 for basic WBF.\\n\\n.. |factory::Decoder_LDPC::parameters::p+norm| replace::\\n normalization factor used in the normalized min-sum BP algorithm (works only\\n with \\\"--dec-implem NMS\\\").\\n\\n.. |factory::Decoder_LDPC::parameters::p+no-synd| replace::\\n disable the syndrome detection (disable the stop criterion in the LDPC\\n decoders).\\n\\n.. |factory::Decoder_LDPC::parameters::p+synd-depth| replace::\\n successive number of iterations to validate the syndrome detection.\\n\\n.. |factory::Decoder_LDPC::parameters::p+simd| replace::\\n the SIMD strategy you want to use.\\n\\n.. |factory::Decoder_LDPC::parameters::p+min| replace::\\n the MIN implementation for the nodes (AMS decoder).\\n\\n.. |factory::Decoder_LDPC::parameters::p+h-reorder| replace::\\n specify if the check nodes (CNs) from H have to be reordered, 'NONE': do\\n nothing (default), 'ASC': from the smallest to the biggest CNs, 'DSC': from\\n the biggest to the smallest CNs.\\n\\n.. ---------------------------------------------- factory Decoder_NO parameters\\n\\n.. ------------------------------------------- factory Decoder_polar parameters\\n\\n.. |factory::Decoder_polar::parameters::p+ite,i| replace::\\n maximal number of iterations in the SCAN decoder.\\n\\n.. |factory::Decoder_polar::parameters::p+lists,L| replace::\\n maximal number of paths in the SCL decoder.\\n\\n.. |factory::Decoder_polar::parameters::p+simd| replace::\\n the SIMD strategy you want to use.\\n\\n.. |factory::Decoder_polar::parameters::p+polar-nodes| replace::\\n the type of nodes you want to detect in the Polar tree (ex:\\n \\\"{R0,R1,R0L,REP_2-8,REPL,SPC_4+}\\\").\\n\\n.. |factory::Decoder_polar::parameters::p+partial-adaptive| replace::\\n enable the partial adaptive mode for the ASCL decoder (by default full\\n adaptive is selected).\\n\\n.. |factory::Decoder_polar::parameters::p+no-sys| replace::\\n does not suppose a systematic encoding.\\n\\n.. ---------------------------------------------- factory Decoder_RA parameters\\n\\n.. |factory::Decoder_RA::parameters::p+ite,i| replace::\\n maximal number of iterations in the decoder.\\n\\n.. -------------------------------------- factory Decoder_repetition parameters\\n\\n.. |factory::Decoder_repetition::parameters::p+no-buff| replace::\\n does not suppose a buffered encoding.\\n\\n.. ---------------------------------------------- factory Decoder_RS parameters\\n\\n.. |factory::Decoder_RS::parameters::p+corr-pow,T| replace::\\n correction power of the RS code.\\n\\n.. --------------------------------------------- factory Decoder_RSC parameters\\n\\n.. |factory::Decoder_RSC::parameters::p+simd| replace::\\n the SIMD strategy you want to use.\\n\\n.. |factory::Decoder_RSC::parameters::p+max| replace::\\n the MAX implementation for the nodes.\\n\\n.. |factory::Decoder_RSC::parameters::p+no-buff| replace::\\n does not suppose a buffered encoding.\\n\\n.. |factory::Decoder_RSC::parameters::p+poly| replace::\\n the polynomials describing RSC code, should be of the form \\\"{A,B}\\\".\\n\\n.. |factory::Decoder_RSC::parameters::p+std| replace::\\n select a standard and set automatically some parameters (overwritten with\\n user given arguments).\\n\\n.. ------------------------------------------ factory Decoder_RSC_DB parameters\\n\\n.. |factory::Decoder_RSC_DB::parameters::p+max| replace::\\n the MAX implementation for the nodes.\\n\\n.. |factory::Decoder_RSC_DB::parameters::p+no-buff| replace::\\n does not suppose a buffered encoding.\\n\\n.. ------------------------------------------- factory Decoder_turbo parameters\\n\\n.. |factory::Decoder_turbo::parameters::p+ite,i| replace::\\n maximal number of iterations in the turbo.\\n\\n.. |factory::Decoder_turbo::parameters::p+sc| replace::\\n enables the self corrected decoder (requires \\\"--crc-type\\\").\\n\\n.. |factory::Decoder_turbo::parameters::p+json| replace::\\n enable the json output trace.\\n\\n.. |factory::Decoder_turbo::parameters::p+crc-start| replace::\\n set the iteration to start the CRC checking.\\n\\n.. ---------------------------------------- factory Decoder_turbo_DB parameters\\n\\n.. |factory::Decoder_turbo_DB::parameters::p+ite,i| replace::\\n maximal number of iterations in the turbo.\\n\\n.. |factory::Decoder_turbo_DB::parameters::p+crc-start| replace::\\n set the iteration to start the CRC checking.\\n\\n.. ----------------------------------- factory Decoder_turbo_product parameters\\n\\n.. |factory::Decoder_turbo_product::parameters::p+ite,i| replace::\\n maximal number of iterations in the turbo.\\n\\n.. |factory::Decoder_turbo_product::parameters::p+alpha| replace::\\n weighting factor, one by half iteration (so twice more than number of\\n iterations). If not enough given values, then automatically extends the last\\n to all iterations.\\n\\n.. |factory::Decoder_turbo_product::parameters::p+beta| replace::\\n reliability factor, one by half iteration (so twice more than number of\\n iterations). If not enough given values, then automatically extends the last\\n to all iterations. If not given, then computes beta dynamically from the\\n least reliable position metrics.\\n\\n.. |factory::Decoder_turbo_product::parameters::p+p| replace::\\n number of least reliable positions.\\n\\n.. |factory::Decoder_turbo_product::parameters::p+t| replace::\\n number of test vectors (0 means equal to 2^p).\\n\\n.. |factory::Decoder_turbo_product::parameters::p+c| replace::\\n number of competitors (0 means equal to number of test vectors, 1 means only\\n the decided word).\\n\\n.. |factory::Decoder_turbo_product::parameters::p+ext| replace::\\n extends code with a parity bits.\\n\\n.. |factory::Decoder_turbo_product::parameters::p+cp-coef| replace::\\n the 5 Chase Pyndiah constant coefficients \\\"a,b,c,d,e\\\".\\n\\n.. ------------------------------------------------- factory Encoder parameters\\n\\n.. |factory::Encoder::parameters::p+info-bits,K| replace::\\n useful number of bit transmitted (information bits).\\n\\n.. |factory::Encoder::parameters::p+cw-size,N| replace::\\n the codeword size.\\n\\n.. |factory::Encoder::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Encoder::parameters::p+type| replace::\\n type of the encoder to use in the simulation.\\n\\n.. |factory::Encoder::parameters::p+path| replace::\\n path to a file containing one or a set of pre-computed codewords, to use with\\n \\\"--enc-type USER\\\".\\n\\n.. |factory::Encoder::parameters::p+start-idx| replace::\\n start idx to use in the USER type encoder.\\n\\n.. |factory::Encoder::parameters::p+seed,S| replace::\\n seed used to initialize the pseudo random generators.\\n\\n.. --------------------------------------------- factory Encoder_BCH parameters\\n\\n.. -------------------------------------------- factory Encoder_LDPC parameters\\n\\n.. |factory::Encoder_LDPC::parameters::p+h-path| replace::\\n path to the H matrix (AList formated file, required by the \\\"LDPC_H\\\" encoder).\\n\\n.. |factory::Encoder_LDPC::parameters::p+g-path| replace::\\n path to the G matrix (AList formated file, required by the \\\"LDPC\\\" encoder).\\n\\n.. |factory::Encoder_LDPC::parameters::p+h-reorder| replace::\\n specify if the check nodes (CNs) from H have to be reordered, 'NONE': do\\n nothing (default), 'ASC': from the smallest to the biggest CNs, 'DSC': from\\n the biggest to the smallest CNs.\\n\\n.. |factory::Encoder_LDPC::parameters::p+g-method| replace::\\n The method used to generate G from H when using 'LDPC_H' encoder type.\\n 'LU_DEC' method generates a hollow G thanks to the LU decomposition with a\\n guarantee to have the systematic identity (do not work with irregular\\n matrices) when the 'IDENTITY' method generate an identity on H to get the\\n parity part.\\n\\n.. |factory::Encoder_LDPC::parameters::p+g-save-path| replace::\\n path where the generated G matrix with the 'LDPC_H' encoder type will be\\n saved.\\n\\n.. ---------------------------------------------- factory Encoder_NO parameters\\n\\n.. |factory::Encoder_NO::parameters::p+info-bits,K| replace::\\n useful number of bit transmitted (information bits).\\n\\n.. |factory::Encoder_NO::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Encoder_NO::parameters::p+type| replace::\\n type of the encoder to use in the simulation.\\n\\n.. ------------------------------------------- factory Encoder_polar parameters\\n\\n.. |factory::Encoder_polar::parameters::p+no-sys| replace::\\n disable the systematic encoding.\\n\\n.. ---------------------------------------------- factory Encoder_RA parameters\\n\\n.. -------------------------------------- factory Encoder_repetition parameters\\n\\n.. |factory::Encoder_repetition::parameters::p+no-buff| replace::\\n disable the buffered encoding.\\n\\n.. ---------------------------------------------- factory Encoder_RS parameters\\n\\n.. --------------------------------------------- factory Encoder_RSC parameters\\n\\n.. |factory::Encoder_RSC::parameters::p+no-buff| replace::\\n disable the buffered encoding.\\n\\n.. |factory::Encoder_RSC::parameters::p+poly| replace::\\n the polynomials describing RSC code, should be of the form \\\"{A,B}\\\".\\n\\n.. |factory::Encoder_RSC::parameters::p+std| replace::\\n select a standard and set automatically some parameters (overwritten with\\n user given arguments).\\n\\n.. ------------------------------------------ factory Encoder_RSC_DB parameters\\n\\n.. |factory::Encoder_RSC_DB::parameters::p+std| replace::\\n select a standard and set automatically some parameters (overwritten with\\n user given arguments).\\n\\n.. |factory::Encoder_RSC_DB::parameters::p+no-buff| replace::\\n disable the buffered encoding.\\n\\n.. ------------------------------------------- factory Encoder_turbo parameters\\n\\n.. |factory::Encoder_turbo::parameters::p+json-path| replace::\\n path to store the encoder and decoder traces formated in JSON.\\n\\n.. ---------------------------------------- factory Encoder_turbo_DB parameters\\n\\n.. ----------------------------------- factory Encoder_turbo_product parameters\\n\\n.. |factory::Encoder_turbo_product::parameters::p+ext| replace::\\n extends code with a parity bits.\\n\\n.. --------------------------------------------- factory Interleaver parameters\\n\\n.. --------------------------------------------------- factory Modem parameters\\n\\n.. |factory::Modem::parameters::p+fra-size,N| replace::\\n number of symbols by frame.\\n\\n.. |factory::Modem::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Modem::parameters::p+type| replace::\\n type of the modulation to use in the simulation.\\n\\n.. |factory::Modem::parameters::p+implem| replace::\\n select the implementation of the modem.\\n\\n.. |factory::Modem::parameters::p+bps| replace::\\n select the number of bits per symbol (default is 1).\\n\\n.. |factory::Modem::parameters::p+const-path| replace::\\n path to the ordered modulation symbols (constellation), to use with\\n \\\"--mod-type USER\\\".\\n\\n.. |factory::Modem::parameters::p+cpm-std| replace::\\n the selection of a default CPM standard hardly implemented (any of those\\n parameters is overwritten if the argument is given by the user).\\n\\n.. |factory::Modem::parameters::p+cpm-L| replace::\\n CPM pulse width or CPM memory (default is 2).\\n\\n.. |factory::Modem::parameters::p+cpm-k| replace::\\n modulation index numerator (default is 1).\\n\\n.. |factory::Modem::parameters::p+cpm-p| replace::\\n modulation index denominator (default is 2).\\n\\n.. |factory::Modem::parameters::p+cpm-upf| replace::\\n select the symbol sampling factor (default is 1).\\n\\n.. |factory::Modem::parameters::p+cpm-map| replace::\\n symbols mapping layout (default is NATURAL).\\n\\n.. |factory::Modem::parameters::p+cpm-ws| replace::\\n wave shape (default is GMSK).\\n\\n.. |factory::Modem::parameters::p+max| replace::\\n select the type of the max operation to use in the demodulator.\\n\\n.. |factory::Modem::parameters::p+noise| replace::\\n noise variance value for the demodulator.\\n\\n.. |factory::Modem::parameters::p+no-sig2| replace::\\n turn off the division by sigma square in the demodulator.\\n\\n.. |factory::Modem::parameters::p+psi| replace::\\n select the type of the psi function to use in the SCMA demodulator.\\n\\n.. |factory::Modem::parameters::p+ite| replace::\\n number of iteration in the demodulator.\\n\\n.. |factory::Modem::parameters::p+rop-est| replace::\\n set the number of known bits for the ROP estimation in the OOK demodulator on\\n an optical channel (when 0, the ROP is known).\\n\\n.. ------------------------------------------------- factory Monitor parameters\\n\\n.. -------------------------------------------- factory Monitor_BFER parameters\\n\\n.. |factory::Monitor_BFER::parameters::p+info-bits,K| replace::\\n number of bits to check.\\n\\n.. |factory::Monitor_BFER::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Monitor_BFER::parameters::p+max-fe,e| replace::\\n max number of frame errors for each noise point simulation.\\n\\n.. |factory::Monitor_BFER::parameters::p+max-fra,n| replace::\\n maximum number of frames for each noise point simulation.\\n\\n.. |factory::Monitor_BFER::parameters::p+err-hist| replace::\\n activate the histogram of the number of errors per frame. Set the max number\\n of bit error per frame included in the histogram (0 is no limit).\\n\\n.. |factory::Monitor_BFER::parameters::p+err-hist-path| replace::\\n path to the output histogram (default is './hist', add automatically the\\n current noise value and the extension '.txt')\\n\\n.. -------------------------------------------- factory Monitor_EXIT parameters\\n\\n.. |factory::Monitor_EXIT::parameters::p+size,K| replace::\\n number of bits to check.\\n\\n.. |factory::Monitor_EXIT::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Monitor_EXIT::parameters::p+trials,n| replace::\\n number of frames to simulate per sigma A value.\\n\\n.. ---------------------------------------------- factory Monitor_MI parameters\\n\\n.. |factory::Monitor_MI::parameters::p+fra-size,N| replace::\\n the frame size for the mutual information computation.\\n\\n.. |factory::Monitor_MI::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Monitor_MI::parameters::p+trials,n| replace::\\n number of frames to simulate.\\n\\n.. ----------------------------------------------- factory Puncturer parameters\\n\\n.. |factory::Puncturer::parameters::p+info-bits,K| replace::\\n useful number of bit transmitted (information bits).\\n\\n.. |factory::Puncturer::parameters::p+fra-size,N| replace::\\n useful number of bit transmitted (information bits).\\n\\n.. |factory::Puncturer::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Puncturer::parameters::p+type| replace::\\n code puncturer type.\\n\\n.. ------------------------------------------ factory Puncturer_LDPC parameters\\n\\n.. |factory::Puncturer_LDPC::parameters::p+cw-size,N_cw| replace::\\n the codeword size.\\n\\n.. |factory::Puncturer_LDPC::parameters::p+pattern| replace::\\n puncturing pattern for the LDPC encoder/decoder (size = N_Code/Z)\\n (ex: \\\"1,1,1,0\\\").\\n\\n.. ----------------------------------------- factory Puncturer_polar parameters\\n\\n.. ----------------------------------------- factory Puncturer_turbo parameters\\n\\n.. |factory::Puncturer_turbo::parameters::p+pattern| replace::\\n puncturing pattern for the turbo encoder (ex: \\\"11,10,01\\\").\\n\\n.. |factory::Puncturer_turbo::parameters::p+tail-length| replace::\\n total number of tail bits at the end of the frame.\\n\\n.. |factory::Puncturer_turbo::parameters::p+no-buff| replace::\\n does not suppose a buffered encoding.\\n\\n.. -------------------------------------- factory Puncturer_turbo_DB parameters\\n\\n.. ----------------------------------------------- factory Quantizer parameters\\n\\n.. |factory::Quantizer::parameters::p+size,N| replace::\\n number of real to quantize.\\n\\n.. |factory::Quantizer::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Quantizer::parameters::p+type| replace::\\n type of the quantizer to use in the simulation.\\n\\n.. |factory::Quantizer::parameters::p+implem| replace::\\n select the implementation of quantizer.\\n\\n.. |factory::Quantizer::parameters::p+dec| replace::\\n the position of the fixed point in the quantified representation.\\n\\n.. |factory::Quantizer::parameters::p+bits| replace::\\n the number of bits used for the quantizer.\\n\\n.. |factory::Quantizer::parameters::p+range| replace::\\n the min/max bound for the tricky quantizer.\\n\\n.. -------------------------------------------------- factory Source parameters\\n\\n.. |factory::Source::parameters::p+info-bits,K| replace::\\n number of generated bits (information bits).\\n\\n.. |factory::Source::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Source::parameters::p+type| replace::\\n method used to generate the codewords.\\n\\n.. |factory::Source::parameters::p+implem| replace::\\n select the implementation of the algorithm to generate the information bits.\\n\\n.. |factory::Source::parameters::p+path| replace::\\n path to a file containing one or a set of pre-computed source bits, to use\\n with \\\"--src-type USER\\\".\\n\\n.. |factory::Source::parameters::p+start-idx| replace::\\n start idx to use in the USER type source.\\n\\n.. |factory::Source::parameters::p+seed,S| replace::\\n seed used to initialize the pseudo random generators.\\n\\n.. ------------------------------------ factory Frozenbits_generator parameters\\n\\n.. |factory::Frozenbits_generator::parameters::p+info-bits,K| replace::\\n useful number of bit transmitted (information bits).\\n\\n.. |factory::Frozenbits_generator::parameters::p+cw-size,N| replace::\\n the codeword size.\\n\\n.. |factory::Frozenbits_generator::parameters::p+sigma| replace::\\n sigma value for the polar codes generation (adaptive frozen bits if sigma is\\n not set).\\n\\n.. |factory::Frozenbits_generator::parameters::p+gen-method| replace::\\n select the frozen bits generation method.\\n\\n.. |factory::Frozenbits_generator::parameters::p+awgn-path| replace::\\n path to a file or a directory containing the best channels to use for\\n information bits.\\n\\n.. |factory::Frozenbits_generator::parameters::p+pb-path| replace::\\n path of the polar bounds code generator (generates best channels to use).\\n\\n.. ------------------------------------------ factory Flip_and_check parameters\\n\\n.. |factory::Flip_and_check::parameters::p+size| replace::\\n size (in bit) of the extrinsic for the fnc processing.\\n\\n.. |factory::Flip_and_check::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Flip_and_check::parameters::p+| replace::\\n enables the flip and check decoder (requires \\\"--crc-type\\\").\\n\\n.. |factory::Flip_and_check::parameters::p+q| replace::\\n set the search's space for the fnc algorithm.\\n\\n.. |factory::Flip_and_check::parameters::p+ite-m| replace::\\n set first iteration at which the fnc is used.\\n\\n.. |factory::Flip_and_check::parameters::p+ite-M| replace::\\n set last iteration at which the fnc is used.\\n\\n.. |factory::Flip_and_check::parameters::p+ite-s| replace::\\n set iteration step for the fnc algorithm.\\n\\n.. |factory::Flip_and_check::parameters::p+ite,i| replace::\\n maximal number of iterations in the turbo.\\n\\n.. |factory::Flip_and_check::parameters::p+crc-start| replace::\\n set the iteration to start the CRC checking.\\n\\n.. --------------------------------------- factory Flip_and_check_DB parameters\\n\\n.. ------------------------------------------ factory Scaling_factor parameters\\n\\n.. |factory::Scaling_factor::parameters::p+type| replace::\\n scaling factor type.\\n\\n.. |factory::Scaling_factor::parameters::p+ite| replace::\\n number of iterations.\\n\\n.. ------------------------------------------------ factory Terminal parameters\\n\\n.. |factory::Terminal::parameters::p+type| replace::\\n type of the terminal to use to display results.\\n\\n.. |factory::Terminal::parameters::p+no| replace::\\n disable reporting for each iteration.\\n\\n.. |factory::Terminal::parameters::p+freq| replace::\\n display frequency in ms (refresh time step for each iteration, 0 = disable\\n display refresh).\\n\\n.. ---------------------------------------- factory Interleaver_core parameters\\n\\n.. |factory::Interleaver_core::parameters::p+size| replace::\\n number of symbols to interleave.\\n\\n.. |factory::Interleaver_core::parameters::p+fra,F| replace::\\n set the number of inter frame level to process.\\n\\n.. |factory::Interleaver_core::parameters::p+type| replace::\\n type of the interleaver to use in the simulation.\\n\\n.. |factory::Interleaver_core::parameters::p+path| replace::\\n specify the path to the interleaver file (to use with \\\"--itl-type USER\\\").\\n\\n.. |factory::Interleaver_core::parameters::p+cols| replace::\\n specify the number of columns used for the RAND_COL, ROW_COL or COL_ROW\\n interleaver.\\n\\n.. |factory::Interleaver_core::parameters::p+uni| replace::\\n enable the regeneration of the interleaver at each new frame.\\n\\n.. |factory::Interleaver_core::parameters::p+seed,S| replace::\\n seed used to initialize the pseudo random generators.\\n\\n.. |factory::Interleaver_core::parameters::p+read-order| replace::\\n read order of the COL_ROW and ROW_COL interleavers.\\n\\n.. --------------------------------------------------- factory Noise parameters\\n\\n.. |factory::Noise::parameters::p+noise-range,R| replace::\\n noise energy range to run (Matlab style: \\\"0.5:2.5,2.55,2.6:0.05:3\\\" with a\\n default step of 0.1).\\n\\n.. |factory::Noise::parameters::p+noise-min,m| replace::\\n minimal noise energy to simulate.\\n\\n.. |factory::Noise::parameters::p+noise-max,M| replace::\\n maximal noise energy to simulate.\\n\\n.. |factory::Noise::parameters::p+noise-step,s| replace::\\n noise energy step between each simulation iteration.\\n\\n.. |factory::Noise::parameters::p+pdf-path| replace::\\n A file that contains PDF for different SNR. Set the SNR range from the given\\n ones. Overwritten by -R or limited by -m and -M with a minimum step of -s.\\n\\n.. |factory::Noise::parameters::p+noise-type,E| replace::\\n select the type of NOISE: SNR per Symbol / SNR per information Bit /\\n Received Optical Power / Erasure Probability.\";\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "src/Factory/strings.cpp.in",
"diff": "+#include <string>\n+\n+const std::string Strings = \"@AFF3CT_STRINGS@\";\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Self-contain the doc strings in the binary.
|
8,490 |
08.12.2018 14:59:42
| -3,600 |
44167d0512a4bd4d3fde6a73f15b7ef491ddb68c
|
Sanitize the doc values + fix warning.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Factory.cpp",
"new_path": "src/Factory/Factory.cpp",
"diff": "#include <sstream>\n#include <fstream>\n#include <vector>\n+#include <regex>\n#include <map>\n#include \"Tools/Display/rang_format/rang_format.h\"\n@@ -47,13 +48,32 @@ tools::Argument_tag extract_tags(const std::string &key, const std::string &pref\nthrow tools::runtime_error(__FILE__, __LINE__, __func__, message.str());\n}\n- for (auto t = 0; t < tags.size(); t++)\n+ for (size_t t = 0; t < tags.size(); t++)\nif (tags[t].size() != 0 && tags[t][tags[t].size()-1] == '-')\ntags[t].pop_back();\nreturn tags;\n}\n+std::string sanitize(const std::string &value)\n+{\n+ std::string new_value = value;\n+\n+ std::regex e_pipe(\"\\\\|([^ ]*)\\\\|\");\n+ new_value = std::regex_replace (new_value,e_pipe,\"$1\");\n+\n+ std::regex e_quote(\"`([^ ]*)`\");\n+ new_value = std::regex_replace (new_value,e_quote,\"$1\");\n+\n+ std::regex e_start2(\"\\\\*\\\\*([^ ]*)\\\\*\\\\*\");\n+ new_value = std::regex_replace (new_value,e_start2,\"$1\");\n+\n+ std::regex e_start1(\"\\\\*([^ ]*)\\\\*\");\n+ new_value = std::regex_replace (new_value,e_start1,\"$1\");\n+\n+ return new_value;\n+}\n+\nvoid parse_documentation()\n{\nconst auto lines = tools::split(Strings, '\\n');\n@@ -64,7 +84,7 @@ void parse_documentation()\nif (line.find(\".. |\") == 0)\n{\nif (key.length() && value.length())\n- Documentation[key] = value;\n+ Documentation[key] = sanitize(value);\nvalue.clear();\n@@ -89,7 +109,7 @@ void parse_documentation()\n}\nif (key.length() && value.length())\n- Documentation[key] = value;\n+ Documentation[key] = sanitize(value);\n}\nstd::string extract_doc(const std::string &key)\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Sanitize the doc values + fix warning.
|
8,490 |
09.12.2018 13:13:26
| -3,600 |
8312e04ea8c7df9661d2aa4f81873d1149249c9f
|
Disable the external strings only on MSVC instead of for all the Windows compilers.
|
[
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -33,10 +33,10 @@ else()\nset (AFF3CT_BACKTRACE OFF)\nendif()\n-if (NOT (WIN32 OR APPLE))\n- option (AFF3CT_EXT_STRINGS \"Enable external strings for the help documentation\" ON)\n-else()\n+if (MSVC)\nset (AFF3CT_EXT_STRINGS ON)\n+else()\n+ option (AFF3CT_EXT_STRINGS \"Enable external strings for the help documentation\" ON)\nendif()\nset(AFF3CT_PREC \"MULTI\" CACHE STRING \"Select the precision in bits (can be '8', '16', '32', '64' or 'MULTI')\")\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/installation/compilation/compilation.rst",
"new_path": "doc/sphinx/source/user/installation/compilation/compilation.rst",
"diff": "@@ -284,7 +284,7 @@ this feature and provides the following options:\n.. |cmake-opt-ext_strings| replace:: Enable external strings for the help\ndocumentation. If ``ON`` the help doc will be parsed from the ``strings.rst``\nexternal file. If ``OFF`` the strings will be self-contained in the binary.\n- On Windows this option is not available and automatically set to ``ON``.\n+ On |MSVC| this option is not available and automatically set to ``ON``.\n.. |cmake-opt-prec| replace:: Select the precision in bits (can be '8', '16',\n'32', '64' or 'MULTI').\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Disable the external strings only on MSVC instead of for all the Windows compilers.
|
8,490 |
09.12.2018 13:20:58
| -3,600 |
4b6d2a6f926b01c7391a3c989df4eca10c05853a
|
Fix AFF3CT_EXT_STRINGS macro usage.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Factory.cpp",
"new_path": "src/Factory/Factory.cpp",
"diff": "#include \"Tools/Exception/exception.hpp\"\n#include \"Factory.hpp\"\n-#ifdef AFF3CT_EXT_STRINGS\n+#ifndef AFF3CT_EXT_STRINGS\n#include \"strings.cpp\"\n#endif\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/strings.cpp.in",
"new_path": "src/Factory/strings.cpp.in",
"diff": "-#ifdef AFF3CT_EXT_STRINGS\n+#ifndef AFF3CT_EXT_STRINGS\n#include <string>\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix AFF3CT_EXT_STRINGS macro usage.
|
8,490 |
09.12.2018 13:27:49
| -3,600 |
636bd8e3b65bf8eb83e1279a3547043493e72271
|
Fix the CMake.
|
[
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -125,7 +125,7 @@ list(APPEND source_files \"${CMAKE_CURRENT_SOURCE_DIR}/src/Tools/version.cpp\")\n# ----------------------------------------------------------------------------------------------- GENERATE STRINGS FILE\n# ---------------------------------------------------------------------------------------------------------------------\n-if (AFF3CT_EXT_STRINGS)\n+if (NOT AFF3CT_EXT_STRINGS)\nfile(READ doc/sphinx/strings.rst AFF3CT_STRINGS)\nstring(REPLACE \"\\\"\" \"\\\\\\\"\" AFF3CT_STRINGS \"${AFF3CT_STRINGS}\")\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix the CMake.
|
8,483 |
10.12.2018 08:49:02
| -3,600 |
23665740cd81329604657dc21ff3255f8c98bc06
|
Work on gallager B to have a majority vote in each var node
|
[
{
"change_type": "MODIFY",
"old_path": "src/Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_B.cpp",
"new_path": "src/Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_B.cpp",
"diff": "@@ -181,10 +181,10 @@ void Decoder_LDPC_BP_flooding_Gallager_B<B,R>\n{\nauto count = 0;\nfor (auto cc = 0; cc < var_degree; cc++)\n- if (cc != c && chk_to_var_ptr[cc] != cur_state)\n- count++;\n+ if (cc != c)\n+ count += chk_to_var_ptr[cc] ? 1 : -1;\n- cur_state = count == (var_degree -1) ? !cur_state : cur_state;\n+ cur_state = count > 0 ? 1 : (count < 0 ? 0 : cur_state);\n}\nvar_to_chk_ptr[c] = (int8_t)cur_state;\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Work on gallager B to have a majority vote in each var node
|
8,490 |
10.12.2018 17:35:27
| -3,600 |
f0b3f8f8eddb873a270d8939788628e0a2a7fdaa
|
Add a new cmd line parameter to display the keys in the help.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/other/other.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/other/other.rst",
"diff": "-.. _global-other-parameters:\n+.. _other-other-parameters:\nOther parameters\n----------------\n-.. _global-help:\n+.. _other-help:\n``--help, -h``\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n@@ -39,7 +39,7 @@ The latter change in function of the selected simulation type and code.\n--version, -v\nprint informations about the version of the code.\n-.. _global-advanced-help:\n+.. _other-advanced-help:\n``--Help, -H``\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n@@ -53,6 +53,7 @@ Print the help with in more the advanced ``{A}`` arguments.\naff3ct -H\n.. code-block:: console\n+ :emphasize-lines: 8,9,18,19,22,23\nUsage: ./bin/aff3ct -C <text> [optional args...]\n@@ -75,10 +76,62 @@ Print the help with in more the advanced ``{A}`` arguments.\ndo not print the backtrace when displaying exception.\n--help, -h\nprint this help.\n+ {A} --keys, -k\n+ display the parameter keys in the help.\n--version, -v\nprint informations about the version of the code.\n-.. _global-version:\n+.. _other-keys:\n+\n+``--keys, -k``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+**STRING**: |factory::Launcher::parameters::keys,k|\n+\n+.. code-block:: bash\n+\n+ aff3ct -H -k\n+\n+.. code-block:: console\n+ :emphasize-lines: 5,8,11,14,17,22,25,28,31,34\n+\n+ Usage: ./bin/aff3ct -C <text> [optional args...]\n+\n+ Simulation parameter(s):\n+ {R} --sim-cde-type, -C <text:including set={BCH|LDPC|POLAR|RA|REP|RS|RSC|RSC_DB|TPC|TURBO|TURBO_DB|UNCODED}>\n+ [factory::Launcher::parameters::p+cde-type,C]\n+ select the code type you want to use.\n+ --sim-no-colors\n+ [factory::Launcher::parameters::p+no-colors]\n+ disable the colors in the shell.\n+ {A} --sim-no-legend\n+ [factory::Launcher::parameters::p+no-legend]\n+ do not display any legend when launching the simulation.\n+ --sim-prec, -p <integer:including set={8|16|32|64}>\n+ [factory::Launcher::parameters::p+prec,p]\n+ the simulation precision in bits.\n+ --sim-type <text:including set={BFER|BFERI|EXIT}>\n+ [factory::Launcher::parameters::p+type]\n+ select the type of simulation to launch (default is BFER).\n+\n+ Other parameter(s):\n+ --Help, -H\n+ [factory::Launcher::parameters::Help,H]\n+ print this help with the advanced arguments.\n+ {A} --except-no-bt\n+ [factory::Launcher::parameters::except-no-bt]\n+ do not print the backtrace when displaying exception.\n+ --help, -h\n+ [factory::Launcher::parameters::help,h]\n+ print this help.\n+ {A} --keys, -k\n+ [factory::Launcher::parameters::keys,k]\n+ display the parameter keys in the help.\n+ --version, -v\n+ [factory::Launcher::parameters::version,v]\n+ print informations about the version of the code.\n+\n+.. _other-version:\n``--version, -v``\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n@@ -98,7 +151,7 @@ Print informations about the version of the source code and compilation options.\nThis is free software; see the source for copying conditions. There is NO\nwarranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n-.. _global-except-a2l:\n+.. _other-except-a2l:\n``--except-a2l`` |image_advanced_argument|\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n@@ -112,7 +165,7 @@ addresses into filenames and lines. It may take some seconds to do this work.\n:ref:`compiled <compilation_compiler_options>` with debug symbols\n(``-g`` compile flag) and **without** ``NDEBUG`` macro (``-DNDEBUG`` flag).\n-.. _global-except-no-bt:\n+.. _other-except-no-bt:\n``--except-no-bt`` |image_advanced_argument|\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/strings.rst",
"new_path": "doc/sphinx/strings.rst",
"diff": ".. |factory::Launcher::parameters::p+no-colors| replace::\ndisable the colors in the shell.\n+.. |factory::Launcher::parameters::keys,k| replace::\n+ display the parameter keys in the help.\n+\n.. ---------------------------------------------- factory Simulation parameters\n.. |factory::Simulation::parameters::p+meta| replace::\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Launcher/Launcher.cpp",
"new_path": "src/Factory/Launcher/Launcher.cpp",
"diff": "@@ -168,6 +168,10 @@ void factory::Launcher::parameters\ntools::add_arg(args, p, class_name+\"p+no-colors\",\ntools::None());\n#endif\n+\n+ tools::add_arg(args, p, class_name+\"keys,k\",\n+ tools::None(),\n+ tools::arg_rank::ADV);\n}\nvoid factory::Launcher::parameters\n@@ -178,6 +182,7 @@ void factory::Launcher::parameters\nif(vals.exist({p+\"-cde-type\", \"C\"})) this->cde_type = vals.at({p+\"-cde-type\", \"C\"}); // required\nif(vals.exist({p+\"-type\" })) this->sim_type = vals.at({p+\"-type\" });\nif(vals.exist({\"version\", \"v\"})) this->display_version = true;\n+ if(vals.exist({\"keys\", \"k\"})) this->display_keys = true;\nif(vals.exist({p+\"-no-legend\" })) this->display_legend = false;\nif(vals.exist({\"help\", \"h\"}))\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Launcher/Launcher.hpp",
"new_path": "src/Factory/Launcher/Launcher.hpp",
"diff": "@@ -35,6 +35,7 @@ struct Launcher : public Factory\nbool display_adv_help = false;\nbool display_version = false;\nbool display_legend = true;\n+ bool display_keys = false;\n// ---------------------------------------------------------------------------------------------------- METHODS\nexplicit parameters(const std::string &p = Launcher_prefix);\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Launcher/Launcher.cpp",
"new_path": "src/Launcher/Launcher.cpp",
"diff": "@@ -70,6 +70,7 @@ int Launcher::read_arguments()\ntry\n{\nthis->store_args();\n+ ah.set_help_display_keys(params_common.display_keys);\n}\ncatch(const std::exception& e)\n{\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Argument_handler.cpp",
"new_path": "src/Tools/Arguments/Argument_handler.cpp",
"diff": "@@ -12,7 +12,7 @@ using namespace aff3ct::tools;\nArgument_handler\n::Argument_handler(const int argc, const char** argv, std::ostream& help_os)\n-: help_os(help_os)\n+: help_os(help_os), help_display_keys(false)\n{\nif (argc <= 0)\n{\n@@ -34,6 +34,12 @@ Argument_handler\n{\n}\n+void Argument_handler\n+::set_help_display_keys(const bool display)\n+{\n+ this->help_display_keys = display;\n+}\n+\nbool Argument_handler\n::is_linked(const Argument_map_info &args, const Argument_map_value& arg_v, const Argument_tag &tag) const\n{\n@@ -289,8 +295,11 @@ void Argument_handler\nif (info.type->get_title().size())\nhelp_os << rang::fg::gray << \" <\" << info.type->get_title() << \">\" << rang::style::reset;\n-\nhelp_os << std::endl;\n+\n+ if (this->help_display_keys)\n+ help_os << rang::fg::gray << tab + \" \" << \"[\" << info.key << \"]\" << rang::style::reset << std::endl;\n+\nauto splitted_doc = split_doc(info.doc, tab + \" \", 80);\nhelp_os << splitted_doc << std::endl;\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Argument_handler.hpp",
"new_path": "src/Tools/Arguments/Argument_handler.hpp",
"diff": "@@ -33,6 +33,7 @@ private:\nstd::vector<std::string> command; /*!< The argument list from the command line \"char** argv\". */\nstd::string m_program_name; /*!< Program binary name. */\nstd::ostream& help_os; /*!< The output stream on which will be displayed the help */\n+ bool help_display_keys; /*!< Display the argument keys in the help */\npublic:\n/*!\n@@ -63,6 +64,8 @@ public:\nArgument_map_value parse_arguments(const Argument_map_info &args,\nstd::vector<std::string> &warnings, std::vector<std::string> &errors);\n+ void set_help_display_keys(const bool display);\n+\n/*!\n* \\brief Checks if the values from the command line respect the criteria given by required_args and optional_args.\n*\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Maps/Argument_info.cpp",
"new_path": "src/Tools/Arguments/Maps/Argument_info.cpp",
"diff": "@@ -8,8 +8,8 @@ Argument_info\n{ }\nArgument_info\n-::Argument_info(Argument_type* type, const std::string& doc, const arg_rank rank)\n-: type(type), doc(doc), rank(rank)\n+::Argument_info(Argument_type* type, const std::string& doc, const arg_rank rank, const std::string key)\n+: type(type), doc(doc), rank(rank), key(key)\n{}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Maps/Argument_info.hpp",
"new_path": "src/Tools/Arguments/Maps/Argument_info.hpp",
"diff": "@@ -15,7 +15,8 @@ enum class arg_rank : uint8_t {OPT, REQ, ADV};\nstruct Argument_info\n{\nArgument_info();\n- Argument_info(Argument_type* type, const std::string& doc, const arg_rank rank = arg_rank::OPT);\n+ Argument_info(Argument_type* type, const std::string& doc, const arg_rank rank = arg_rank::OPT,\n+ const std::string key = \"\");\nvirtual ~Argument_info();\n@@ -30,6 +31,7 @@ struct Argument_info\nArgument_type* type = nullptr;\nstd::string doc = \"\";\narg_rank rank = arg_rank::OPT;\n+ std::string key = \"\";\n};\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Maps/Argument_map_info.cpp",
"new_path": "src/Tools/Arguments/Maps/Argument_map_info.cpp",
"diff": "@@ -29,7 +29,8 @@ Argument_map_info& Argument_map_info\n}\nvoid Argument_map_info\n-::add(const Argument_tag& tags, Argument_type* arg_t, const std::string& doc, const arg_rank rank)\n+::add(const Argument_tag& tags, Argument_type* arg_t, const std::string& doc, const arg_rank rank,\n+ const std::string key)\n{\nif (tags.size() == 0)\nthrow std::invalid_argument(\"No tag has been given ('tag.size()' == 0).\");\n@@ -40,7 +41,7 @@ void Argument_map_info\nif (exist(tags))\nerase(tags);\n- (*this)[tags] = new Argument_info(arg_t, doc, rank);\n+ (*this)[tags] = new Argument_info(arg_t, doc, rank, key);\n}\nvoid Argument_map_info\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Maps/Argument_map_info.hpp",
"new_path": "src/Tools/Arguments/Maps/Argument_map_info.hpp",
"diff": "@@ -32,7 +32,7 @@ public:\nArgument_map_info& operator=(const Argument_map_info& other);\nvoid add(const Argument_tag& tags, Argument_type* arg_t, const std::string& doc,\n- const arg_rank rank = arg_rank::OPT);\n+ const arg_rank rank = arg_rank::OPT, const std::string key = \"\");\nvoid add_link(const Argument_tag& tag1, const Argument_tag& tag2, bool (*callback)(const void*, const void*) = nullptr);\nbool has_link(const Argument_tag& tag) const;\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Documentation/documentation.cpp",
"new_path": "src/Tools/Documentation/documentation.cpp",
"diff": "@@ -242,5 +242,5 @@ void aff3ct::tools::add_arg(Argument_map_info &args, const std::string &prefix,\n{\nconst Argument_tag tags = extract_tags(key, prefix);\nconst std::string doc = extract_documentation(key);\n- args.add(tags, arg_t, doc, rank);\n+ args.add(tags, arg_t, doc, rank, key);\n}\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "src/main.cpp",
"new_path": "src/main.cpp",
"diff": "@@ -168,6 +168,7 @@ int read_arguments(const int argc, const char** argv, factory::Launcher::paramet\ntry\n{\nparams.store(arg_vals);\n+ ah.set_help_display_keys(params.display_keys);\n}\ncatch(std::exception&)\n{\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add a new cmd line parameter to display the keys in the help.
|
8,490 |
10.12.2018 22:39:56
| -3,600 |
9967d90214a6c411ebdf25b6d9d09f2ad7e909f8
|
Improve the regex to clean the rst code in the help.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Tools/Documentation/documentation.cpp",
"new_path": "src/Tools/Documentation/documentation.cpp",
"diff": "@@ -65,17 +65,20 @@ std::string sanitize(const std::string &value)\n// trick to compile on the GNU compiler version 4 (where 'std::regex' is unavailable)\n#if !(!defined(__clang__) && !defined(__llvm__) && defined(__GNUC__) && defined(__cplusplus) && __GNUC__ < 5)\n- std::regex e_pipe(\"\\\\|([^ ]*)\\\\|\");\n- new_value = std::regex_replace (new_value,e_pipe,\"$1\");\n+ std::vector<std::regex> regexes;\n- std::regex e_quote(\"`([^ ]*)`\");\n- new_value = std::regex_replace (new_value,e_quote,\"$1\");\n+ new_value = std::regex_replace(new_value, std::regex(\"``([^``]*)``\"), \"'$1'\");\n+ new_value = std::regex_replace(new_value, std::regex(\"`([^`]*)`_\"), \"$1\");\n+ new_value = std::regex_replace(new_value, std::regex(\":math:`([^ ]*)`\"), \";;$1;;\");\n- std::regex e_start2(\"\\\\*\\\\*([^ ]*)\\\\*\\\\*\");\n- new_value = std::regex_replace (new_value,e_start2,\"$1\");\n+ regexes.push_back(std::regex(\"\\\\|([^ ]*)\\\\|\"));\n+ regexes.push_back(std::regex(\"`([^`]*)`\"));\n+ regexes.push_back(std::regex(\"\\\\*\\\\*([^\\\\*\\\\*]*)\\\\*\\\\*\"));\n+ regexes.push_back(std::regex(\"\\\\*([^\\\\*]*)\\\\*\"));\n+ for (auto &re : regexes)\n+ new_value = std::regex_replace(new_value, re, \"$1\");\n- std::regex e_start1(\"\\\\*([^ ]*)\\\\*\");\n- new_value = std::regex_replace (new_value,e_start1,\"$1\");\n+ new_value = std::regex_replace(new_value, std::regex(\";;([^;;]*);;\"),\"`$1`\");\n#endif\nreturn new_value;\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Improve the regex to clean the rst code in the help.
|
8,490 |
11.12.2018 09:57:40
| -3,600 |
a98deca8e395963d5208feb01f347c4d53bbb8dd
|
CI: fix 'strings.rst' path.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/deploy-builds-linux.sh",
"new_path": "ci/deploy-builds-linux.sh",
"diff": "@@ -73,7 +73,7 @@ do\nrm -rf $BUILD/share/aff3ct/refs/readers\nmkdir $BUILD/share/aff3ct/doc\nmkdir $BUILD/share/aff3ct/doc/strings\n- cp doc/sphinx/strings.rst $BUILD/share/aff3ct/doc/\n+ cp doc/sphinx/strings.rst $BUILD/share/aff3ct/doc/strings\n# prepare doc\nmkdir $BUILD/share/aff3ct/doc\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: fix 'strings.rst' path.
|
8,490 |
11.12.2018 13:14:30
| -3,600 |
5f3dec6b3cebd956893f290e3a4bfce328ff0bf0
|
Doc: improve the other params doc.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/other/other.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/other/other.rst",
"diff": "@@ -76,6 +76,34 @@ Other parameters\n--version, -v\nprint informations about the version of the code.\n+.. _other-version:\n+\n+``--version, -v``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+|factory::Launcher::parameters::version,v|\n+\n+.. code-block:: bash\n+\n+ aff3ct -v\n+\n+.. code-block:: console\n+\n+ aff3ct (Linux 64-bit, g++-8.1, AVX2) v2.1.1\n+ Compilation options:\n+ * Precision: 8/16/32/64-bit\n+ * Polar bit packing: on\n+ * Terminal colors: on\n+ * Backtrace: on\n+ * External strings: on\n+ * MPI: off\n+ * GSL: off\n+ * MKL: off\n+ * SystemC: off\n+ Copyright (c) 2016-2018 - MIT license.\n+ This is free software; see the source for copying conditions. There is NO\n+ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n+\n.. _other-keys:\n``--keys, -k`` |image_advanced_argument|\n@@ -126,24 +154,6 @@ Other parameters\n[factory::Launcher::parameters::version,v]\nprint informations about the version of the code.\n-.. _other-version:\n-\n-``--version, -v``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n-|factory::Launcher::parameters::version,v|\n-\n-.. code-block:: bash\n-\n- aff3ct -v\n-\n-.. code-block:: console\n-\n- aff3ct (Linux 64-bit, g++ 8.1, AVX2) v2.0.0-112-gc74ce62\n- Copyright (c) 2016-2018 - MIT license.\n- This is free software; see the source for copying conditions. There is NO\n- warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n-\n.. _other-except-a2l:\n``--except-a2l`` |image_advanced_argument|\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: improve the other params doc.
|
8,490 |
11.12.2018 13:15:32
| -3,600 |
a9d5da2a6bd148d4e6672f64b26d5fb7ee6b9343
|
Rework the builds and install package.
|
[
{
"change_type": "MODIFY",
"old_path": ".gitlab-ci.yml",
"new_path": ".gitlab-ci.yml",
"diff": "@@ -564,6 +564,7 @@ deploy-builds-linux:\n- source ./ci/tools/git-date.sh\n- source ./ci/tools/git-message.sh\n- source ./ci/tools/git-author.sh\n+ - source ./ci/tools/git-version.sh\n- ./ci/deploy-builds-linux.sh build_linux_gcc_x64_sse4.2 build_linux_gcc_x64_avx2 build_windows_gcc_x86_sse4.2 build_windows_gcc_x64_avx2 build_macos_clang_x64_sse4.2\npages:\n"
},
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -289,19 +289,19 @@ add_library (aff3ct-obj OBJECT ${source_files})\n# Binary\nif (AFF3CT_COMPILE_EXE)\nadd_executable (aff3ct-bin $<TARGET_OBJECTS:aff3ct-obj>)\n- set_target_properties (aff3ct-bin PROPERTIES OUTPUT_NAME aff3ct)\n+ set_target_properties (aff3ct-bin PROPERTIES OUTPUT_NAME aff3ct-${GIT_VERSION_RMV})\nmessage(STATUS \"AFF3CT - Compile: executable\")\nendif (AFF3CT_COMPILE_EXE)\n# Library\nif (AFF3CT_COMPILE_SHARED_LIB)\nadd_library (aff3ct-shared-lib SHARED $<TARGET_OBJECTS:aff3ct-obj>)\n- set_target_properties (aff3ct-shared-lib PROPERTIES OUTPUT_NAME aff3ct)\n+ set_target_properties (aff3ct-shared-lib PROPERTIES OUTPUT_NAME aff3ct-${GIT_VERSION_RMV})\nmessage(STATUS \"AFF3CT - Compile: shared library\")\nendif (AFF3CT_COMPILE_SHARED_LIB)\nif (AFF3CT_COMPILE_STATIC_LIB)\nadd_library (aff3ct-static-lib STATIC $<TARGET_OBJECTS:aff3ct-obj>)\n- set_target_properties (aff3ct-static-lib PROPERTIES OUTPUT_NAME aff3ct)\n+ set_target_properties (aff3ct-static-lib PROPERTIES OUTPUT_NAME aff3ct-${GIT_VERSION_RMV})\nmessage(STATUS \"AFF3CT - Compile: static library\")\nendif (AFF3CT_COMPILE_STATIC_LIB)\n@@ -427,9 +427,9 @@ endif()\n# Auto generate cmake config files to link with AFF3CT library (only if an AFF3CT library has been compiled)\nif (AFF3CT_COMPILE_STATIC_LIB OR AFF3CT_COMPILE_SHARED_LIB)\nconfigure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/aff3ct-config.cmake.in\"\n- \"lib/cmake/aff3ct-config.cmake\" @ONLY)\n+ \"lib/cmake/aff3ct-${GIT_VERSION_RMV}/aff3ct-config.cmake\" @ONLY)\nconfigure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/aff3ct-config-version.cmake.in\"\n- \"lib/cmake/aff3ct-config-version.cmake\" @ONLY)\n+ \"lib/cmake/aff3ct-${GIT_VERSION_RMV}/aff3ct-config-version.cmake\" @ONLY)\nendif()\n# ---------------------------------------------------------------------------------------------------------------------\n@@ -437,20 +437,19 @@ endif()\n# ---------------------------------------------------------------------------------------------------------------------\nif (AFF3CT_COMPILE_EXE)\n- install(TARGETS aff3ct-bin RUNTIME DESTINATION bin/aff3ct-${GIT_VERSION_RMV})\n+ install(TARGETS aff3ct-bin RUNTIME DESTINATION bin/)\nendif()\nif (AFF3CT_COMPILE_SHARED_LIB)\n- install(TARGETS aff3ct-shared-lib LIBRARY DESTINATION lib/aff3ct-${GIT_VERSION_RMV})\n+ install(TARGETS aff3ct-shared-lib LIBRARY DESTINATION lib/)\nendif()\nif (AFF3CT_COMPILE_STATIC_LIB)\n- install(TARGETS aff3ct-static-lib ARCHIVE DESTINATION lib/aff3ct-${GIT_VERSION_RMV})\n+ install(TARGETS aff3ct-static-lib ARCHIVE DESTINATION lib/)\nendif()\nif (AFF3CT_COMPILE_SHARED_LIB OR AFF3CT_COMPILE_STATIC_LIB)\nset(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)\n- install(FILES \"${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/cmake/aff3ct-config.cmake\"\n- \"${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/cmake/aff3ct-config-version.cmake\"\n- DESTINATION lib/cmake/aff3ct-${GIT_VERSION_RMV})\n+ install(DIRECTORY \"${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/cmake/aff3ct-${GIT_VERSION_RMV}\"\n+ DESTINATION lib/cmake/)\nendif()\nif (AFF3CT_EXT_STRINGS)\n"
},
{
"change_type": "MODIFY",
"old_path": "ci/deploy-builds-linux.sh",
"new_path": "ci/deploy-builds-linux.sh",
"diff": "@@ -37,6 +37,12 @@ then\nexit 1\nfi\n+if [ -z \"$GIT_VERSION\" ]\n+then\n+ echo \"Please define the 'GIT_VERSION' environment variable.\"\n+ exit 1\n+fi\n+\nREPO_WEB=aff3ct.github.io\nREPO_RESSOURCES=ressources\ngit clone git@github.com:aff3ct/${REPO_WEB}.git\n@@ -63,23 +69,27 @@ do\nmkdir $BUILD/include/rang\ncp lib/rang/include/rang.hpp $BUILD/include/rang/\n+ mv $BUILD/include $BUILD/aff3ct-$GIT_VERSION\n+ mkdir $BUILD/include\n+ mv $BUILD/aff3ct-$GIT_VERSION $BUILD/include/\n+\n# prepare conf and refs files\nmkdir $BUILD/share\n- mkdir $BUILD/share/aff3ct\n- cp -r conf $BUILD/share/aff3ct/\n- cp -r refs $BUILD/share/aff3ct/\n- rm -rf $BUILD/share/aff3ct/conf/.git\n- rm -rf $BUILD/share/aff3ct/refs/.git\n- rm -rf $BUILD/share/aff3ct/refs/readers\n- mkdir $BUILD/share/aff3ct/doc\n- mkdir $BUILD/share/aff3ct/doc/strings\n- cp doc/sphinx/strings.rst $BUILD/share/aff3ct/doc/strings\n+ mkdir $BUILD/share/aff3ct-$GIT_VERSION\n+ cp -r conf $BUILD/share/aff3ct-$GIT_VERSION/\n+ cp -r refs $BUILD/share/aff3ct-$GIT_VERSION/\n+ rm -rf $BUILD/share/aff3ct-$GIT_VERSION/conf/.git\n+ rm -rf $BUILD/share/aff3ct-$GIT_VERSION/refs/.git\n+ rm -rf $BUILD/share/aff3ct-$GIT_VERSION/refs/readers\n+ mkdir $BUILD/share/aff3ct-$GIT_VERSION/doc\n+ mkdir $BUILD/share/aff3ct-$GIT_VERSION/doc/strings\n+ cp doc/sphinx/strings.rst $BUILD/share/aff3ct-$GIT_VERSION/doc/strings\n# prepare doc\n- mkdir $BUILD/share/aff3ct/doc\n- cp -r doc/sphinx/build/html $BUILD/share/aff3ct/doc/\n- mkdir $BUILD/share/aff3ct/doc/pdf\n- cp doc/sphinx/build/latex/AFF3CT.pdf $BUILD/share/aff3ct/doc/pdf\n+ mkdir $BUILD/share/aff3ct-$GIT_VERSION/doc\n+ cp -r doc/sphinx/build/html $BUILD/share/aff3ct-$GIT_VERSION/doc/\n+ mkdir $BUILD/share/aff3ct-$GIT_VERSION/doc/pdf\n+ cp doc/sphinx/build/latex/AFF3CT.pdf $BUILD/share/aff3ct-$GIT_VERSION/doc/pdf\nzip -r $ZIP_NAME $BUILD\n"
},
{
"change_type": "MODIFY",
"old_path": "ci/deploy-sonarqube-linux.sh",
"new_path": "ci/deploy-sonarqube-linux.sh",
"diff": "@@ -20,10 +20,10 @@ then\nfi\n# Create the sonar config file on the fly\n-GIT_VERSION=$(echo $GIT_TAG | cut -d $'v' -f2-)\n+GIT_SHORT_TAG=$(echo $GIT_TAG | cut -d $'v' -f2-)\necho \"sonar.projectKey=storm:aff3ct:gitlab:$GIT_BRANCH\" > sonar-project.properties\n#echo \"sonar.projectName=AFF3CT\" >> sonar-project.properties\n-echo \"sonar.projectVersion=$GIT_VERSION\" >> sonar-project.properties\n+echo \"sonar.projectVersion=$GIT_SHORT_TAG\" >> sonar-project.properties\necho \"sonar.login=$SONARQUBE_TOKEN\" >> sonar-project.properties\necho \"sonar.sources=./src/\" >> sonar-project.properties\necho \"sonar.exclusions=**/date.h, **/dirent.h\" >> sonar-project.properties\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "ci/tools/git-version.sh",
"diff": "+#!/bin/bash\n+# set -x\n+\n+GIT_VERSION=$(git describe)\n+\n+if [ ! -z \"$GIT_VERSION\" ]\n+then\n+ GIT_VERSION=$(echo $GIT_VERSION | cut -d $'v' -f2-)\n+ export GIT_VERSION\n+fi\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Rework the builds and install package.
|
8,490 |
11.12.2018 13:27:40
| -3,600 |
7f88798d06bb735aa91a3c57568050f4b10db953
|
Doc: update the package detail.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/installation/installation/installation.rst",
"new_path": "doc/sphinx/source/user/installation/installation/installation.rst",
"diff": "@@ -56,7 +56,7 @@ The installed package is organized as follow:\n* ``bin/``\n- - ``aff3ct-M.m.p/`` contains the |AFF3CT| executable binary.\n+ - ``aff3ct-M.m.p`` the |AFF3CT| executable binary.\n* ``include/``\n@@ -64,7 +64,8 @@ The installed package is organized as follow:\n* ``lib/``\n- - ``aff3ct-M.m.p/`` contains the |AFF3CT| library.\n+ - ``libaff3ct-M.m.p.a`` the |AFF3CT| static library.\n+ - ``libaff3ct-M.m.p.so`` the |AFF3CT| shared library.\n- ``cmake/``\n* ``aff3ct-M.m.p/`` contains the CMake configuration files required to link with |AFF3CT|.\n@@ -75,6 +76,7 @@ The installed package is organized as follow:\n* ``conf/`` contains some input files to configure the |AFF3CT| simulator.\n* ``refs/`` many results from |AFF3CT| simulations.\n+ * ``doc/`` contains the |AFF3CT| documentation.\n``M`` stands for the major number of the version, ``m`` the minor number and\n``p`` the id of the last patch.\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: update the package detail.
|
8,490 |
11.12.2018 13:36:30
| -3,600 |
9fcc11ddc930a536d4b1707e688d4de4b28da2f7
|
Adapt the cmake-config file.
|
[
{
"change_type": "MODIFY",
"old_path": "cmake/Modules/aff3ct-config.cmake.in",
"new_path": "cmake/Modules/aff3ct-config.cmake.in",
"diff": "@@ -37,8 +37,11 @@ if (MSVC)\nlist(INSERT AFF3CT_INCLUDE_DIRS 0 \"${AFF3CT_INCLUDE_ROOT}/dirent\")\nendif()\n-set(AFF3CT_LIBRARIES_ROOT \"@CMAKE_INSTALL_PREFIX@/lib/aff3ct-@GIT_VERSION_MAJOR@.@GIT_VERSION_MINOR@.@GIT_VERSION_PATCH@@GIT_TAIL@\")\n-find_library (AFF3CT_LIBRARY NAMES libaff3ct.a aff3ct.lib aff3ct PATHS ${AFF3CT_LIBRARIES_ROOT})\n+set(AFF3CT_LIBRARIES_ROOT \"@CMAKE_INSTALL_PREFIX@/lib\")\n+find_library (AFF3CT_LIBRARY NAMES libaff3ct-@GIT_VERSION_MAJOR@.@GIT_VERSION_MINOR@.@GIT_VERSION_PATCH@@GIT_TAIL@.a\n+ aff3ct-@GIT_VERSION_MAJOR@.@GIT_VERSION_MINOR@.@GIT_VERSION_PATCH@@GIT_TAIL@.lib\n+ aff3ct-@GIT_VERSION_MAJOR@.@GIT_VERSION_MINOR@.@GIT_VERSION_PATCH@@GIT_TAIL@\n+ PATHS ${AFF3CT_LIBRARIES_ROOT})\nif (AFF3CT_SYSTEMC_MODULE) # need to link with SystemC first\nlist(INSERT AFF3CT_LIBRARIES 1 \"${AFF3CT_LIBRARY}\")\nelse()\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Adapt the cmake-config file.
|
8,490 |
11.12.2018 14:38:19
| -3,600 |
b99cfcdbcfc84bb697b1329f7a13c73a145db333
|
CI: try to fix bad aff3ct binary name.
|
[
{
"change_type": "MODIFY",
"old_path": ".gitlab-ci.yml",
"new_path": ".gitlab-ci.yml",
"diff": "@@ -345,7 +345,8 @@ test-regression-bch:\n- test-regression-results-bch/\nscript:\n- source ./ci/tools/threads.sh\n- - ./ci/test-regression.py --refs-path refs/BCH --results-path test-regression-results-bch --build-path build_linux_gcc_x64_sse4.2 --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\n+ - source ./ci/tools/git-version.sh\n+ - ./ci/test-regression.py --refs-path refs/BCH --results-path test-regression-results-bch --build-path build_linux_gcc_x64_sse4.2 --binary-path bin/aff3ct-$GIT_VERSION --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\ntest-regression-ldpc:\nstage: test\n@@ -366,7 +367,8 @@ test-regression-ldpc:\n- test-regression-results-ldpc/\nscript:\n- source ./ci/tools/threads.sh\n- - ./ci/test-regression.py --refs-path refs/LDPC --results-path test-regression-results-ldpc --build-path build_linux_gcc_x64_sse4.2 --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\n+ - source ./ci/tools/git-version.sh\n+ - ./ci/test-regression.py --refs-path refs/LDPC --results-path test-regression-results-ldpc --build-path build_linux_gcc_x64_sse4.2 --binary-path bin/aff3ct-$GIT_VERSION --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\ntest-regression-polar:\nstage: test\n@@ -387,7 +389,8 @@ test-regression-polar:\n- test-regression-results-polar/\nscript:\n- source ./ci/tools/threads.sh\n- - ./ci/test-regression.py --refs-path refs/POLAR --results-path test-regression-results-polar --build-path build_linux_gcc_x64_sse4.2 --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\n+ - source ./ci/tools/git-version.sh\n+ - ./ci/test-regression.py --refs-path refs/POLAR --results-path test-regression-results-polar --build-path build_linux_gcc_x64_sse4.2 --binary-path bin/aff3ct-$GIT_VERSION --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\ntest-regression-rs:\nstage: test\n@@ -407,7 +410,8 @@ test-regression-rs:\n- test-regression-results-rs/\nscript:\n- source ./ci/tools/threads.sh\n- - ./ci/test-regression.py --refs-path refs/RS --results-path test-regression-results-rs --build-path build_linux_gcc_x64_sse4.2 --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\n+ - source ./ci/tools/git-version.sh\n+ - ./ci/test-regression.py --refs-path refs/RS --results-path test-regression-results-rs --build-path build_linux_gcc_x64_sse4.2 --binary-path bin/aff3ct-$GIT_VERSION --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\ntest-regression-turbo:\nstage: test\n@@ -428,7 +432,8 @@ test-regression-turbo:\n- test-regression-results-turbo/\nscript:\n- source ./ci/tools/threads.sh\n- - ./ci/test-regression.py --refs-path refs/TURBO --results-path test-regression-results-turbo --build-path build_linux_gcc_x64_sse4.2 --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\n+ - source ./ci/tools/git-version.sh\n+ - ./ci/test-regression.py --refs-path refs/TURBO --results-path test-regression-results-turbo --build-path build_linux_gcc_x64_sse4.2 --binary-path bin/aff3ct-$GIT_VERSION --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\ntest-regression-turbo-db:\nstage: test\n@@ -449,7 +454,8 @@ test-regression-turbo-db:\n- test-regression-results-turbo-db/\nscript:\n- source ./ci/tools/threads.sh\n- - ./ci/test-regression.py --refs-path refs/TURBO_DB --results-path test-regression-results-turbo-db --build-path build_linux_gcc_x64_sse4.2 --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\n+ - source ./ci/tools/git-version.sh\n+ - ./ci/test-regression.py --refs-path refs/TURBO_DB --results-path test-regression-results-turbo-db --build-path build_linux_gcc_x64_sse4.2 --binary-path bin/aff3ct-$GIT_VERSION --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\ntest-regression-turbo-prod:\nstage: test\n@@ -470,7 +476,8 @@ test-regression-turbo-prod:\n- test-regression-results-turbo-prod/\nscript:\n- source ./ci/tools/threads.sh\n- - ./ci/test-regression.py --refs-path refs/TURBO_PROD --results-path test-regression-results-turbo-prod --build-path build_linux_gcc_x64_sse4.2 --max-snr-time 30 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\n+ - source ./ci/tools/git-version.sh\n+ - ./ci/test-regression.py --refs-path refs/TURBO_PROD --results-path test-regression-results-turbo-prod --build-path build_linux_gcc_x64_sse4.2 --binary-path bin/aff3ct-$GIT_VERSION --max-snr-time 30 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\ntest-regression-uncoded:\nstage: test\n@@ -490,7 +497,8 @@ test-regression-uncoded:\n- test-regression-results-uncoded/\nscript:\n- source ./ci/tools/threads.sh\n- - ./ci/test-regression.py --refs-path refs/UNCODED --results-path test-regression-results-uncoded --build-path build_linux_gcc_x64_sse4.2 --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\n+ - source ./ci/tools/git-version.sh\n+ - ./ci/test-regression.py --refs-path refs/UNCODED --results-path test-regression-results-uncoded --build-path build_linux_gcc_x64_sse4.2 --binary-path bin/aff3ct-$GIT_VERSION --max-snr-time 5 --sensibility 2.5 --weak-rate 0.9 --verbose 1 --n-threads $THREADS\ntest-build-coverage-regression:\nstage: test\n@@ -507,6 +515,7 @@ test-build-coverage-regression:\n- code_coverage_files/\nscript:\n- source ./ci/tools/threads.sh\n+ - source ./ci/tools/git-version.sh\n- ./ci/test-build-coverage-regression.sh\ncoverage-linux:\n"
},
{
"change_type": "MODIFY",
"old_path": "ci/test-build-coverage-regression.sh",
"new_path": "ci/test-build-coverage-regression.sh",
"diff": "@@ -27,7 +27,7 @@ function gen_coverage_info\nlocal folder=$2\nfor path in $folder/*\ndo [ -f $path ] && {\n- cmd=$(awk -F \"=\" '/command/ {print $2}' $path)\n+ cmd=$(awk -F \"=\" '/command/ {print $2}' $path | tr 'bin/aff3ct' 'bin/aff3ct-$GIT_VERSION')\necho $cmd\nci=$(awk -F \"=\" '/ci/ {print $2}' $path)\nif [ \"$ci\" != \"off\" ]; then\n"
},
{
"change_type": "MODIFY",
"old_path": "ci/test-regression.py",
"new_path": "ci/test-regression.py",
"diff": "@@ -26,6 +26,7 @@ parser = argparse.ArgumentParser(prog='aff3ct-test-regression', formatter_class=\nparser.add_argument('--refs-path', action='store', dest='refsPath', type=str, default=\"refs\", help='Path to the references to re-simulate.')\nparser.add_argument('--results-path', action='store', dest='resultsPath', type=str, default=\"test-regression-results\", help='Path to the simulated results.')\nparser.add_argument('--build-path', action='store', dest='buildPath', type=str, default=\"build\", help='Path to the AFF3CT build.')\n+parser.add_argument('--binary-path', action='store', dest='binaryPath', type=str, default=\"bin/aff3ct\", help='Path to the AFF3CT binary.')\nparser.add_argument('--start-id', action='store', dest='startId', type=int, default=1, help='Starting id to avoid computing results one again.') # choices=xrange(1, +inf)\nparser.add_argument('--sensibility', action='store', dest='sensibility', type=float, default=1.0, help='Sensibility on the difference between new vs ref to verify a noise point.') # choices=xrange(1.0, +inf)\nparser.add_argument('--n-threads', action='store', dest='nThreads', type=int, default=0, help='Number of threads to use in the simulation (0 = all available).') # choices=xrange(0, +ing)\n@@ -293,6 +294,7 @@ print('# Parameters:')\nprint('# refs path =', args.refsPath )\nprint('# results path =', args.resultsPath )\nprint('# build path =', args.buildPath )\n+print('# binary path =', args.binaryPath )\nprint('# start id =', args.startId )\nprint('# sensibility =', args.sensibility )\nprint('# n threads =', args.nThreads )\n@@ -363,11 +365,10 @@ for fn in fileNames:\nnIgnored += 1\ncontinue\n-\n-\n# get the command line to run\nargsAFFECT = argsAFFECTcommand[:] # hard copy\nargsAFFECT += simuRef.getSplitCommand()\n+ argsAFFECT[len(argsAFFECTcommand)] = args.binaryPath;\nargsAFFECT += [\"--ter-freq\", \"0\", \"-t\", str(args.nThreads), \"--sim-meta\", simuRef.getMetadata(\"title\")]\nif args.maxFE:\nargsAFFECT += [\"-e\", str(args.maxFE)]\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: try to fix bad aff3ct binary name.
|
8,490 |
11.12.2018 15:43:43
| -3,600 |
ea441d3130613e2fb1996a5476875fe1cf10dfe0
|
CI: same as previous commit.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/build-linux-macos.sh",
"new_path": "ci/build-linux-macos.sh",
"diff": "@@ -46,8 +46,8 @@ make -j $THREADS -k\nrc=$?; if [[ $rc != 0 ]]; then exit $rc; fi\nmkdir $NAME $NAME/bin $NAME/lib $NAME/include $NAME/include/aff3ct\n-cp bin/aff3ct $NAME/bin/aff3ct\n-cp lib/libaff3ct.a $NAME/lib/libaff3ct.a\n+cp bin/aff3ct* $NAME/bin/\n+cp lib/libaff3ct*.a $NAME/lib/\ncp -r ../src/* $NAME/include/aff3ct/\nfind $NAME/include/aff3ct/ -type f -follow -print | grep \"[.]cpp$\" | xargs rm -f\nfind $NAME/include/aff3ct/ -type f -follow -print | grep \"[.]cpp.in$\" | xargs rm -f\n"
},
{
"change_type": "MODIFY",
"old_path": "ci/build-windows-gcc.bat",
"new_path": "ci/build-windows-gcc.bat",
"diff": "@@ -13,8 +13,8 @@ mkdir %NAME%\\lib\\\nmkdir %NAME%\\include\\\nmkdir %NAME%\\include\\aff3ct\\\n- copy bin\\aff3ct.exe %NAME%\\bin\\aff3ct.exe\n- copy lib\\libaff3ct.a %NAME%\\lib\\aff3ct.lib\n-xcopy ..\\src\\* %NAME%\\include\\aff3ct\\ /s /e\n+ copy bin\\aff3ct*.exe %NAME%\\bin\\aff3ct.exe\n+ copy lib\\libaff3ct*.a %NAME%\\lib\\aff3ct.lib\n+xcopy ..\\src\\* %NAME%\\include\\aff3ct\\ /s /e > nul\nmove %NAME% ..\\\n"
},
{
"change_type": "MODIFY",
"old_path": "ci/build-windows-msvc.bat",
"new_path": "ci/build-windows-msvc.bat",
"diff": "@@ -17,8 +17,8 @@ mkdir %NAME%\\lib\\\nmkdir %NAME%\\include\\\nmkdir %NAME%\\include\\aff3ct\\\n- copy bin\\Release\\aff3ct.exe %NAME%\\bin\\\n- copy lib\\Release\\aff3ct.lib %NAME%\\lib\\\n-xcopy ..\\src\\* %NAME%\\include\\aff3ct\\ /s /e\n+ copy bin\\Release\\aff3ct*.exe %NAME%\\bin\\\n+ copy lib\\Release\\aff3ct*.lib %NAME%\\lib\\\n+xcopy ..\\src\\* %NAME%\\include\\aff3ct\\ /s /e > nul\nmove %NAME% ..\\\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: same as previous commit.
|
8,490 |
11.12.2018 16:26:08
| -3,600 |
95fbdd5b63ba0cc65e5baf41ffa3d673d2e58ae7
|
Fix 'strings.cpp' warnings.
|
[
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -128,6 +128,7 @@ list(APPEND source_files \"${CMAKE_CURRENT_SOURCE_DIR}/src/Tools/version.cpp\")\nif (NOT AFF3CT_EXT_STRINGS)\nfile(READ doc/sphinx/strings.rst AFF3CT_STRINGS)\n+ string(REPLACE \"\\\\\" \"\\\\\\\\\" AFF3CT_STRINGS \"${AFF3CT_STRINGS}\")\nstring(REPLACE \"\\\"\" \"\\\\\\\"\" AFF3CT_STRINGS \"${AFF3CT_STRINGS}\")\nstring(REPLACE \"\\n\" \"\\\\n\" AFF3CT_STRINGS \"${AFF3CT_STRINGS}\")\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix 'strings.cpp' warnings.
|
8,490 |
11.12.2018 16:39:46
| -3,600 |
9876533dc1fe20f068bacd017193a3be7daf3b13
|
CI: fix coverage script.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/test-build-coverage-regression.sh",
"new_path": "ci/test-build-coverage-regression.sh",
"diff": "@@ -27,7 +27,8 @@ function gen_coverage_info\nlocal folder=$2\nfor path in $folder/*\ndo [ -f $path ] && {\n- cmd=$(awk -F \"=\" '/command/ {print $2}' $path | tr 'bin/aff3ct' 'bin/aff3ct-$GIT_VERSION')\n+ cmd=$(awk -F \"=\" '/command/ {print $2}' $path)\n+ cmd=$(echo \"${cmd/aff3ct/aff3ct-$GIT_VERSION}\")\necho $cmd\nci=$(awk -F \"=\" '/ci/ {print $2}' $path)\nif [ \"$ci\" != \"off\" ]; then\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: fix coverage script.
|
8,490 |
11.12.2018 20:09:01
| -3,600 |
d2fa8c5f074e73ac3140569a32f5eb118c0c68ac
|
CI: fix binary and lib names for the Windows builds.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/build-windows-gcc.bat",
"new_path": "ci/build-windows-gcc.bat",
"diff": "@@ -13,8 +13,8 @@ mkdir %NAME%\\lib\\\nmkdir %NAME%\\include\\\nmkdir %NAME%\\include\\aff3ct\\\n- copy bin\\aff3ct*.exe %NAME%\\bin\\aff3ct.exe\n- copy lib\\libaff3ct*.a %NAME%\\lib\\aff3ct.lib\n+ copy bin\\aff3ct*.exe %NAME%\\bin\\\n+ copy lib\\libaff3ct*.a %NAME%\\lib\\\nxcopy ..\\src\\* %NAME%\\include\\aff3ct\\ /s /e > nul\nmove %NAME% ..\\\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: fix binary and lib names for the Windows builds.
|
8,483 |
12.12.2018 11:18:57
| -3,600 |
1c72c3dbe7e198db3f646ead28dbbfebe73f711e
|
Add a --sim-full-legend argument to display all modules details.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/simulation/simulation.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/simulation/simulation.rst",
"diff": "@@ -767,6 +767,16 @@ For the above example, the dumped or read files will be:\ninstead of ``>`` to redirect the standard output in order to add results at\nthe end of the file and not overwriting it.\n+.. _sim-sim-full-legend:\n+\n+``--sim-full-legend`` |image_advanced_argument|\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+|factory::Launcher::parameters::p+full-legend|\n+\n+This additional information can help to understand a problem in the simulation.\n+Data can of course be redundant from one module to another.\n+\n.. _sim-sim-mpi-comm:\n``--sim-mpi-comm``\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/strings.rst",
"new_path": "doc/sphinx/strings.rst",
"diff": "Disable the legend display (remove all the lines beginning by the ``#``\ncharacter).\n+.. |factory::Launcher::parameters::p+full-legend| replace::\n+ Display the legend with all modules details when launching the simulation.\n+\n.. |factory::Launcher::parameters::p+no-colors| replace::\nDisable the colors in the shell.\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Launcher/Launcher.cpp",
"new_path": "src/Factory/Launcher/Launcher.cpp",
"diff": "@@ -160,6 +160,12 @@ void factory::Launcher::parameters\ntools::None(),\ntools::arg_rank::ADV);\n+ tools::add_arg(args, p, class_name+\"p+full-legend\",\n+ tools::None(),\n+ tools::arg_rank::ADV);\n+\n+ args.add_link({p+\"no-legend\"}, {p+\"full-legend\"});\n+\n#ifdef AFF3CT_COLORS\n// args.add(\n// {p+\"-no-colors\"},\n@@ -184,6 +190,7 @@ void factory::Launcher::parameters\nif(vals.exist({\"version\", \"v\"})) this->display_version = true;\nif(vals.exist({\"keys\", \"k\"})) this->display_keys = true;\nif(vals.exist({p+\"-no-legend\" })) this->display_legend = false;\n+ if(vals.exist({p+\"-full-legend\" })) this->full_legend = true;\nif(vals.exist({\"help\", \"h\"}))\n{\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Launcher/Launcher.hpp",
"new_path": "src/Factory/Launcher/Launcher.hpp",
"diff": "@@ -36,6 +36,7 @@ struct Launcher : public Factory\nbool display_version = false;\nbool display_legend = true;\nbool display_keys = false;\n+ bool full_legend = false;\n// ---------------------------------------------------------------------------------------------------- METHODS\nexplicit parameters(const std::string &p = Launcher_prefix);\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Launcher/Launcher.cpp",
"new_path": "src/Launcher/Launcher.cpp",
"diff": "@@ -123,7 +123,7 @@ void Launcher::print_header()\nstream << rang::tag::comment << rang::style::bold << \"---- A FAST FORWARD ERROR CORRECTION TOOLBOX >> ----\" << std::endl;\nstream << rang::tag::comment << rang::style::bold << \"----------------------------------------------------\" << std::endl;\nstream << rang::tag::comment << rang::style::bold << rang::style::underline << \"Parameters :\"<< rang::style::reset << std::endl;\n- factory::Header::print_parameters({¶ms_common}, false, this->stream);\n+ factory::Header::print_parameters({¶ms_common}, this->params_common.full_legend, this->stream);\nthis->stream << rang::tag::comment << std::endl;\n}\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add a --sim-full-legend argument to display all modules details.
|
8,490 |
12.12.2018 11:34:11
| -3,600 |
f4dae6472f9dd04706df787a2dbc02a7c25baf3d
|
Disable wrong GCC warning.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Tools/Perf/Reorderer/Reorderer.hxx",
"new_path": "src/Tools/Perf/Reorderer/Reorderer.hxx",
"diff": "@@ -196,6 +196,10 @@ void Reorderer_static<T,N_FRAMES>\nout_data[i*N_FRAMES +f] = in_data[f][i];\n}\n+#if !defined(__clang__) && !defined(__llvm__) && defined(__GNUC__) && defined(__cplusplus)\n+#pragma GCC diagnostic push\n+#pragma GCC diagnostic ignored \"-Warray-bounds\"\n+#endif\ntemplate <typename T>\nvoid Reorderer<T>\n::apply_rev(const T* in_data, std::vector<T*> &out_data, const int data_length)\n@@ -268,6 +272,9 @@ void Reorderer<T>\nfor (auto f = 0; f < n_fra; f++)\nout_data[f][i] = in_data[i*n_fra +f];\n}\n+#if !defined(__clang__) && !defined(__llvm__) && defined(__GNUC__) && defined(__cplusplus)\n+#pragma GCC diagnostic pop\n+#endif\ntemplate <typename T, int N_FRAMES, int J, int K, int L>\nstruct Reorderer_static_core_rev\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Disable wrong GCC warning.
|
8,483 |
12.12.2018 11:50:10
| -3,600 |
5fadbcff331a58a5e84486aa2ec8273c2ee8ec5f
|
Remove 'sim' prefix to arguments --no-legend --full-legend and --no-colors
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/other/other.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/other/other.rst",
"diff": "@@ -20,21 +20,26 @@ Other parameters\nSimulation parameter(s):\n{R} --sim-cde-type, -C <text:including set={BCH|LDPC|POLAR|RA|REP|RS|RSC|RSC_DB|TPC|TURBO|TURBO_DB|UNCODED}>\n- select the code type you want to use.\n- --sim-no-colors\n- disable the colors in the shell.\n+ Select the channel code family to simulate.\n--sim-prec, -p <integer:including set={8|16|32|64}>\n- the simulation precision in bits.\n+ Specify the representation of the real numbers in the receiver part of the\n+ chain.\n--sim-type <text:including set={BFER|BFERI|EXIT}>\n- select the type of simulation to launch (default is BFER).\n+ Select the type of simulation (or communication chain skeleton).\nOther parameter(s):\n--Help, -H\n- print this help with the advanced arguments.\n+ Print the help like with the '--help, -h' parameter plus advanced\n+ arguments (denoted as '{A}').\n--help, -h\n- print this help.\n+ Print the help with all the required (denoted as '{R}') and optional\n+ arguments. The latter change depending on the selected simulation type and\n+ code.\n+ --no-colors\n+ Disable the colors in the shell.\n--version, -v\n- print informations about the version of the code.\n+ Print informations about the version of the source code and compilation\n+ options.\n.. _other-advanced-help:\n@@ -48,33 +53,45 @@ Other parameters\naff3ct -H\n.. code-block:: console\n- :emphasize-lines: 8,9,18,19,22,23\n+ :emphasize-lines: 16,17,18,19,20,21,22,23,28,29,32,33,34\nUsage: ./bin/aff3ct -C <text> [optional args...]\nSimulation parameter(s):\n{R} --sim-cde-type, -C <text:including set={BCH|LDPC|POLAR|RA|REP|RS|RSC|RSC_DB|TPC|TURBO|TURBO_DB|UNCODED}>\n- select the code type you want to use.\n- --sim-no-colors\n- disable the colors in the shell.\n- {A} --sim-no-legend\n- Do not display any legend when launching the simulation.\n+ Select the channel code family to simulate.\n--sim-prec, -p <integer:including set={8|16|32|64}>\n- the simulation precision in bits.\n+ Specify the representation of the real numbers in the receiver part of the\n+ chain.\n--sim-type <text:including set={BFER|BFERI|EXIT}>\n- select the type of simulation to launch (default is BFER).\n+ Select the type of simulation (or communication chain skeleton).\nOther parameter(s):\n--Help, -H\n- print this help with the advanced arguments.\n+ Print the help like with the '--help, -h' parameter plus advanced\n+ arguments (denoted as '{A}').\n+ {A} --except-a2l\n+ Enhance the backtrace when displaying exception. This change the program\n+ addresses into filenames and lines. It may take some seconds to do this\n+ work.\n{A} --except-no-bt\n- do not print the backtrace when displaying exception.\n+ Disable the backtrace display when running an exception.\n+ {A} --full-legend\n+ Display the legend with all modules details when launching the simulation.\n--help, -h\n- print this help.\n+ Print the help with all the required (denoted as '{R}') and optional\n+ arguments. The latter change depending on the selected simulation type and\n+ code.\n{A} --keys, -k\n- display the parameter keys in the help.\n+ Display the parameter keys in the help.\n+ --no-colors\n+ Disable the colors in the shell.\n+ {A} --no-legend\n+ Disable the legend display (remove all the lines beginning by the '#'\n+ character).\n--version, -v\n- print informations about the version of the code.\n+ Print informations about the version of the source code and compilation\n+ options.\n.. _other-version:\n@@ -89,7 +106,7 @@ Other parameters\n.. code-block:: console\n- aff3ct (Linux 64-bit, g++-8.1, AVX2) v2.1.1\n+ aff3ct (Linux 64-bit, g++-5.4, AVX2) v2.1.1-48-g1c72c3d\nCompilation options:\n* Precision: 8/16/32/64-bit\n* Polar bit packing: on\n@@ -113,46 +130,42 @@ Other parameters\n.. code-block:: bash\n- aff3ct -H -k\n+ aff3ct -h -k\n.. code-block:: console\n- :emphasize-lines: 5,8,11,14,17,22,25,28,31,34\n+ :emphasize-lines: 5,8,12,17,21,26,29\nUsage: ./bin/aff3ct -C <text> [optional args...]\nSimulation parameter(s):\n{R} --sim-cde-type, -C <text:including set={BCH|LDPC|POLAR|RA|REP|RS|RSC|RSC_DB|TPC|TURBO|TURBO_DB|UNCODED}>\n[factory::Launcher::parameters::p+cde-type,C]\n- select the code type you want to use.\n- --sim-no-colors\n- [factory::Launcher::parameters::p+no-colors]\n- disable the colors in the shell.\n- {A} --sim-no-legend\n- [factory::Launcher::parameters::p+no-legend]\n- do not display any legend when launching the simulation.\n+ Select the channel code family to simulate.\n--sim-prec, -p <integer:including set={8|16|32|64}>\n[factory::Launcher::parameters::p+prec,p]\n- the simulation precision in bits.\n+ Specify the representation of the real numbers in the receiver part of the\n+ chain.\n--sim-type <text:including set={BFER|BFERI|EXIT}>\n[factory::Launcher::parameters::p+type]\n- select the type of simulation to launch (default is BFER).\n+ Select the type of simulation (or communication chain skeleton).\nOther parameter(s):\n--Help, -H\n[factory::Launcher::parameters::Help,H]\n- print this help with the advanced arguments.\n- {A} --except-no-bt\n- [factory::Launcher::parameters::except-no-bt]\n- do not print the backtrace when displaying exception.\n+ Print the help like with the '--help, -h' parameter plus advanced\n+ arguments (denoted as '{A}').\n--help, -h\n[factory::Launcher::parameters::help,h]\n- print this help.\n- {A} --keys, -k\n- [factory::Launcher::parameters::keys,k]\n- display the parameter keys in the help.\n+ Print the help with all the required (denoted as '{R}') and optional\n+ arguments. The latter change depending on the selected simulation type and\n+ code.\n+ --no-colors\n+ [factory::Launcher::parameters::no-colors]\n+ Disable the colors in the shell.\n--version, -v\n[factory::Launcher::parameters::version,v]\n- print informations about the version of the code.\n+ Print informations about the version of the source code and compilation\n+ options.\n.. _other-except-a2l:\n@@ -171,3 +184,32 @@ Other parameters\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n|factory::Launcher::parameters::except-no-bt|\n+\n+.. _sim-no-legend:\n+\n+``--no-legend`` |image_advanced_argument|\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+|factory::Launcher::parameters::no-legend|\n+\n+.. tip:: Use this option when you want to complete an already existing\n+ simulation result file with new noise points. Pay attention to use ``>>``\n+ instead of ``>`` to redirect the standard output in order to add results at\n+ the end of the file and not overwriting it.\n+\n+.. _sim-full-legend:\n+\n+``--full-legend`` |image_advanced_argument|\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+|factory::Launcher::parameters::full-legend|\n+\n+This additional information can help to understand a problem in the simulation.\n+Data can of course be redundant from one module to another.\n+\n+.. _sim-no-colors:\n+\n+``--no-colors``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+|factory::Launcher::parameters::no-colors|\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/simulation/simulation.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/simulation/simulation.rst",
"diff": "@@ -504,13 +504,6 @@ of displayed frames on screen:\n# Returned status: 0\n# [...]\n-.. _sim-sim-no-colors:\n-\n-``--sim-no-colors``\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n-|factory::Launcher::parameters::p+no-colors|\n-\n.. _sim-sim-seed:\n``--sim-seed, -S``\n@@ -755,28 +748,6 @@ For the above example, the dumped or read files will be:\n|factory::BFER::parameters::p+err-trk-thold|\n-.. _sim-sim-no-legend:\n-\n-``--sim-no-legend`` |image_advanced_argument|\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n-|factory::Launcher::parameters::p+no-legend|\n-\n-.. tip:: Use this option when you want to complete an already existing\n- simulation result file with new noise points. Pay attention to use ``>>``\n- instead of ``>`` to redirect the standard output in order to add results at\n- the end of the file and not overwriting it.\n-\n-.. _sim-sim-full-legend:\n-\n-``--sim-full-legend`` |image_advanced_argument|\n-\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n-\n-|factory::Launcher::parameters::p+full-legend|\n-\n-This additional information can help to understand a problem in the simulation.\n-Data can of course be redundant from one module to another.\n-\n.. _sim-sim-mpi-comm:\n``--sim-mpi-comm``\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/strings.rst",
"new_path": "doc/sphinx/strings.rst",
"diff": "Enhance the backtrace when displaying exception. This change the program\naddresses into filenames and lines. It may take some seconds to do this work.\n-.. |factory::Launcher::parameters::p+no-legend| replace::\n+.. |factory::Launcher::parameters::no-legend| replace::\nDisable the legend display (remove all the lines beginning by the ``#``\ncharacter).\n-.. |factory::Launcher::parameters::p+full-legend| replace::\n+.. |factory::Launcher::parameters::full-legend| replace::\nDisplay the legend with all modules details when launching the simulation.\n-.. |factory::Launcher::parameters::p+no-colors| replace::\n+.. |factory::Launcher::parameters::no-colors| replace::\nDisable the colors in the shell.\n.. |factory::Launcher::parameters::keys,k| replace::\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Launcher/Launcher.cpp",
"new_path": "src/Factory/Launcher/Launcher.cpp",
"diff": "@@ -156,22 +156,22 @@ void factory::Launcher::parameters\n// tools::None(),\n// \"do not display any legend when launching the simulation.\",\n// tools::arg_rank::ADV);\n- tools::add_arg(args, p, class_name+\"p+no-legend\",\n+ tools::add_arg(args, p, class_name+\"no-legend\",\ntools::None(),\ntools::arg_rank::ADV);\n- tools::add_arg(args, p, class_name+\"p+full-legend\",\n+ tools::add_arg(args, p, class_name+\"full-legend\",\ntools::None(),\ntools::arg_rank::ADV);\n- args.add_link({p+\"no-legend\"}, {p+\"full-legend\"});\n+ args.add_link({\"no-legend\"}, {\"full-legend\"});\n#ifdef AFF3CT_COLORS\n// args.add(\n- // {p+\"-no-colors\"},\n+ // {\"-no-colors\"},\n// tools::None(),\n// \"disable the colors in the shell.\");\n- tools::add_arg(args, p, class_name+\"p+no-colors\",\n+ tools::add_arg(args, p, class_name+\"no-colors\",\ntools::None());\n#endif\n@@ -189,8 +189,8 @@ void factory::Launcher::parameters\nif(vals.exist({p+\"-type\" })) this->sim_type = vals.at({p+\"-type\" });\nif(vals.exist({\"version\", \"v\"})) this->display_version = true;\nif(vals.exist({\"keys\", \"k\"})) this->display_keys = true;\n- if(vals.exist({p+\"-no-legend\" })) this->display_legend = false;\n- if(vals.exist({p+\"-full-legend\" })) this->full_legend = true;\n+ if(vals.exist({\"no-legend\" })) this->display_legend = false;\n+ if(vals.exist({\"full-legend\" })) this->full_legend = true;\nif(vals.exist({\"help\", \"h\"}))\n{\n@@ -212,7 +212,7 @@ void factory::Launcher::parameters\ntools::exception::no_addr_to_line = !vals.exist({\"except-a2l\" });\n#ifdef AFF3CT_COLORS\n- if (vals.exist({p+\"-no-colors\"})) rang::setControlMode(rang::control::Off);\n+ if (vals.exist({\"no-colors\"})) rang::setControlMode(rang::control::Off);\n#else\nrang::setControlMode(rang::control::Off);\n#endif\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Remove 'sim' prefix to arguments --no-legend --full-legend and --no-colors
|
8,490 |
12.12.2018 16:22:51
| -3,600 |
8c4765e910ccfbce9f4d10f390b02f725e9ad4b9
|
Add the doc sphinx (if compiled) in the install.
|
[
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -453,6 +453,14 @@ if (AFF3CT_COMPILE_SHARED_LIB OR AFF3CT_COMPILE_STATIC_LIB)\nDESTINATION lib/cmake/)\nendif()\n+if (EXISTS \"${CMAKE_CURRENT_SOURCE_DIR}/doc/sphinx/build/latex/AFF3CT.pdf\")\n+ install(FILES \"${CMAKE_CURRENT_SOURCE_DIR}/doc/sphinx/build/latex/AFF3CT.pdf\"\n+ DESTINATION share/aff3ct-${GIT_VERSION_RMV}/doc/pdf)\n+endif()\n+if (EXISTS \"${CMAKE_CURRENT_SOURCE_DIR}/doc/sphinx/build/html/\")\n+ install(DIRECTORY \"${CMAKE_CURRENT_SOURCE_DIR}/doc/sphinx/build/html/\"\n+ DESTINATION share/aff3ct-${GIT_VERSION_RMV}/doc/html)\n+endif()\nif (AFF3CT_EXT_STRINGS)\ninstall(FILES \"${CMAKE_CURRENT_SOURCE_DIR}/doc/sphinx/strings.rst\"\nDESTINATION share/aff3ct-${GIT_VERSION_RMV}/doc/strings)\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add the doc sphinx (if compiled) in the install.
|
8,490 |
12.12.2018 16:30:43
| -3,600 |
16342ddcb9fdbbce362bd3605780fcd6b0cd92de
|
CI: rm previous builds if exist.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/build-linux-macos.sh",
"new_path": "ci/build-linux-macos.sh",
"diff": "@@ -45,6 +45,7 @@ fi\nmake -j $THREADS -k\nrc=$?; if [[ $rc != 0 ]]; then exit $rc; fi\n+rm -rf $NAME\nmkdir $NAME $NAME/bin $NAME/lib $NAME/include $NAME/include/aff3ct\ncp bin/aff3ct* $NAME/bin/\ncp lib/libaff3ct*.a $NAME/lib/\n"
},
{
"change_type": "MODIFY",
"old_path": "ci/build-windows-gcc.bat",
"new_path": "ci/build-windows-gcc.bat",
"diff": "@@ -7,6 +7,7 @@ if %ERRORLEVEL% neq 0 exit /B %ERRORLEVEL%\nmingw32-make -j %THREADS%\nif %ERRORLEVEL% neq 0 exit /B %ERRORLEVEL%\n+rd /s /q %NAME%\nmkdir %NAME%\nmkdir %NAME%\\bin\\\nmkdir %NAME%\\lib\\\n"
},
{
"change_type": "MODIFY",
"old_path": "ci/build-windows-msvc.bat",
"new_path": "ci/build-windows-msvc.bat",
"diff": "@@ -11,6 +11,7 @@ devenv /build Release aff3ct.sln\nrem msbuild aff3ct.sln /t:Build /p:Configuration=Release\nif %ERRORLEVEL% neq 0 exit /B %ERRORLEVEL%\n+rd /s /q %NAME%\nmkdir %NAME%\nmkdir %NAME%\\bin\\\nmkdir %NAME%\\lib\\\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: rm previous builds if exist.
|
8,483 |
12.12.2018 17:26:47
| -3,600 |
3dc875343e7b049e9934f923667fcac11ca5975b
|
Doc: Modify doc as the Modem bps no longer need to be given with the USER type
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/modem/modem.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/modem/modem.rst",
"diff": "@@ -151,9 +151,8 @@ with an anti-Gray mapping (the lines starting with a ``#`` are ignored):\n# 1111\n-3 3\n-.. warning:: The :ref:`mdm-mdm-bps` parameter has to be set accordingly to the\n- given constellation. In the previous example, ``--mdm-bps 4`` has be added\n- to the command line.\n+.. note:: The number of bits per symbol is automatically computed from the\n+ number of given symbols. The latter has to be a power of 2.\n.. _mdm-mdm-max:\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: Modify doc as the Modem bps no longer need to be given with the USER type
|
8,483 |
12.12.2018 18:49:46
| -3,600 |
fed795f0e036caff34b990ffbc94ddcf20fe269b
|
In factory::Modem, remove template <R> on secondary functions to put the float type for constellations
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Modem/Modem.cpp",
"new_path": "src/Factory/Module/Modem/Modem.cpp",
"diff": "@@ -425,7 +425,6 @@ bool Modem\nreturn type == \"PAM\" || type == \"QAM\" || type == \"PSK\" || type == \"USER\";\n}\n-template <typename R>\nint Modem\n::get_buffer_size_after_modulation(const std::string &type,\nconst int N,\n@@ -433,7 +432,7 @@ int Modem\nconst int cpm_upf,\nconst int cpm_L,\nconst int cpm_p,\n- const tools::Constellation<R>* c)\n+ const tools::Constellation<float>* c)\n{\nif (c != nullptr && has_constellation(type))\nreturn module::Modem_generic<>::size_mod(N, *c);\n@@ -446,14 +445,13 @@ int Modem\nthrow tools::cannot_allocate(__FILE__, __LINE__, __func__);\n}\n-template <typename R>\nint Modem\n::get_buffer_size_after_filtering(const std::string &type,\nconst int N,\nconst int bps,\nconst int cpm_L,\nconst int cpm_p,\n- const tools::Constellation<R>* c)\n+ const tools::Constellation<float>* c)\n{\nif (c != nullptr && has_constellation(type))\nreturn module::Modem_generic<>::size_fil(N, *c);\n@@ -466,9 +464,8 @@ int Modem\nthrow tools::cannot_allocate(__FILE__, __LINE__, __func__);\n}\n-template <typename R>\nbool Modem\n-::is_complex_mod(const std::string &type, const int bps, const tools::Constellation<R>* c)\n+::is_complex_mod(const std::string &type, const int bps, const tools::Constellation<float>* c)\n{\nif (c != nullptr && has_constellation(type))\nreturn module::Modem_generic<>::is_complex_mod(*c);\n@@ -481,9 +478,8 @@ bool Modem\nthrow tools::cannot_allocate(__FILE__, __LINE__, __func__);\n}\n-template <typename R>\nbool Modem\n-::is_complex_fil(const std::string &type, const int bps, const tools::Constellation<R>* c)\n+::is_complex_fil(const std::string &type, const int bps, const tools::Constellation<float>* c)\n{\nif (c != nullptr && has_constellation(type))\nreturn module::Modem_generic<>::is_complex_fil(*c);\n@@ -538,4 +534,5 @@ template aff3ct::module::Modem<B,R,R>* aff3ct::factory::Modem::parameters::build\ntemplate aff3ct::module::Modem<B,R,R>* aff3ct::factory::Modem::build<B,R,R>(const aff3ct::factory::Modem::parameters&, const tools::Distributions<R>&);\n#endif\n#endif\n+\n// ==================================================================================== explicit template instantiation\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Modem/Modem.hpp",
"new_path": "src/Factory/Module/Modem/Modem.hpp",
"diff": "@@ -96,27 +96,23 @@ struct Modem : public Factory\nstatic bool has_constellation(const std::string &type);\n- template <typename R = float>\n- static bool is_complex_mod(const std::string &type, const int bps = 1, const tools::Constellation<R>* c = nullptr);\n- template <typename R = float>\n- static bool is_complex_fil(const std::string &type, const int bps = 1, const tools::Constellation<R>* c = nullptr);\n+ static bool is_complex_mod(const std::string &type, const int bps = 1, const tools::Constellation<float>* c = nullptr);\n+ static bool is_complex_fil(const std::string &type, const int bps = 1, const tools::Constellation<float>* c = nullptr);\n- template <typename R = float>\nstatic int get_buffer_size_after_modulation(const std::string &type,\nconst int N,\nconst int bps = 1,\nconst int cpm_upf = 5,\nconst int cpm_L = 3,\nconst int cpm_p = 2,\n- const tools::Constellation<R>* c = nullptr);\n+ const tools::Constellation<float>* c = nullptr);\n- template <typename R = float>\nstatic int get_buffer_size_after_filtering(const std::string &type,\nconst int N,\nconst int bps = 1,\nconst int cpm_L = 3,\nconst int cpm_p = 2,\n- const tools::Constellation<R>* c = nullptr);\n+ const tools::Constellation<float>* c = nullptr);\n};\n}\n}\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
In factory::Modem, remove template <R> on secondary functions to put the float type for constellations
|
8,490 |
12.12.2018 20:44:44
| -3,600 |
665745d0e5410af30d23b3135165cfd78f8dbdc9
|
CI: rm useless CMake variable.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/build-linux-macos.sh",
"new_path": "ci/build-linux-macos.sh",
"diff": "@@ -4,12 +4,6 @@ set -x\nmkdir build\ncd build\n-if [ -z \"$CC\" ]\n-then\n- echo \"Please define the 'CC' environment variable.\"\n- exit 1\n-fi\n-\nif [ -z \"$CXX\" ]\nthen\necho \"Please define the 'CXX' environment variable.\"\n@@ -30,12 +24,12 @@ fi\nif [ -z \"$LFLAGS\" ]\nthen\n- cmake .. -G\"Unix Makefiles\" -DCMAKE_CXX_COMPILER=$CC -DCMAKE_CXX_COMPILER=$CXX \\\n+ cmake .. -G\"Unix Makefiles\" -DCMAKE_CXX_COMPILER=$CXX \\\n-DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_FLAGS=\"$CFLAGS\" \\\n$CMAKE_OPT\nrc=$?; if [[ $rc != 0 ]]; then exit $rc; fi\nelse\n- cmake .. -G\"Unix Makefiles\" -DCMAKE_CXX_COMPILER=$CC -DCMAKE_CXX_COMPILER=$CXX \\\n+ cmake .. -G\"Unix Makefiles\" -DCMAKE_CXX_COMPILER=$CXX \\\n-DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_FLAGS=\"$CFLAGS\" \\\n-DCMAKE_EXE_LINKER_FLAGS=\"$LFLAGS\" \\\n$CMAKE_OPT\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: rm useless CMake variable.
|
8,490 |
12.12.2018 20:45:58
| -3,600 |
e01332919a61501c11165a58267cb600f55cd045
|
Integrate properly Polar bounds.
|
[
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -25,6 +25,7 @@ option (AFF3CT_SYSTEMC_SIMU \"Enable the SystemC simulation (incompatible w\noption (AFF3CT_SYSTEMC_MODULE \"Enable the SystemC support (only for the modules)\" OFF)\noption (AFF3CT_MPI \"Enable the MPI support\" OFF)\noption (AFF3CT_POLAR_BIT_PACKING \"Enable the bit packing technique for Polar code SC decoding\" ON )\n+option (AFF3CT_POLAR_BOUNDS \"Enable the use of the external Tal & Vardy Polar best channels generator\" OFF)\noption (AFF3CT_COLORS \"Enable the colors in the terminal\" ON )\nif (NOT (WIN32 OR APPLE))\n@@ -202,6 +203,12 @@ if (AFF3CT_POLAR_BIT_PACKING)\nelse()\nmessage(STATUS \"AFF3CT - Polar bit packing: off\")\nendif()\n+if (AFF3CT_POLAR_BOUNDS)\n+ aff3ct_add_definitions (-DAFF3CT_POLAR_BOUNDS)\n+ message(STATUS \"AFF3CT - Polar bounds: on\")\n+else()\n+ message(STATUS \"AFF3CT - Polar bounds: off\")\n+endif()\nif (AFF3CT_COLORS)\naff3ct_add_definitions (-DAFF3CT_COLORS)\nmessage(STATUS \"AFF3CT - Terminal colors: on\")\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Tools/Code/Polar/Frozenbits_generator.cpp",
"new_path": "src/Factory/Tools/Code/Polar/Frozenbits_generator.cpp",
"diff": "@@ -72,7 +72,7 @@ void Frozenbits_generator::parameters\ntools::add_arg(args, p, class_name+\"p+awgn-path\",\ntools::Path(tools::openmode::read));\n-#ifdef ENABLE_POLAR_BOUNDS\n+#ifdef AFF3CT_POLAR_BOUNDS\n// args.add(\n// {p+\"-pb-path\"},\n// tools::File(tools::openmode::read),\n@@ -93,7 +93,7 @@ void Frozenbits_generator::parameters\nif(vals.exist({p+\"-awgn-path\" })) this->path_fb = vals.at ({p+\"-awgn-path\" });\nif(vals.exist({p+\"-gen-method\" })) this->type = vals.at ({p+\"-gen-method\" });\n-#ifdef ENABLE_POLAR_BOUNDS\n+#ifdef AFF3CT_POLAR_BOUNDS\nif(vals.exist({p+\"-pb-path\"})) this->path_pb = vals.at({p+\"-pb-path\"});\n#endif\n}\n@@ -107,7 +107,7 @@ void Frozenbits_generator::parameters\nif (full) headers[p].push_back(std::make_pair(\"Info. bits (K)\", std::to_string(this->K)));\nif (full) headers[p].push_back(std::make_pair(\"Codeword size (N)\", std::to_string(this->N_cw)));\nheaders[p].push_back(std::make_pair(\"Sigma\", this->sigma == -1.0f ? \"adaptive\" : std::to_string(this->sigma)));\n-#ifdef ENABLE_POLAR_BOUNDS\n+#ifdef AFF3CT_POLAR_BOUNDS\nif (this->type == \"TV\")\nheaders[p].push_back(std::make_pair(\"PB path\", this->path_pb));\n#endif\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Code/Polar/Frozenbits_generator/Frozenbits_generator_TV.cpp",
"new_path": "src/Tools/Code/Polar/Frozenbits_generator/Frozenbits_generator_TV.cpp",
"diff": "@@ -83,7 +83,7 @@ void Frozenbits_generator_TV\nif (!this->load_channels_file(filename))\n{\n-#ifdef ENABLE_POLAR_BOUNDS\n+#ifdef AFF3CT_POLAR_BOUNDS\nstatic std::mutex mutex_write_file;\nmutex_write_file.lock();\nif (!this->load_channels_file(filename))\n@@ -96,8 +96,8 @@ void Frozenbits_generator_TV\ncmd += \" --log-length=\" + str_m; // m\ncmd += \" -f=\" + filename; // filename\n- std::clog << rang::tag::info << \"Generating best channels positions file (\\\"\" << filename << \"\\\")...\\r\";\n- fflush(stdout); fflush(stderr);\n+ // std::clog << rang::tag::info << \"Generating best channels positions file (\\\"\" << filename << \"\\\")...\\r\";\n+ // fflush(stdout); fflush(stderr);\nif (system(cmd.c_str()) == 0)\n{\n"
},
{
"change_type": "MODIFY",
"old_path": "src/main.cpp",
"new_path": "src/main.cpp",
"diff": "@@ -91,6 +91,12 @@ void print_version()\nstd::string bit_packing = \"off\";\n#endif\n+#if defined(AFF3CT_POLAR_BOUNDS)\n+ std::string polar_bounds = \"on\";\n+#else\n+ std::string polar_bounds = \"off\";\n+#endif\n+\n#if defined(AFF3CT_COLORS)\nstd::string terminal_colors = \"on\";\n#else\n@@ -138,6 +144,7 @@ void print_version()\nstd::cout << \"Compilation options:\" << std::endl;\nstd::cout << \" * Precision: \" << precision << std::endl;\nstd::cout << \" * Polar bit packing: \" << bit_packing << std::endl;\n+ std::cout << \" * Polar bounds: \" << polar_bounds << std::endl;\nstd::cout << \" * Terminal colors: \" << terminal_colors << std::endl;\nstd::cout << \" * Backtrace: \" << backtrace << std::endl;\nstd::cout << \" * External strings: \" << ext_strings << std::endl;\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Integrate properly Polar bounds.
|
8,490 |
12.12.2018 22:25:16
| -3,600 |
6b87f7c67c71a619187bcf321a91740aa629e91b
|
Add a script to automatically run the last AFF3CT binary.
|
[
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -140,6 +140,14 @@ if (NOT AFF3CT_EXT_STRINGS)\nlist(APPEND source_files \"${CMAKE_CURRENT_SOURCE_DIR}/src/Tools/Documentation/strings.cpp\")\nendif()\n+# ---------------------------------------------------------------------------------------------------------------------\n+# --------------------------------------------------------------------------------------- GENERATE AFF3CT SHORTCUT FILE\n+# ---------------------------------------------------------------------------------------------------------------------\n+\n+if (UNIX)\n+ configure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/aff3ct.in\" \"scripts/aff3ct\" @ONLY)\n+endif ()\n+\n# ---------------------------------------------------------------------------------------------------------------------\n# ------------------------------------------------------------------------------------------------------ CREATE FILTERS\n# ---------------------------------------------------------------------------------------------------------------------\n@@ -374,12 +382,15 @@ endif (AFF3CT_LINK_GSL)\nif (AFF3CT_LINK_MKL)\naff3ct_add_definitions(\"-DAFF3CT_CHANNEL_MKL\")\n+ # set (MKL_STATIC ON)\nfind_package (MKL REQUIRED)\nif (MKL_FOUND)\nmessage(STATUS \"AFF3CT - Library found: MKL\")\naff3ct_include_directories (${MKL_INCLUDE_DIRS})\naff3ct_link_libraries (\"${MKL_MINIMAL_LIBRARIES}\")\nendif (MKL_FOUND)\n+else (AFF3CT_LINK_MKL)\n+ set(INTEL_ROOT \"/opt/intel\")\nendif (AFF3CT_LINK_MKL)\n# MPI\n@@ -446,6 +457,10 @@ endif()\nif (AFF3CT_COMPILE_EXE)\ninstall(TARGETS aff3ct-bin RUNTIME DESTINATION bin/)\n+ if (UNIX)\n+ install(FILES \"${CMAKE_BINARY_DIR}/scripts/aff3ct\" DESTINATION bin/\n+ PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)\n+ endif ()\nendif()\nif (AFF3CT_COMPILE_SHARED_LIB)\ninstall(TARGETS aff3ct-shared-lib LIBRARY DESTINATION lib/)\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "cmake/Modules/aff3ct.in",
"diff": "+#!/bin/bash\n+\n+AFF3CT_PATH=@CMAKE_INSTALL_PREFIX@/bin\n+\n+ls -l $AFF3CT_PATH/aff3ct-* > /dev/null 2>&1\n+\n+if [ $? -gt 0 ]; then\n+ echo \"There is no AFF3CT binary installed on the system (AFF3CT_PATH='$AFF3CT_PATH').\"\n+ exit 1\n+fi\n+\n+BIN=$(ls -l $AFF3CT_PATH/aff3ct-* | tail -n 1 | cut -d\" \" -f10)\n+\n+STR=$($BIN \"$@\" 2>&1)\n+if [[ $STR == *\"mkl_intel\"*\".so: cannot open shared object file\"* ]]; then\n+ source @INTEL_ROOT@/vars-intel.sh\n+fi\n+\n+eval $BIN \"$@\"\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add a script to automatically run the last AFF3CT binary.
|
8,490 |
12.12.2018 22:46:23
| -3,600 |
ffc99608c69f9473a1a9fca3a2298387aa7c9ce2
|
Simplify the usage of the 'aff3ct' script.
|
[
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -144,8 +144,8 @@ endif()\n# --------------------------------------------------------------------------------------- GENERATE AFF3CT SHORTCUT FILE\n# ---------------------------------------------------------------------------------------------------------------------\n-if (UNIX)\n- configure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/aff3ct.in\" \"scripts/aff3ct\" @ONLY)\n+if (AFF3CT_COMPILE_EXE AND UNIX)\n+ configure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/scripts/aff3ct\" \"bin/aff3ct\" @ONLY)\nendif ()\n# ---------------------------------------------------------------------------------------------------------------------\n@@ -389,8 +389,6 @@ if (AFF3CT_LINK_MKL)\naff3ct_include_directories (${MKL_INCLUDE_DIRS})\naff3ct_link_libraries (\"${MKL_MINIMAL_LIBRARIES}\")\nendif (MKL_FOUND)\n-else (AFF3CT_LINK_MKL)\n- set(INTEL_ROOT \"/opt/intel\")\nendif (AFF3CT_LINK_MKL)\n# MPI\n@@ -458,7 +456,7 @@ endif()\nif (AFF3CT_COMPILE_EXE)\ninstall(TARGETS aff3ct-bin RUNTIME DESTINATION bin/)\nif (UNIX)\n- install(FILES \"${CMAKE_BINARY_DIR}/scripts/aff3ct\" DESTINATION bin/\n+ install(FILES \"${CMAKE_CURRENT_SOURCE_DIR}/scripts/aff3ct\" DESTINATION bin/\nPERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)\nendif ()\nendif()\n"
},
{
"change_type": "DELETE",
"old_path": "cmake/Modules/aff3ct.in",
"new_path": null,
"diff": "-#!/bin/bash\n-\n-AFF3CT_PATH=@CMAKE_INSTALL_PREFIX@/bin\n-\n-ls -l $AFF3CT_PATH/aff3ct-* > /dev/null 2>&1\n-\n-if [ $? -gt 0 ]; then\n- echo \"There is no AFF3CT binary installed on the system (AFF3CT_PATH='$AFF3CT_PATH').\"\n- exit 1\n-fi\n-\n-BIN=$(ls -l $AFF3CT_PATH/aff3ct-* | tail -n 1 | cut -d\" \" -f10)\n-\n-STR=$($BIN \"$@\" 2>&1)\n-if [[ $STR == *\"mkl_intel\"*\".so: cannot open shared object file\"* ]]; then\n- source @INTEL_ROOT@/vars-intel.sh\n-fi\n-\n-eval $BIN \"$@\"\n\\ No newline at end of file\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "scripts/aff3ct",
"diff": "+#!/bin/bash\n+\n+SOURCE=\"${BASH_SOURCE[0]}\"\n+while [ -h \"$SOURCE\" ]; do # resolve $SOURCE until the file is no longer a symlink\n+ DIR=\"$( cd -P \"$( dirname \"$SOURCE\" )\" >/dev/null && pwd )\"\n+ SOURCE=\"$(readlink \"$SOURCE\")\"\n+ [[ $SOURCE != /* ]] && SOURCE=\"$DIR/$SOURCE\" # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located\n+done\n+DIR=\"$( cd -P \"$( dirname \"$SOURCE\" )\" >/dev/null && pwd )\"\n+\n+AFF3CT_PATH=$DIR\n+\n+ls -l $AFF3CT_PATH/aff3ct-* > /dev/null 2>&1\n+\n+if [ $? -gt 0 ]; then\n+ echo \"There is no AFF3CT binary installed on the system (AFF3CT_PATH='$AFF3CT_PATH').\"\n+ exit 1\n+fi\n+\n+BIN=$(ls -l $AFF3CT_PATH/aff3ct-* | tail -n 1 | cut -d\" \" -f10)\n+\n+STR=$($BIN \"$@\" 2>&1)\n+if [[ $STR == *\"mkl_intel\"*\".so: cannot open shared object file\"* ]]; then\n+ source /opt/intel/vars-intel.sh\n+fi\n+\n+eval $BIN \"$@\"\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Simplify the usage of the 'aff3ct' script.
|
8,490 |
13.12.2018 16:52:18
| -3,600 |
5a1aa44f0dead2f6b34b717937d6900ea185df5f
|
Fix wrong paths.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Types/File_system/File_system.hpp",
"new_path": "src/Tools/Arguments/Types/File_system/File_system.hpp",
"diff": "@@ -33,18 +33,17 @@ std::string modify_file_path(const std::string& val)\nstd::vector<std::string> paths = {\n\"../../conf/\",\n\"../../../conf/\",\n- \"../share/aff3ct-\" + aff3ct_version + \"/doc/conf/\",\n- \"../../share/aff3ct-\" + aff3ct_version + \"/doc/conf/\",\n- \"/usr/share/aff3ct-\" + aff3ct_version + \"/doc/conf/\",\n- \"/usr/share/aff3ct-\" + aff3ct_version + \"/doc/conf/\",\n- \"/usr/local/share/aff3ct-\" + aff3ct_version + \"/doc/conf/\",\n- \"../share/aff3ct/doc/conf/\",\n- \"../../share/aff3ct/doc/conf/\",\n- \"/usr/share/aff3ct/doc/conf/\",\n- \"/usr/local/share/aff3ct/doc/conf/\",\n+ \"../share/aff3ct-\" + aff3ct_version + \"/conf/\",\n+ \"../../share/aff3ct-\" + aff3ct_version + \"/conf/\",\n+ \"/usr/share/aff3ct-\" + aff3ct_version + \"/conf/\",\n+ \"/usr/share/aff3ct-\" + aff3ct_version + \"/conf/\",\n+ \"/usr/local/share/aff3ct-\" + aff3ct_version + \"/conf/\",\n+ \"../share/aff3ct/conf/\",\n+ \"../../share/aff3ct/conf/\",\n+ \"/usr/share/aff3ct/conf/\",\n+ \"/usr/local/share/aff3ct/conf/\",\n};\n- bool found = false;\nfor (auto &path : paths)\n{\nstd::string full_path = (path[0] != '/') ? basedir + \"/\" : \"\";\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix wrong paths.
|
8,490 |
13.12.2018 17:47:36
| -3,600 |
99f9e56836e0b39e608c71dcdb5b2f021e19dd31
|
Fix wrong path to the frozen bits.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Tools/Code/Polar/Frozenbits_generator.cpp",
"new_path": "src/Factory/Tools/Code/Polar/Frozenbits_generator.cpp",
"diff": "@@ -17,6 +17,8 @@ Frozenbits_generator::parameters\n::parameters(const std::string &prefix)\n: Factory::parameters(Frozenbits_generator_name, Frozenbits_generator_name, prefix)\n{\n+ if (!tools::isFile::check(this->path_fb))\n+ this->path_fb = tools::modify_file_path<tools::isFile>(this->path_fb);\n}\nFrozenbits_generator::parameters* Frozenbits_generator::parameters\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Tools/Code/Polar/Frozenbits_generator.hpp",
"new_path": "src/Factory/Tools/Code/Polar/Frozenbits_generator.hpp",
"diff": "@@ -23,7 +23,7 @@ struct Frozenbits_generator : public Factory\n// optional parameters\nstd::string type = \"GA\";\n- std::string path_fb = \"../conf/cde/awgn_polar_codes/TV\";\n+ std::string path_fb = \"conf/cde/awgn_polar_codes/TV\";\nstd::string path_pb = \"../lib/polar_bounds/bin/polar_bounds\";\nfloat sigma = -1.f;\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix wrong path to the frozen bits.
|
8,483 |
14.12.2018 12:11:12
| -3,600 |
abd3d725d12a29abcfd5b482bf4424dc44feac74
|
Add Refs curve and add Gallager B in doc
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/conf.py",
"new_path": "doc/sphinx/source/conf.py",
"diff": "@@ -290,6 +290,7 @@ rst_epilog = \"\"\"\n.. |FNC| replace:: :abbr:`FNC (Flip aNd Check)`\n.. |GA| replace:: :abbr:`GA (Gaussian Approximation)`\n.. |GALA| replace:: :abbr:`GALA (Gallager A)`\n+.. |GALB| replace:: :abbr:`GALB (Gallager B)`\n.. |GNU| replace:: :abbr:`GNU (GNU's Not Unix!)`\n.. |GPP| replace:: :abbr:`GPP (General Purpose Processor)`\n.. |GPPs| replace:: :abbr:`GPPs (General Purpose Processors)`\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"diff": "@@ -69,7 +69,7 @@ Description of the allowed values:\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: text\n- :Allowed values: ``STD`` ``GALA`` ``WBF`` ``SPA`` ``LSPA`` ``AMS`` ``MS``\n+ :Allowed values: ``STD`` ``GALA`` ``GALB`` ``WBF`` ``SPA`` ``LSPA`` ``AMS`` ``MS``\n``NMS`` ``OMS``\n:Default: ``SPA``\n:Examples: ``--dec-implem AMS``\n@@ -85,6 +85,8 @@ Description of the allowed values:\n+-----------+------------------------------------------------------------------+\n| ``GALA`` | Select the |GALA| algorithm :cite:`Ryan2009`. |\n+-----------+------------------------------------------------------------------+\n+| ``GALB`` | Select the |GALB| algorithm :cite:`Declerq2014`. |\n++-----------+------------------------------------------------------------------+\n| ``WBF`` | Select the |WBF| algorithm :cite:`Wadayama2010`. |\n+-----------+------------------------------------------------------------------+\n| ``SPA`` | Select the |SPA| update rules :cite:`MacKay1995`. |\n@@ -108,19 +110,19 @@ corresponding available implementations.\n.. table:: |LDPC| decoder types and available implementations.\n:align: center\n- +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n- | Decoder ||STD|||GALA|||WBF|||SPA|||LSPA|||AMS|||MS|||NMS|||OMS||\n- +=========+=====+======+=====+=====+======+=====+====+=====+=====+\n- | |BF| | | ||K| | | | | | | |\n- +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n- | |BP-P| ||K| | | | | | | | | |\n- +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n- | |BP-F| | ||K| | ||K3| ||K2| ||K2| ||K2|||K2| ||K2| |\n- +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n- | |BP-HL| | | | ||K2| ||K2| ||K2| ||K1|||K1| ||K1| |\n- +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n- | |BP-VL| | | | ||K2| ||K2| ||K2| ||K2|||K2| ||K2| |\n- +---------+-----+------+-----+-----+------+-----+----+-----+-----+\n+ +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n+ | Decoder ||STD|||GALA|||GALB|||WBF|||SPA|||LSPA|||AMS|||MS|||NMS|||OMS||\n+ +=========+=====+======+======+=====+=====+======+=====+====+=====+=====+\n+ | |BF| | | | ||K| | | | | | | |\n+ +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-P| ||K| | | | | | | | | | |\n+ +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-F| | ||K| ||K| | ||K3| ||K2| ||K2| ||K2|||K2| ||K2| |\n+ +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-HL| | | | | ||K2| ||K2| ||K2| ||K1|||K1| ||K1| |\n+ +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-VL| | | | | ||K2| ||K2| ||K2| ||K2|||K2| ||K2| |\n+ +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n.. |K| replace:: :math:`\\checkmark`\n.. |K1| replace:: :math:`\\checkmark^{*}`\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/references.bib",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/references.bib",
"diff": "@@ -122,3 +122,13 @@ are also included to test and enhance learning, making this an essential resourc\nISSN = {1089-7798},\nmonth = may,\n}\n+\n+@Book{Declerq2014,\n+ title = {Channel Coding: Theory, Algorithms, and Applications},\n+ publisher = {Academic Press},\n+ year = {2014},\n+ author = {D. Declerq, M. Fossorier and E. Biglieri},\n+ isbn = {978-0-12-396499-1},\n+ abstract = {This book gives a review of the principles, methods and techniques of important and emerging research topics and technologies in Channel Coding, including theory, algorithms, and applications. Edited by leading people in the field who, through their reputation, have been able to commission experts to write on a particular topic. With this reference source you will: Quickly grasp a new area of research. Understand the underlying principles of a topic and its applications. Ascertain how a topic relates to other areas and learn of the research issues yet to be resolved},\n+ doi = {10.1016/C2011-0-07211-3},\n+}\n"
},
{
"change_type": "MODIFY",
"old_path": "refs",
"new_path": "refs",
"diff": "-Subproject commit 8fa85f6f037d24f2c7368a8fa13685a82e7b04f0\n+Subproject commit e23e8ba11270b18ea4a39d7fcae2f85a1522eab8\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add Refs curve and add Gallager B in doc
|
8,490 |
14.12.2018 12:19:18
| -3,600 |
c3c6822068375f955a81b5428c90fec4905efa85
|
CI: try to fix errors in the test stage.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/test-regression.py",
"new_path": "ci/test-regression.py",
"diff": "@@ -433,7 +433,7 @@ for fn in fileNames:\nfor i in range(len(stdOutput)):\nfRes.write(stdOutput[i] + \"\\n\")\nfor i in range(len(errAndWarnMessages)):\n- fRes.write(errAndWarnMessages[i] + \"\\n\")\n+ fRes.write(errAndWarnMessages[i])\nelif simuCur.getNoiseType() != simuRef.getNoiseType():\nnErrors += 1\n@@ -444,7 +444,7 @@ for fn in fileNames:\nfor i in range(len(stdOutput)):\nfRes.write(stdOutput[i] + \"\\n\")\nfor i in range(len(errAndWarnMessages)):\n- fRes.write(errAndWarnMessages[i] + \"\\n\")\n+ fRes.write(errAndWarnMessages[i])\nelse:\n# parse the results to validate (or not) the BER/FER/MI performance\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Tools/Code/Polar/Frozenbits_generator.cpp",
"new_path": "src/Factory/Tools/Code/Polar/Frozenbits_generator.cpp",
"diff": "@@ -17,8 +17,12 @@ Frozenbits_generator::parameters\n::parameters(const std::string &prefix)\n: Factory::parameters(Frozenbits_generator_name, Frozenbits_generator_name, prefix)\n{\n- if (!tools::isFile::check(this->path_fb))\n- this->path_fb = tools::modify_file_path<tools::isFile>(this->path_fb);\n+ if (!tools::isPath::check(this->path_fb))\n+ {\n+ auto new_path_fb = tools::modify_path<tools::isPath>(this->path_fb);\n+ if (!new_path_fb.empty())\n+ this->path_fb = new_path_fb;\n+ }\n}\nFrozenbits_generator::parameters* Frozenbits_generator::parameters\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Maps/Argument_map_value.cpp",
"new_path": "src/Tools/Arguments/Maps/Argument_map_value.cpp",
"diff": "@@ -43,7 +43,13 @@ to_file(const Argument_tag &tags) const\nif (isFile::check(this->at(tags)))\nreturn this->at(tags);\nelse\n- return modify_file_path<isFile>(this->at(tags));\n+ {\n+ auto new_str = modify_path<isFile>(this->at(tags));\n+ if (new_str.empty())\n+ return this->at(tags);\n+ else\n+ return new_str;\n+ }\n}\nstd::string Argument_map_value::\n@@ -52,7 +58,13 @@ to_folder(const Argument_tag &tags) const\nif (isFolder::check(this->at(tags)))\nreturn this->at(tags);\nelse\n- return modify_file_path<isFolder>(this->at(tags));\n+ {\n+ auto new_str = modify_path<isFolder>(this->at(tags));\n+ if (new_str.empty())\n+ return this->at(tags);\n+ else\n+ return new_str;\n+ }\n}\nstd::string Argument_map_value::\n@@ -61,5 +73,11 @@ to_path(const Argument_tag &tags) const\nif (isPath::check(this->at(tags)))\nreturn this->at(tags);\nelse\n- return modify_file_path<isPath>(this->at(tags));\n+ {\n+ auto new_str = modify_path<isPath>(this->at(tags));\n+ if (new_str.empty())\n+ return this->at(tags);\n+ else\n+ return new_str;\n+ }\n}\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Types/File_system/File_system.hpp",
"new_path": "src/Tools/Arguments/Types/File_system/File_system.hpp",
"diff": "@@ -18,7 +18,7 @@ namespace tools\nenum class openmode : uint8_t {read, write, read_write};\ntemplate <typename Read_F>\n-std::string modify_file_path(const std::string& val)\n+std::string modify_path(const std::string& val)\n{\nstd::string binary_path = get_binary_path();\nif (!binary_path.empty())\n@@ -142,7 +142,7 @@ public:\n{\ncase openmode::read :\nif(!Read_F::check(str_val))\n- if (modify_file_path<Read_F>(str_val).empty())\n+ if (modify_path<Read_F>(str_val).empty())\nthrow std::runtime_error(\"does not name an existing \" + name);\nbreak;\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: try to fix errors in the test stage.
|
8,490 |
14.12.2018 15:14:10
| -3,600 |
2ae19d3efa3f6259370aa7d00eb7932e4e63f068
|
CI: improve the test coverage script.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/test-build-coverage-regression.sh",
"new_path": "ci/test-build-coverage-regression.sh",
"diff": "@@ -33,7 +33,7 @@ function gen_coverage_info\nci=$(awk -F \"=\" '/ci/ {print $2}' $path)\nif [ \"$ci\" != \"off\" ]; then\ncd $build\n- eval \"${cmd} --sim-stop-time 1 -t 1\"\n+ eval \"${cmd} --sim-threads 1 --sim-max-fra 1 --sim-crit-nostop --ter-freq 0\"\nrc=$?; if [[ $rc != 0 ]]; then exit $rc; fi\ncd ..\nelse\n"
},
{
"change_type": "MODIFY",
"old_path": "refs",
"new_path": "refs",
"diff": "-Subproject commit 03d96b8cdb9a3ee3f3f9b95b082db293a8866105\n+Subproject commit e59d4b2b46d9827f3fd652d27856ef5e3eb7fda7\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
CI: improve the test coverage script.
|
8,490 |
14.12.2018 16:16:17
| -3,600 |
873360497721ea1d6b297b08563b3c7992e7aa8d
|
Fix the 'aff3ct' script...
|
[
{
"change_type": "MODIFY",
"old_path": "scripts/aff3ct",
"new_path": "scripts/aff3ct",
"diff": "@@ -19,7 +19,7 @@ fi\nBIN=$(ls -lrt $AFF3CT_PATH/aff3ct-* | tail -n 1 | rev | cut -d\" \" -f1 | rev)\n-STR=$($BIN \"$@\" 2>&1)\n+STR=$($BIN \"$@\" \"-v\" 2>&1)\nif [[ $STR == *\"mkl_intel\"*\".so: cannot open shared object file\"* ]]; then\nsource /opt/intel/vars-intel.sh\nfi\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix the 'aff3ct' script...
|
8,483 |
14.12.2018 16:32:13
| -3,600 |
7c89e26f99ad236422eba9e7fde5909cddcaed00
|
Implement our own tools::signbit function for MSVC else call std::signbit.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_B.cpp",
"new_path": "src/Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_B.cpp",
"diff": "@@ -192,7 +192,7 @@ void Decoder_LDPC_BP_flooding_Gallager_B<B,R>\nfor (auto c = 0; c < var_degree; c++)\n{\nconst auto diff = n_z_m_o + chk_to_var_ptr[c];\n- var_to_chk_ptr[c] = diff == 0 ? cur_state : (int8_t)std::signbit(diff);\n+ var_to_chk_ptr[c] = diff == 0 ? cur_state : (int8_t)tools::signbit(diff);\n}\n}\n@@ -243,7 +243,7 @@ void Decoder_LDPC_BP_flooding_Gallager_B<B,R>\nconst auto n_z_m_o = n_zero - n_ones;\n// take the hard decision\n- V_N[v] = n_z_m_o == 0 ? cur_state : std::signbit(n_z_m_o);\n+ V_N[v] = n_z_m_o == 0 ? cur_state : tools::signbit(n_z_m_o);\nchk_to_var_ptr += var_degree;\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Math/utils.h",
"new_path": "src/Tools/Math/utils.h",
"diff": "@@ -116,6 +116,32 @@ T least_common_multiple(T a, T b)\nreturn (a * b) / greatest_common_divisor(a, b);\n}\n+\n+#if defined(_WIN64) || defined(_WIN32)\n+template <typename T>\n+inline constexpr bool __signbit__(T x, std::false_type is_signed) { return false; }\n+\n+template <typename T>\n+inline constexpr bool __signbit__(T x, std::true_type is_signed) { return x < T(0); }\n+#endif\n+\n+template <typename T>\n+inline bool signbit(T arg)\n+{\n+ #if defined(_WIN64) || defined(_WIN32)\n+ return tools::__signbit__(arg, std::is_signed<T>());\n+ #else\n+ return std::signbit(arg);\n+ #endif\n+}\n+\n+#if defined(_WIN64) || defined(_WIN32)\n+inline bool signbit (float x) { return std::signbit(arg);}\n+inline bool signbit (double x) { return std::signbit(arg);}\n+inline bool signbit (long double x) { return std::signbit(arg);}\n+#endif\n+\n+\n}\n}\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Implement our own tools::signbit function for MSVC else call std::signbit.
|
8,483 |
14.12.2018 16:36:59
| -3,600 |
0b52c64c274e21d0f057115f637c97e05fa6f9a1
|
Fix MSVC signbit
|
[
{
"change_type": "MODIFY",
"old_path": "src/Tools/Math/utils.h",
"new_path": "src/Tools/Math/utils.h",
"diff": "@@ -136,9 +136,9 @@ inline bool signbit(T arg)\n}\n#if defined(_WIN64) || defined(_WIN32)\n-inline bool signbit (float x) { return std::signbit(arg);}\n-inline bool signbit (double x) { return std::signbit(arg);}\n-inline bool signbit (long double x) { return std::signbit(arg);}\n+inline bool signbit (float arg) { return std::signbit(arg);}\n+inline bool signbit (double arg) { return std::signbit(arg);}\n+inline bool signbit (long double arg) { return std::signbit(arg);}\n#endif\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix MSVC signbit
|
8,483 |
14.12.2018 17:59:01
| -3,600 |
04a6cb8e070f05d2ad0241f2774c6793232a26d3
|
Add the Gallager E, that is the Gallager B with extended alphabet.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Decoder/LDPC/Decoder_LDPC.cpp",
"new_path": "src/Factory/Module/Decoder/LDPC/Decoder_LDPC.cpp",
"diff": "#include \"Module/Decoder/LDPC/BP/Horizontal_layered/ONMS/Decoder_LDPC_BP_horizontal_layered_ONMS_inter.hpp\"\n#include \"Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_A.hpp\"\n#include \"Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_B.hpp\"\n+#include \"Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_E.hpp\"\n#include \"Module/Decoder/LDPC/BP/Flooding/SPA/Decoder_LDPC_BP_flooding_SPA.hpp\"\n#include \"Module/Decoder/LDPC/BP/Peeling/Decoder_LDPC_BP_peeling.hpp\"\n#include \"Module/Decoder/LDPC/BF/OMWBF/Decoder_LDPC_bit_flipping_OMWBF.hpp\"\n@@ -76,7 +77,7 @@ void Decoder_LDPC::parameters\n#ifdef __cpp_aligned_new\ntools::add_options(args.at({p+\"-type\", \"D\"}), 0, \"BP_HORIZONTAL_LAYERED_LEGACY\");\n#endif\n- tools::add_options(args.at({p+\"-implem\" }), 0, \"SPA\", \"LSPA\", \"MS\", \"OMS\", \"NMS\", \"AMS\", \"GALA\", \"GALB\", \"WBF\");\n+ tools::add_options(args.at({p+\"-implem\" }), 0, \"SPA\", \"LSPA\", \"MS\", \"OMS\", \"NMS\", \"AMS\", \"GALA\", \"GALB\", \"GALE\", \"WBF\");\ntools::add_arg(args, p, class_name+\"p+ite,i\",\ntools::Integer(tools::Positive()));\n@@ -368,6 +369,7 @@ module::Decoder_SIHO<B,Q>* Decoder_LDPC::parameters\n{\nif (this->implem == \"GALA\") return new module::Decoder_LDPC_BP_flooding_GALA<B,Q>(this->K, this->N_cw, this->n_ite, H, info_bits_pos, this->enable_syndrome, this->syndrome_depth, this->n_frames);\nif (this->implem == \"GALB\") return new module::Decoder_LDPC_BP_flooding_GALB<B,Q>(this->K, this->N_cw, this->n_ite, H, info_bits_pos, this->enable_syndrome, this->syndrome_depth, this->n_frames);\n+ if (this->implem == \"GALE\") return new module::Decoder_LDPC_BP_flooding_GALE<B,Q>(this->K, this->N_cw, this->n_ite, H, info_bits_pos, this->enable_syndrome, this->syndrome_depth, this->n_frames);\n}\nelse if (this->type == \"BP_PEELING\")\n{\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "src/Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_E.cpp",
"diff": "+#include <chrono>\n+#include <algorithm>\n+#include <cmath>\n+#include <numeric>\n+#include <limits>\n+#include <sstream>\n+\n+#include \"Tools/Perf/common/hard_decide.h\"\n+#include \"Tools/Exception/exception.hpp\"\n+#include \"Tools/Math/utils.h\"\n+\n+#include \"Decoder_LDPC_BP_flooding_Gallager_E.hpp\"\n+\n+using namespace aff3ct;\n+using namespace aff3ct::module;\n+\n+template <typename B, typename R>\n+Decoder_LDPC_BP_flooding_Gallager_E<B,R>\n+::Decoder_LDPC_BP_flooding_Gallager_E(const int K, const int N, const int n_ite, const tools::Sparse_matrix &_H,\n+ const std::vector<unsigned> &info_bits_pos, const bool enable_syndrome,\n+ const int syndrome_depth, const int n_frames)\n+: Decoder (K, N, n_frames, 1 ),\n+ Decoder_SIHO_HIHO<B,R>(K, N, n_frames, 1 ),\n+ Decoder_LDPC_BP (K, N, n_ite, _H, enable_syndrome, syndrome_depth),\n+ info_bits_pos (info_bits_pos ),\n+ HY_N (N ),\n+ V_N (N ),\n+ chk_to_var (this->H.get_n_connections(), 0 ),\n+ var_to_chk (this->H.get_n_connections(), 0 ),\n+ transpose (this->H.get_n_connections() )\n+{\n+ const std::string name = \"Decoder_LDPC_BP_flooding_Gallager_E\";\n+ this->set_name(name);\n+\n+ std::vector<unsigned char> connections(this->H.get_n_rows(), 0);\n+\n+ const auto &chk_to_var_id = this->H.get_col_to_rows();\n+ const auto &var_to_chk_id = this->H.get_row_to_cols();\n+\n+ auto k = 0;\n+ for (auto i = 0; i < (int)chk_to_var_id.size(); i++)\n+ {\n+ for (auto j = 0; j < (int)chk_to_var_id[i].size(); j++)\n+ {\n+ auto var_id = chk_to_var_id[i][j];\n+\n+ auto branch_id = 0;\n+ for (auto ii = 0; ii < (int)var_id; ii++)\n+ branch_id += (int)var_to_chk_id[ii].size();\n+ branch_id += connections[var_id];\n+ connections[var_id]++;\n+\n+ if (connections[var_id] > (int)var_to_chk_id[var_id].size())\n+ {\n+ std::stringstream message;\n+ message << \"'connections[var_id]' has to be equal or smaller than 'var_to_chk_id[var_id].size()' \"\n+ << \"('var_id' = \" << var_id << \", 'connections[var_id]' = \" << connections[var_id]\n+ << \", 'var_to_chk_id[var_id].size()' = \" << var_to_chk_id[var_id].size() << \").\";\n+ throw tools::runtime_error(__FILE__, __LINE__, __func__, message.str());\n+ }\n+\n+ transpose[k] = branch_id;\n+ k++;\n+ }\n+ }\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_E<B,R>\n+::_decode_hiho(const B *Y_N, B *V_K, const int frame_id)\n+{\n+ std::transform(Y_N, Y_N + this->N, HY_N.begin(), [&](const B& in){ return B(1) - (in + in);});\n+\n+// auto t_decod = std::chrono::steady_clock::now(); // -------------------------------------------------------- DECODE\n+ this->_decode(HY_N.data());\n+// auto d_decod = std::chrono::steady_clock::now() - t_decod;\n+\n+// auto t_store = std::chrono::steady_clock::now(); // --------------------------------------------------------- STORE\n+ for (auto i = 0; i < this->K; i++)\n+ V_K[i] = (B)this->V_N[this->info_bits_pos[i]];\n+// auto d_store = std::chrono::steady_clock::now() - t_store;\n+\n+// (*this)[dec::tsk::decode_hiho].update_timer(dec::tm::decode_hiho::decode, d_decod);\n+// (*this)[dec::tsk::decode_hiho].update_timer(dec::tm::decode_hiho::store, d_store);\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_E<B,R>\n+::_decode_hiho_cw(const B *Y_N, B *V_N, const int frame_id)\n+{\n+ std::transform(Y_N, Y_N + this->N, HY_N.begin(), [&](const B& in){ return B(1) - (in + in);});\n+\n+// auto t_decod = std::chrono::steady_clock::now(); // -------------------------------------------------------- DECODE\n+ this->_decode(HY_N.data());\n+// auto d_decod = std::chrono::steady_clock::now() - t_decod;\n+\n+// auto t_store = std::chrono::steady_clock::now(); // --------------------------------------------------------- STORE\n+ std::copy(this->V_N.begin(), this->V_N.begin() + this->N, V_N);\n+// auto d_store = std::chrono::steady_clock::now() - t_store;\n+\n+// (*this)[dec::tsk::decode_hiho_cw].update_timer(dec::tm::decode_hiho_cw::decode, d_decod);\n+// (*this)[dec::tsk::decode_hiho_cw].update_timer(dec::tm::decode_hiho_cw::store, d_store);\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_E<B,R>\n+::_decode_siho(const R *Y_N, B *V_K, const int frame_id)\n+{\n+// auto t_load = std::chrono::steady_clock::now(); // ---------------------------------------------------------- LOAD\n+ tools::hard_decide(Y_N, HY_N.data(), this->N);\n+ std::transform(HY_N.begin(), HY_N.end(), HY_N.begin(), [&](const B& in){ return B(1) - (in + in);});\n+// auto d_load = std::chrono::steady_clock::now() - t_load;\n+\n+// auto t_decod = std::chrono::steady_clock::now(); // -------------------------------------------------------- DECODE\n+ this->_decode(HY_N.data());\n+// auto d_decod = std::chrono::steady_clock::now() - t_decod;\n+\n+// auto t_store = std::chrono::steady_clock::now(); // --------------------------------------------------------- STORE\n+ for (auto i = 0; i < this->K; i++)\n+ V_K[i] = (B)this->V_N[this->info_bits_pos[i]];\n+// auto d_store = std::chrono::steady_clock::now() - t_store;\n+\n+// (*this)[dec::tsk::decode_siho].update_timer(dec::tm::decode_siho::load, d_load);\n+// (*this)[dec::tsk::decode_siho].update_timer(dec::tm::decode_siho::decode, d_decod);\n+// (*this)[dec::tsk::decode_siho].update_timer(dec::tm::decode_siho::store, d_store);\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_E<B,R>\n+::_decode_siho_cw(const R *Y_N, B *V_N, const int frame_id)\n+{\n+// auto t_load = std::chrono::steady_clock::now(); // ---------------------------------------------------------- LOAD\n+ tools::hard_decide(Y_N, HY_N.data(), this->N);\n+ std::transform(HY_N.begin(), HY_N.end(), HY_N.begin(), [&](const B& in){ return B(1) - (in + in);});\n+// auto d_load = std::chrono::steady_clock::now() - t_load;\n+\n+\n+// auto t_decod = std::chrono::steady_clock::now(); // -------------------------------------------------------- DECODE\n+ this->_decode(HY_N.data());\n+// auto d_decod = std::chrono::steady_clock::now() - t_decod;\n+\n+// auto t_store = std::chrono::steady_clock::now(); // --------------------------------------------------------- STORE\n+ std::copy(this->V_N.begin(), this->V_N.begin() + this->N, V_N);\n+// auto d_store = std::chrono::steady_clock::now() - t_store;\n+\n+// (*this)[dec::tsk::decode_siho_cw].update_timer(dec::tm::decode_siho_cw::load, d_load);\n+// (*this)[dec::tsk::decode_siho_cw].update_timer(dec::tm::decode_siho_cw::decode, d_decod);\n+// (*this)[dec::tsk::decode_siho_cw].update_timer(dec::tm::decode_siho_cw::store, d_store);\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_E<B,R>\n+::_decode(const B *Y_N)\n+{\n+ auto ite = 0;\n+ for (; ite < this->n_ite; ite++)\n+ {\n+ scaling = ite < 2 ? 2 : 1;\n+\n+ this->_initialize_var_to_chk(Y_N, chk_to_var, var_to_chk, ite == 0);\n+ this->_decode_single_ite(var_to_chk, chk_to_var);\n+\n+ if (this->enable_syndrome && ite != this->n_ite -1)\n+ {\n+ // for the K variable nodes (make a majority vote with the entering messages)\n+ this->_make_majority_vote(Y_N, this->V_N);\n+ if (this->check_syndrome_hard(this->V_N.data()))\n+ break;\n+ }\n+ }\n+ if (ite == this->n_ite)\n+ this->_make_majority_vote(Y_N, this->V_N);\n+}\n+\n+\n+template <typename T> inline constexpr\n+T signum(T x, std::false_type is_signed) {\n+ return T(0) < x;\n+}\n+\n+template <typename T> inline constexpr\n+T signum(T x, std::true_type is_signed) {\n+ return (T(0) < x) - (x < T(0));\n+}\n+\n+template <typename T> inline constexpr\n+T signum(T x) {\n+ return signum(x, std::is_signed<T>());\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_E<B,R>\n+::_initialize_var_to_chk(const B *Y_N, const std::vector<int8_t> &chk_to_var, std::vector<int8_t> &var_to_chk,\n+ const bool first_ite)\n+{\n+ auto chk_to_var_ptr = chk_to_var.data();\n+ auto var_to_chk_ptr = var_to_chk.data();\n+\n+ // for each variable nodes\n+ const auto n_var_nodes = (int)this->H.get_n_rows();\n+ for (auto v = 0; v < n_var_nodes; v++)\n+ {\n+ const auto var_degree = (int)this->H.get_row_to_cols()[v].size();\n+ const auto cur_state = (int8_t)Y_N[v];\n+\n+ if (first_ite)\n+ {\n+ std::fill(var_to_chk_ptr, var_to_chk_ptr + var_degree, cur_state);\n+ }\n+ else\n+ {\n+ auto sum = std::accumulate(chk_to_var_ptr, chk_to_var_ptr + var_degree, (int)0);\n+ sum += scaling * cur_state;\n+\n+ // majority vote on each node\n+ for (auto c = 0; c < var_degree; c++)\n+ {\n+ auto diff = sum - chk_to_var_ptr[c];\n+ var_to_chk_ptr[c] = signum(diff);\n+ }\n+ }\n+\n+ chk_to_var_ptr += var_degree;\n+ var_to_chk_ptr += var_degree;\n+ }\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_E<B,R>\n+::_decode_single_ite(const std::vector<int8_t> &var_to_chk, std::vector<int8_t> &chk_to_var)\n+{\n+ auto transpose_ptr = this->transpose.data();\n+\n+ // for each check nodes\n+ const auto n_chk_nodes = (int)this->H.get_n_cols();\n+ for (auto c = 0; c < n_chk_nodes; c++)\n+ {\n+ const auto chk_degree = (int)this->H.get_col_to_rows()[c].size();\n+\n+ for (auto v = 0; v < chk_degree; v++)\n+ {\n+ auto acc = (int8_t)1;\n+ for (auto vv = 0; vv < chk_degree; vv++)\n+ if (v != vv)\n+ acc *= var_to_chk[transpose_ptr[vv]];\n+\n+ chk_to_var[transpose_ptr[v]] = acc;\n+ }\n+\n+ transpose_ptr += chk_degree;\n+ }\n+}\n+\n+template <typename B, typename R>\n+void Decoder_LDPC_BP_flooding_Gallager_E<B,R>\n+::_make_majority_vote(const B *Y_N, std::vector<int8_t> &V_N)\n+{\n+ auto chk_to_var_ptr = this->chk_to_var.data();\n+\n+ // for the K variable nodes (make a majority vote with the entering messages)\n+ const auto n_var_nodes = (int)this->H.get_n_rows();\n+ for (auto v = 0; v < n_var_nodes; v++)\n+ {\n+ const auto var_degree = (int)this->H.get_row_to_cols()[v].size();\n+ const auto cur_state = Y_N[v];\n+\n+ auto sum = std::accumulate(chk_to_var_ptr, chk_to_var_ptr + var_degree, (int)0);\n+ sum += cur_state;\n+\n+ // take the hard decision\n+ V_N[v] = tools::div2(B(1) -(sum == 0 ? cur_state : signum(sum)));\n+\n+ chk_to_var_ptr += var_degree;\n+ }\n+}\n+\n+// ==================================================================================== explicit template instantiation\n+#include \"Tools/types.h\"\n+#ifdef AFF3CT_MULTI_PREC\n+template class aff3ct::module::Decoder_LDPC_BP_flooding_Gallager_E<B_8,Q_8>;\n+template class aff3ct::module::Decoder_LDPC_BP_flooding_Gallager_E<B_16,Q_16>;\n+template class aff3ct::module::Decoder_LDPC_BP_flooding_Gallager_E<B_32,Q_32>;\n+template class aff3ct::module::Decoder_LDPC_BP_flooding_Gallager_E<B_64,Q_64>;\n+#else\n+template class aff3ct::module::Decoder_LDPC_BP_flooding_Gallager_E<B,Q>;\n+#endif\n+// ==================================================================================== explicit template instantiation\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "src/Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_E.hpp",
"diff": "+#ifndef DECODER_LDPC_BP_FLOODING_GALLAGER_E_HPP_\n+#define DECODER_LDPC_BP_FLOODING_GALLAGER_E_HPP_\n+\n+#include <cstdint>\n+\n+#include \"../../../../Decoder_SIHO_HIHO.hpp\"\n+#include \"../../Decoder_LDPC_BP.hpp\"\n+\n+namespace aff3ct\n+{\n+namespace module\n+{\n+template <typename B = int, typename R = float>\n+class Decoder_LDPC_BP_flooding_Gallager_E : public Decoder_SIHO_HIHO<B,R>, public Decoder_LDPC_BP\n+{\n+protected:\n+ const std::vector<uint32_t> &info_bits_pos;\n+\n+ std::vector<B > HY_N; // input LLRs (transformed in bit)\n+ std::vector<int8_t > V_N; // decoded bits\n+ std::vector<int8_t > chk_to_var; // check nodes to variable nodes messages\n+ std::vector<int8_t > var_to_chk; // variable nodes to check nodes messages\n+ std::vector<unsigned> transpose;\n+\n+ int scaling;\n+\n+public:\n+ Decoder_LDPC_BP_flooding_Gallager_E(const int K, const int N, const int n_ite, const tools::Sparse_matrix &H,\n+ const std::vector<unsigned> &info_bits_pos,\n+ const bool enable_syndrome = true,\n+ const int syndrome_depth = 1,\n+ const int n_frames = 1);\n+ virtual ~Decoder_LDPC_BP_flooding_Gallager_E() = default;\n+\n+protected:\n+ void _decode_hiho (const B *Y_N, B *V_K, const int frame_id);\n+ void _decode_hiho_cw(const B *Y_N, B *V_K, const int frame_id);\n+ void _decode_siho (const R *Y_N, B *V_K, const int frame_id);\n+ void _decode_siho_cw(const R *Y_N, B *V_K, const int frame_id);\n+\n+ void _decode (const B *Y_N);\n+ void _initialize_var_to_chk(const B *Y_N, const std::vector<int8_t> &chk_to_var, std::vector<int8_t> &var_to_chk,\n+ const bool first_ite);\n+ void _decode_single_ite (const std::vector<int8_t> &var_to_chk, std::vector<int8_t> &chk_to_var);\n+ void _make_majority_vote (const B *Y_N, std::vector<int8_t> &V_N);\n+};\n+\n+template <typename B = int, typename R = float>\n+using Decoder_LDPC_BP_flooding_GALE = Decoder_LDPC_BP_flooding_Gallager_E<B,R>;\n+}\n+}\n+\n+#endif /* DECODER_LDPC_BP_FLOODING_GALLAGER_E_HPP_ */\n"
},
{
"change_type": "MODIFY",
"old_path": "src/aff3ct.hpp",
"new_path": "src/aff3ct.hpp",
"diff": "#ifndef DECODER_LDPC_BP_FLOODING_GALLAGER_B_HPP_\n#include <Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_B.hpp>\n#endif\n+#ifndef DECODER_LDPC_BP_FLOODING_GALLAGER_E_HPP_\n+#include <Module/Decoder/LDPC/BP/Flooding/Gallager/Decoder_LDPC_BP_flooding_Gallager_E.hpp>\n+#endif\n#ifndef DECODER_LDPC_BP_FLOODING_SPA_HPP_\n#include <Module/Decoder/LDPC/BP/Flooding/SPA/Decoder_LDPC_BP_flooding_SPA.hpp>\n#endif\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add the Gallager E, that is the Gallager B with extended alphabet.
|
8,490 |
15.12.2018 13:51:18
| -3,600 |
edd1297efe721ff8c32806257664bee97aabf81e
|
Fix 'aff3ct' script.
|
[
{
"change_type": "MODIFY",
"old_path": "scripts/aff3ct",
"new_path": "scripts/aff3ct",
"diff": "@@ -24,4 +24,5 @@ if [[ $STR == *\"mkl_intel\"*\".so: cannot open shared object file\"* ]]; then\nsource /opt/intel/vars-intel.sh\nfi\n-eval $BIN \"$@\"\n\\ No newline at end of file\n+#eval $BIN \"$@\"\n+( $BIN \"$@\" )\n\\ No newline at end of file\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix 'aff3ct' script.
|
8,490 |
15.12.2018 13:52:36
| -3,600 |
60919257651b951423706a23dbcb203d0d6d476c
|
Fix the 'isFile::check' function to detect only files instead of files and directories.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Types/File_system/File_system.cpp",
"new_path": "src/Tools/Arguments/Types/File_system/File_system.cpp",
"diff": "@@ -29,8 +29,16 @@ bool aff3ct::tools::isFile::check(const std::string& filename)\n{\nstd::ifstream f(filename);\n- auto is_good = f.good();\n- std::cout << \"# (DBG) filename = '\" << filename << \"', exist = \" << is_good << std::endl;\n+ DIR *dp = opendir(filename.c_str());\n+\n+ std::cout << \"# (DBG) filename = '\" << filename << \"', exist = \" << (f.good() && !dp) << std::endl;\n+\n+ // if filename is a directory return false\n+ if (dp != nullptr)\n+ {\n+ closedir(dp);\n+ return false;\n+ }\nreturn f.good();\n}\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix the 'isFile::check' function to detect only files instead of files and directories.
|
8,490 |
15.12.2018 14:18:25
| -3,600 |
85298cc16e1b2233dd7e5a98aebdd05252e03027
|
Rename isFile, isPath, isFolder, noCheck in Is_file, Is_path, Is_folder, No_check.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Factory/Tools/Code/Polar/Frozenbits_generator.cpp",
"new_path": "src/Factory/Tools/Code/Polar/Frozenbits_generator.cpp",
"diff": "@@ -17,9 +17,9 @@ Frozenbits_generator::parameters\n::parameters(const std::string &prefix)\n: Factory::parameters(Frozenbits_generator_name, Frozenbits_generator_name, prefix)\n{\n- if (!tools::isPath::check(this->path_fb))\n+ if (!tools::Is_path::check(this->path_fb))\n{\n- auto new_path_fb = tools::modify_path<tools::isPath>(this->path_fb);\n+ auto new_path_fb = tools::modify_path<tools::Is_path>(this->path_fb);\nif (!new_path_fb.empty())\nthis->path_fb = new_path_fb;\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Maps/Argument_map_value.cpp",
"new_path": "src/Tools/Arguments/Maps/Argument_map_value.cpp",
"diff": "@@ -40,11 +40,11 @@ float Argument_map_value\nstd::string Argument_map_value::\nto_file(const Argument_tag &tags) const\n{\n- if (isFile::check(this->at(tags)))\n+ if (Is_file::check(this->at(tags)))\nreturn this->at(tags);\nelse\n{\n- auto new_str = modify_path<isFile>(this->at(tags));\n+ auto new_str = modify_path<Is_file>(this->at(tags));\nif (new_str.empty())\nreturn this->at(tags);\nelse\n@@ -55,11 +55,11 @@ to_file(const Argument_tag &tags) const\nstd::string Argument_map_value::\nto_folder(const Argument_tag &tags) const\n{\n- if (isFolder::check(this->at(tags)))\n+ if (Is_folder::check(this->at(tags)))\nreturn this->at(tags);\nelse\n{\n- auto new_str = modify_path<isFolder>(this->at(tags));\n+ auto new_str = modify_path<Is_folder>(this->at(tags));\nif (new_str.empty())\nreturn this->at(tags);\nelse\n@@ -70,11 +70,11 @@ to_folder(const Argument_tag &tags) const\nstd::string Argument_map_value::\nto_path(const Argument_tag &tags) const\n{\n- if (isPath::check(this->at(tags)))\n+ if (Is_path::check(this->at(tags)))\nreturn this->at(tags);\nelse\n{\n- auto new_str = modify_path<isPath>(this->at(tags));\n+ auto new_str = modify_path<Is_path>(this->at(tags));\nif (new_str.empty())\nreturn this->at(tags);\nelse\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Types/File_system/File.hpp",
"new_path": "src/Tools/Arguments/Types/File_system/File.hpp",
"diff": "@@ -9,10 +9,10 @@ namespace tools\n{\ntemplate <typename T = std::string, typename... Ranges>\n-class File_type : public File_system_type<T, isFile, noCheck, noCheck, Ranges...>\n+class File_type : public File_system_type<T, Is_file, No_check, No_check, Ranges...>\n{\npublic:\n- using parent_type = File_system_type<T, isFile, noCheck, noCheck, Ranges...>;\n+ using parent_type = File_system_type<T, Is_file, No_check, No_check, Ranges...>;\ntemplate <typename r, typename... R>\nexplicit File_type(const openmode& mode, const r* range, const R*... ranges)\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Types/File_system/File_system.cpp",
"new_path": "src/Tools/Arguments/Types/File_system/File_system.cpp",
"diff": "@@ -25,7 +25,7 @@ std::string aff3ct::tools::openmode_to_string(const openmode& mode)\nreturn str;\n}\n-bool aff3ct::tools::isFile::check(const std::string& filename)\n+bool aff3ct::tools::Is_file::check(const std::string& filename)\n{\nstd::ifstream f(filename);\n@@ -43,7 +43,7 @@ bool aff3ct::tools::isFile::check(const std::string& filename)\nreturn f.good();\n}\n-bool aff3ct::tools::isFolder::check(const std::string& foldername)\n+bool aff3ct::tools::Is_folder::check(const std::string& foldername)\n{\nDIR *dp = opendir(foldername.c_str());\n@@ -58,12 +58,12 @@ bool aff3ct::tools::isFolder::check(const std::string& foldername)\nreturn false;\n}\n-bool aff3ct::tools::isPath::check(const std::string& path)\n+bool aff3ct::tools::Is_path::check(const std::string& path)\n{\n- return isFile::check(path) || isFolder::check(path);\n+ return Is_file::check(path) || Is_folder::check(path);\n}\n-bool aff3ct::tools::noCheck::check(const std::string&)\n+bool aff3ct::tools::No_check::check(const std::string&)\n{\nreturn true;\n}\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Types/File_system/File_system.hpp",
"new_path": "src/Tools/Arguments/Types/File_system/File_system.hpp",
"diff": "@@ -63,27 +63,27 @@ std::string modify_path(const std::string& val)\nstd::string openmode_to_string(const openmode& mode);\n-struct isFile\n+struct Is_file\n{\nstatic bool check(const std::string& filename);\n};\n-struct isFolder\n+struct Is_folder\n{\nstatic bool check(const std::string& foldername);\n};\n-struct isPath\n+struct Is_path\n{\nstatic bool check(const std::string& path);\n};\n-struct noCheck\n+struct No_check\n{\nstatic bool check(const std::string&);\n};\n-template <typename T = std::string, typename Read_F = noCheck, typename Write_F = noCheck, typename RW_F = noCheck, typename... Ranges>\n+template <typename T = std::string, typename Read_F = No_check, typename Write_F = No_check, typename RW_F = No_check, typename... Ranges>\nclass File_system_type : public Argument_type_limited<T,Ranges...>\n{\nprotected:\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Types/File_system/Folder.hpp",
"new_path": "src/Tools/Arguments/Types/File_system/Folder.hpp",
"diff": "@@ -9,10 +9,10 @@ namespace tools\n{\ntemplate <typename T = std::string, typename... Ranges>\n-class Folder_type : public File_system_type<T, isFolder, noCheck, noCheck, Ranges...>\n+class Folder_type : public File_system_type<T, Is_folder, No_check, No_check, Ranges...>\n{\npublic:\n- using parent_type = File_system_type<T, isFolder, noCheck, noCheck, Ranges...>;\n+ using parent_type = File_system_type<T, Is_folder, No_check, No_check, Ranges...>;\ntemplate <typename r, typename... R>\nexplicit Folder_type(const openmode& mode, const r* range, const R*... ranges)\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Types/File_system/Path.hpp",
"new_path": "src/Tools/Arguments/Types/File_system/Path.hpp",
"diff": "@@ -9,10 +9,10 @@ namespace tools\n{\ntemplate <typename T = std::string, typename... Ranges>\n-class Path_type : public File_system_type<T, isPath, noCheck, noCheck, Ranges...>\n+class Path_type : public File_system_type<T, Is_path, No_check, No_check, Ranges...>\n{\npublic:\n- using parent_type = File_system_type<T, isPath, noCheck, noCheck, Ranges...>;\n+ using parent_type = File_system_type<T, Is_path, No_check, No_check, Ranges...>;\ntemplate <typename r, typename... R>\nexplicit Path_type(const openmode& mode, const r* range, const R*... ranges)\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Rename isFile, isPath, isFolder, noCheck in Is_file, Is_path, Is_folder, No_check.
|
8,490 |
15.12.2018 14:57:44
| -3,600 |
423325ff9e063b3a737e384acabe68f6da097d5c
|
Print debug infos.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Types/File_system/File_system.hpp",
"new_path": "src/Tools/Arguments/Types/File_system/File_system.hpp",
"diff": "@@ -26,6 +26,10 @@ std::string modify_path(const std::string& val)\nstd::string basedir, filename;\nsplit_path(binary_path, basedir, filename);\n+ std::cout << \"# (DBG) binary_path = '\" << binary_path << \"'\" << std::endl;\n+ std::cout << \"# (DBG) basedir = '\" << basedir << \"'\" << std::endl;\n+ std::cout << \"# (DBG) filename = '\" << filename << \"'\" << std::endl;\n+\nstd::string aff3ct_version = aff3ct::version();\nif (!aff3ct_version.empty() && aff3ct_version[0] == 'v')\naff3ct_version.erase(0, 1); // rm the 'v'\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Print debug infos.
|
8,490 |
15.12.2018 16:33:17
| -3,600 |
95e5cc6321cf4be1b4140962b0b5a9f607c3dcde
|
Fix a bug when getting the binary path, should resolve the CI bugs.
|
[
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Types/File_system/File_system.cpp",
"new_path": "src/Tools/Arguments/Types/File_system/File_system.cpp",
"diff": "@@ -31,8 +31,6 @@ bool aff3ct::tools::Is_file::check(const std::string& filename)\nDIR *dp = opendir(filename.c_str());\n- std::cout << \"# (DBG) filename = '\" << filename << \"', exist = \" << (f.good() && !dp) << std::endl;\n-\n// if filename is a directory return false\nif (dp != nullptr)\n{\n@@ -47,8 +45,6 @@ bool aff3ct::tools::Is_folder::check(const std::string& foldername)\n{\nDIR *dp = opendir(foldername.c_str());\n- std::cout << \"# (DBG) foldername = '\" << foldername << \"', exist = \" << (dp != nullptr) << std::endl;\n-\nif (dp != nullptr)\n{\nclosedir(dp);\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/Arguments/Types/File_system/File_system.hpp",
"new_path": "src/Tools/Arguments/Types/File_system/File_system.hpp",
"diff": "@@ -26,10 +26,6 @@ std::string modify_path(const std::string& val)\nstd::string basedir, filename;\nsplit_path(binary_path, basedir, filename);\n- std::cout << \"# (DBG) binary_path = '\" << binary_path << \"'\" << std::endl;\n- std::cout << \"# (DBG) basedir = '\" << basedir << \"'\" << std::endl;\n- std::cout << \"# (DBG) filename = '\" << filename << \"'\" << std::endl;\n-\nstd::string aff3ct_version = aff3ct::version();\nif (!aff3ct_version.empty() && aff3ct_version[0] == 'v')\naff3ct_version.erase(0, 1); // rm the 'v'\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Tools/system_functions.cpp",
"new_path": "src/Tools/system_functions.cpp",
"diff": "@@ -200,15 +200,17 @@ std::string aff3ct::tools::get_binary_path()\nconstexpr size_t path_size = 8192;\nchar path[path_size];\n#ifdef __FreeBSD__\n- if (readlink(\"/proc/curproc/file\", path, path_size) == -1)\n+ auto len = readlink(\"/proc/curproc/file\", path, path_size);\n#else\n- if (readlink(\"/proc/self/exe\", path, path_size) == -1)\n+ auto len = readlink(\"/proc/self/exe\", path, path_size);\n#endif\n+ if (len == -1)\n{\nstd::stringstream message;\nmessage << \"'readlink' failed ('errno' = \" << strerror(errno) << \").\";\nthrow runtime_error(__FILE__, __LINE__, __func__, message.str());\n}\n+ path[len] = '\\0';\nbinary_path = path;\n#elif defined(__APPLE__) || defined(__MACH__)\nconstexpr size_t path_size = 8192;\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Fix a bug when getting the binary path, should resolve the CI bugs.
|
8,490 |
16.12.2018 13:46:24
| -3,600 |
c5f3ec015b3557af844a6ef62c39278648c961f1
|
Set the number of caracter to 7 in 'git describe' short hash.
|
[
{
"change_type": "MODIFY",
"old_path": "ci/tools/git-version.sh",
"new_path": "ci/tools/git-version.sh",
"diff": "#!/bin/bash\n# set -x\n-GIT_VERSION=$(git describe)\n+GIT_VERSION=$(git describe --abbrev=7)\nif [ ! -z \"$GIT_VERSION\" ]\nthen\n"
},
{
"change_type": "MODIFY",
"old_path": "cmake/Modules/GetGitRevisionDescription.cmake",
"new_path": "cmake/Modules/GetGitRevisionDescription.cmake",
"diff": "@@ -113,6 +113,7 @@ function(git_describe _var)\nexecute_process(COMMAND\n\"${GIT_EXECUTABLE}\"\ndescribe\n+ --abbrev=7\n${hash}\n${ARGN}\nWORKING_DIRECTORY\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Set the number of caracter to 7 in 'git describe' short hash.
|
8,483 |
17.12.2018 08:28:33
| -3,600 |
124a51a854152a56725c86d81379e17615d1191c
|
Add refs for GALE and new matrix IRA 4/5
|
[
{
"change_type": "MODIFY",
"old_path": "conf",
"new_path": "conf",
"diff": "-Subproject commit b53be8355eeff5abc8e528c52a1d6ead685d1f74\n+Subproject commit 898cbd8dc21ea05986043794dac90c4de17f4ab1\n"
},
{
"change_type": "MODIFY",
"old_path": "refs",
"new_path": "refs",
"diff": "-Subproject commit 697a2915c5ba3ba618ef919fae5555b50b89e0a4\n+Subproject commit e58523ed874613977b0b956d6cfd973d4fea95d4\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Add refs for GALE and new matrix IRA 4/5
|
8,483 |
17.12.2018 08:32:01
| -3,600 |
39e9fdb7f913429e866a801167bfed0992a8a3d7
|
Doc: Add Gallager E
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/conf.py",
"new_path": "doc/sphinx/source/conf.py",
"diff": "@@ -291,6 +291,7 @@ rst_epilog = \"\"\"\n.. |GA| replace:: :abbr:`GA (Gaussian Approximation)`\n.. |GALA| replace:: :abbr:`GALA (Gallager A)`\n.. |GALB| replace:: :abbr:`GALB (Gallager B)`\n+.. |GALE| replace:: :abbr:`GALE (Gallager E)`\n.. |GNU| replace:: :abbr:`GNU (GNU's Not Unix!)`\n.. |GPP| replace:: :abbr:`GPP (General Purpose Processor)`\n.. |GPPs| replace:: :abbr:`GPPs (General Purpose Processors)`\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/codec/ldpc/decoder.rst",
"diff": "@@ -69,8 +69,8 @@ Description of the allowed values:\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n:Type: text\n- :Allowed values: ``STD`` ``GALA`` ``GALB`` ``WBF`` ``SPA`` ``LSPA`` ``AMS`` ``MS``\n- ``NMS`` ``OMS``\n+ :Allowed values: ``STD`` ``GALA`` ``GALB`` ``GALE`` ``WBF`` ``SPA`` ``LSPA``\n+ ``AMS`` ``MS`` ``NMS`` ``OMS``\n:Default: ``SPA``\n:Examples: ``--dec-implem AMS``\n@@ -78,29 +78,31 @@ Description of the allowed values:\nDescription of the allowed values:\n-+-----------+------------------------------------------------------------------+\n++-----------+------------------------------------------------------------------------+\n| Value | Description |\n-+===========+==================================================================+\n++===========+========================================================================+\n| ``STD`` | Select the |STD| implementation. |\n-+-----------+------------------------------------------------------------------+\n++-----------+------------------------------------------------------------------------+\n| ``GALA`` | Select the |GALA| algorithm :cite:`Ryan2009`. |\n-+-----------+------------------------------------------------------------------+\n-| ``GALB`` | Select the |GALB| algorithm :cite:`Declerq2014`. |\n-+-----------+------------------------------------------------------------------+\n++-----------+------------------------------------------------------------------------+\n+| ``GALB`` | Select the |GALB| algorithm :cite:`Declerq2014` with majority vote. |\n++-----------+------------------------------------------------------------------------+\n+| ``GALE`` | Select the |GALE| algorithm :cite:`Declerq2014` with extended alphabet.|\n++-----------+------------------------------------------------------------------------+\n| ``WBF`` | Select the |WBF| algorithm :cite:`Wadayama2010`. |\n-+-----------+------------------------------------------------------------------+\n++-----------+------------------------------------------------------------------------+\n| ``SPA`` | Select the |SPA| update rules :cite:`MacKay1995`. |\n-+-----------+------------------------------------------------------------------+\n++-----------+------------------------------------------------------------------------+\n| ``LSPA`` | Select the |LSPA| update rules :cite:`MacKay1995`. |\n-+-----------+------------------------------------------------------------------+\n++-----------+------------------------------------------------------------------------+\n| ``AMS`` | Select the |AMS| update rule. |\n-+-----------+------------------------------------------------------------------+\n++-----------+------------------------------------------------------------------------+\n| ``MS`` | Select the |MS| update rule :cite:`Fossorier1999`. |\n-+-----------+------------------------------------------------------------------+\n++-----------+------------------------------------------------------------------------+\n| ``NMS`` | Select the |NMS| update rule :cite:`Chen2002`. |\n-+-----------+------------------------------------------------------------------+\n++-----------+------------------------------------------------------------------------+\n| ``OMS`` | Select the |OMS| update rule :cite:`Chen2002`. |\n-+-----------+------------------------------------------------------------------+\n++-----------+------------------------------------------------------------------------+\n:numref:`tab_ldpc_dec_implem` shows the different decoder types and their\ncorresponding available implementations.\n@@ -110,19 +112,19 @@ corresponding available implementations.\n.. table:: |LDPC| decoder types and available implementations.\n:align: center\n- +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n- | Decoder ||STD|||GALA|||GALB|||WBF|||SPA|||LSPA|||AMS|||MS|||NMS|||OMS||\n- +=========+=====+======+======+=====+=====+======+=====+====+=====+=====+\n- | |BF| | | | ||K| | | | | | | |\n- +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n- | |BP-P| ||K| | | | | | | | | | |\n- +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n- | |BP-F| | ||K| ||K| | ||K3| ||K2| ||K2| ||K2|||K2| ||K2| |\n- +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n- | |BP-HL| | | | | ||K2| ||K2| ||K2| ||K1|||K1| ||K1| |\n- +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n- | |BP-VL| | | | | ||K2| ||K2| ||K2| ||K2|||K2| ||K2| |\n- +---------+-----+------+------+-----+-----+------+-----+----+-----+-----+\n+ +---------+-----+------+------+------+-----+-----+------+-----+----+-----+-----+\n+ | Decoder ||STD|||GALA|||GALB|||GALE|||WBF|||SPA|||LSPA|||AMS|||MS|||NMS|||OMS||\n+ +=========+=====+======+======+======+=====+=====+======+=====+====+=====+=====+\n+ | |BF| | | | | ||K| | | | | | | |\n+ +---------+-----+------+------+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-P| ||K| | | | | | | | | | | |\n+ +---------+-----+------+------+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-F| | ||K| ||K| ||K| | ||K3| ||K2| ||K2| ||K2|||K2| ||K2| |\n+ +---------+-----+------+------+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-HL| | | | | | ||K2| ||K2| ||K2| ||K1|||K1| ||K1| |\n+ +---------+-----+------+------+------+-----+-----+------+-----+----+-----+-----+\n+ | |BP-VL| | | | | | ||K2| ||K2| ||K2| ||K2|||K2| ||K2| |\n+ +---------+-----+------+------+------+-----+-----+------+-----+----+-----+-----+\n.. |K| replace:: :math:`\\checkmark`\n.. |K1| replace:: :math:`\\checkmark^{*}`\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: Add Gallager E
|
8,483 |
17.12.2018 11:31:46
| -3,600 |
3f39eb575a36e934d898753921ffd251d282da04
|
Update conf/ refs/ and write doc on SCMA codebooks
|
[
{
"change_type": "MODIFY",
"old_path": "conf",
"new_path": "conf",
"diff": "-Subproject commit 94af1080719a0b616d00ea2a1694f5d0526d08a4\n+Subproject commit 17f6606028d542a7c06bdec56869114e2c065f1d\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/modem/modem.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/modem/modem.rst",
"diff": "@@ -387,6 +387,69 @@ Where |n0_equation|\nSee the :ref:`mdm-mdm-no-sig2` parameter to disable the division by\n:math:`\\sigma^2`.\n+.. _mdm-mdm-codebook:\n+\n+``--mdm-codebook``\n+\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n+\n+ :Type: file\n+ :Rights: read/write\n+ :Examples: ``--mdm-codebook ../conf/mod/SCMA/CS1.cb``\n+\n+|factory::Modem::parameters::p+codebook|\n+\n+.. rubric:: Codebook format\n+\n+A codebook is designed for a **number_of_users** :math:`V`, a\n+**number_of_orthogonal_resources** :math:`K` and **codebook_size** :math:`M`.\n+\n+The codebook file then looks as a table of :math:`V \\times K` rows and\n+:math:`2.M` columns (real and imaginary parts)::\n+\n+ V K M\n+\n+ Re(User 1, Resource 1, Code 1) Im(User 1, Resource 1, Code 1) ... Re(User 1, Resource 1, Code M) Im(User 1, Resource 1, Code M)\n+ ... ... ... ... ...\n+ Re(User 1, Resource K, Code 1) Im(User 1, Resource K, Code 1) ... Re(User 1, Resource K, Code M) Im(User 1, Resource K, Code M)\n+ Re(User 2, Resource 1, Code 1) Im(User 2, Resource 1, Code 1) ... Re(User 2, Resource 1, Code M) Im(User 2, Resource 1, Code M)\n+ ... ... ... ... ...\n+ Re(User 2, Resource K, Code 1) Im(User 2, Resource K, Code 1) ... Re(User 2, Resource K, Code M) Im(User 2, Resource K, Code M)\n+ ... ... ... ... ...\n+ Re(User V, Resource 1, Code 1) Im(User V, Resource 1, Code 1) ... Re(User V, Resource 1, Code M) Im(User V, Resource 1, Code M)\n+ ... ... ... ... ...\n+ Re(User V, Resource K, Code 1) Im(User V, Resource K, Code 1) ... Re(User V, Resource K, Code M) Im(User V, Resource K, Code M)\n+\n+\n+.. rubric:: Descriptions of the codebooks of the configuration files\n+\n+Codebooks are normalized, so the average power of signal will be equal to 1.\n+\n++-------------+------------------------------------------------------------------+\n+| Codebook Set| Description |\n++=============+==================================================================+\n+| **CS1** | From :cite:`Altera` |\n++-------------+------------------------------------------------------------------+\n+| **CS2** | LDS based on QPSK constellation |\n++-------------+------------------------------------------------------------------+\n+| **CS3** | Based on :cite:`Cheng2015` and own optimization for AWGN channel |\n++-------------+------------------------------------------------------------------+\n+| **CS4** | From :cite:`Zhang2016` |\n++-------------+------------------------------------------------------------------+\n+| **CS5** | From :cite:`SongWC2016` |\n++-------------+------------------------------------------------------------------+\n+| **CS6** | From :cite:`Klimentyev2017` |\n++-------------+------------------------------------------------------------------+\n+| **CS7** | From :cite:`Klimentyev2017` |\n++-------------+------------------------------------------------------------------+\n+| **CS8** | From :cite:`Wu2015` |\n++-------------+------------------------------------------------------------------+\n+\n+The simulation results for **CS1**-**CS7** (|AWGN| and Rayleigh fading channels)\n+can be found in :cite:`Klimentyev2017`.\n+The simulation results for **CS8** can be found in :cite:`Klimentyev2016`\n+(defined as **CS2** in the paper).\n+\n+\n.. _mdm-mdm-rop-est:\n``--mdm-rop-est``\n@@ -406,3 +469,4 @@ References\n\"\"\"\"\"\"\"\"\"\"\n.. bibliography:: references.bib\n+.. bibliography:: references_scma.bib\n\\ No newline at end of file\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "doc/sphinx/source/user/simulation/parameters/modem/references_scma.bib",
"diff": "+@Misc{Altera,\n+ author = {Altera University Program},\n+ title = {The 1st 5G Algorithm Innovation Competition-SCMA },\n+ file = {online:http://www.innovateasia.com/5g/images/pdf/1st%205G%20Algorithm%20Innovation%20Competition-ENV1.0%20-%20SCMA.pdf:PDF},\n+ groups = {5G},}\n+\n+@InProceedings{Cheng2015,\n+author = {M. Cheng and Y. Wu and Y. Chen},\n+booktitle = {International Conference on Wireless Communications Signal Processing (WCSP)},\n+title = {Capacity Analysis for Non-orthogonal Overloading Transmissions under Constellation Constraints},\n+year = {2015},\n+pages = {1-5},\n+abstract = {In this work, constellation constrained (CC) capacities of a series of non-orthogonal overloading transmission schemes are derived in AWGN channels. All these schemes follow a similar transmission structure, in which modulated symbols are spread on to a group of resource elements (REs) in a sparse manner, i.e., only a part of the REs have nonzero components while the others are filled with zeros. The multiple access schemes follow this structure is called sparse code multiple access (SCMA) in general. In particular, a complete SCMA scheme would combine multi-dimensional modulation and the low density spreading (LDS) together such that the symbols from the same data layer on different REs are different but dependent. If the spread symbols are the same, it is a simplified implementation of SCMA and is called LDS. Furthermore, depending on whether the numbers of non-zero components for each data layer are equal or not, there are regular LDS (LDS in short) and irregular LDS (IrLDS), respectively. The paper would show from theoretical derivation and simulation results that the complete SCMA schemes outperform the simplified version LDS/IrLDS. Moreover, we also show that the application of phase rotation in the modulator can significantly boost the link performance of such non-orthogonal multiple access schemes.},\n+keywords = {AWGN channels;code division multiple access;nonorthogonal overloading transmission capacity analysis;constellation constraint;AWGN channel;resource element;sparse code multiple access scheme;SCMA scheme;multidimensional modulation;low density spreading;nonorthogonal multiple access scheme link performance;code division multiple access;Nickel;Modulation;5G mobile communication;Multiaccess communication;Sparse matrices;AWGN channels;Simulation;SCMA;LDS;IrLDS;Constellation Constrained capacity;Non-orthogonal multiple access},\n+doi = {10.1109/WCSP.2015.7341294},\n+month = {Oct},}\n+\n+@InProceedings{Zhang2016,\n+author = {S. Zhang and K. Xiao and B. Xiao and Z. Chen and B. Xia and D. Chen and S. Ma},\n+booktitle = {International Conference on Wireless Communications Signal Processing (WCSP)},\n+title = {A Capacity-based Codebook Design Method for Sparse Code Multiple Access Systems},\n+year = {2016},\n+pages = {1-5},\n+abstract = {Sparse code multiple access (SCMA) is a novel non-orthogonal multiple access scheme, which exploits a multidimensional constellation based on the non-orthogonal spreading technique. The SCMA multi-user codebook design is the bottleneck of system performance and there is no design guideline from the perspective of capacity. In this paper, a novel SCMA codebook design scheme is proposed to maximize the sum rate, where we transfer the design of multi-dimensional constellation sets to the optimizing of series of 1-dimensional complex codewords. Specifically, a basic M-order pulse-amplitude modulation (PAM) is optimized and then the angles of rotation between the input 1-dimensional constellation and the basic M-PAM constellation can be obtained within a feasible calculation complexity to improve the sum-rate. Finally, the series of 1-dimensional complex codewords are combined to construct multi-dimensional codebooks based on Latin square criterion. Numerical results illustrate that the proposed codebook outperforms the existing codebook by 1.3 dB over AWGN channel and 1.1 dB over Rayleigh channel in terms of bit error rate (BER) performance.},\n+keywords = {AWGN channels;error statistics;multi-access systems;pulse amplitude modulation;Rayleigh channels;capacity-based codebook design;sparse code multiple access systems;non-orthogonal multiple access scheme;non-orthogonal spreading;SCMA;multi-user codebook design;M-order pulse-amplitude modulation;PAM;Latin square criterion;AWGN channel;Rayleigh channel;bit error rate;BER;Design methodology;Modulation;Signal to noise ratio;NOMA;Uplink;Optimization;Receivers},\n+doi = {10.1109/WCSP.2016.7752620},\n+ISSN = {2472-7628},\n+month = {Oct},}\n+\n+@Article{SongWC2016,\n+author={G. Song and X. Wang and J. Cheng},\n+journal={IEEE Access},\n+title={Signature Design of Sparsely Spread Code Division Multiple Access Based on Superposed Constellation Distance Analysis},\n+year={2017},\n+volume={5},\n+pages={23809-23821},\n+abstract={Sparsely spread code division multiple access (SCDMA) is a non-orthogonal superposition coding scheme that allows concurrent communications between a base station and multiple users over a common channel. However, the detection performance of an SCDMA system is mainly determined by its signature matrix, which should be sparse to facilitate the belief propagation (BP) detection. On the other hand, to guarantee good maximum likelihood (ML) detection performance, the minimum Euclidean distance for the equivalent signal constellation after multi-user superposition should be maximized. In this paper, a code distance analysis is proposed for SCDMA systems with a finite number of users and spreading lengths. Based on this analysis, good signature matrices whose factor graphs have very few short cycles and possess large superposed signal constellation distances are designed. The proposed signature matrices have both good BP and ML detection performances. Moreover, their BP detection performances exactly converge to their ML detection performances with few iterations. It is worth pointing out that the proposed signature matrix design could be directly applied to the 5G non-orthogonal multiple access systems.},\n+keywords={channel coding;code division multiple access;interference suppression;matrix algebra;radio links;radio receivers;radiofrequency interference;signal detection;signature design;sparsely spread code division multiple access;superposed constellation distance analysis;nonorthogonal superposition coding scheme;concurrent communications;base station;multiple users;common channel;SCDMA system;belief propagation detection;minimum Euclidean distance;equivalent signal constellation;multiuser superposition;code distance analysis;spreading lengths;superposed signal constellation distances;ML detection performances;BP detection performances;signature matrix design;5G nonorthogonal multiple access systems;maximum likelihood detection performance;Multiaccess communication;Sparse matrices;Quadrature amplitude modulation;NOMA;Base stations;Complexity theory;Constellation diagram;Non-orthogonal multiple access;sparsely spread;signature design;code distance},\n+doi={10.1109/ACCESS.2017.2765346},\n+ISSN={2169-3536},}\n+\n+@InProceedings{Klimentyev2017,\n+author={V. P. Klimentyev and A. B. Sergienko},\n+booktitle={European Wireless Conference},\n+title={SCMA Codebooks Optimization Based on Genetic Algorithm},\n+year={2017},\n+pages={1-6},\n+abstract={Sparse code multiple access (SCMA) is a nonorthogonal multiple access scheme based on joint modulation and spread spectrum procedure. This scheme allows to increase the number of active users inside a given time-frequency resource. Design of SCMA codebooks is a challenging problem. The paper considers the design of SCMA codebooks based on Genetic Algorithm (GA). In general case, mother constellation is not required for GA, and optimization is performed directly on the codebooks. We present the obtained structured codebooks containing two antipodal codeword pairs. Optimization was carried out to improve SCMA signal performance in additive white Gaussian noise (AWGN) channel by constraining the average energy of codewords. The obtained codebooks have minimum Euclidean distance equal to 0.87 (at unit average power of SCMA signal) and outperform known codebooks in AWGN channel with both Maximum Likelihood (ML) receiver or Message Passing Algorithm (MPA) detection. The comparison of existing and proposed codebooks is performed using computer simulation and union bounds. The asymptotic gain over the best known codebooks is 0.8 dB. As a result of the simulation, proposed codebooks demonstrate similar performance for ML and MPA detection algorithms. The proposed method is suitable for codebook design for other non-orthogonal schemes, e. g., Pattern Division Multiple Access (PDMA).},\n+doi={},\n+ISSN={},\n+month={May},}\n+\n+@InProceedings{Wu2015,\n+author={Y. Wu and S. Zhang and Y. Chen},\n+booktitle={IEEE International Conference on Communications (ICC)},\n+title={Iterative Multiuser Receiver in Sparse Code Multiple Access Systems},\n+year={2015},\n+pages={2918-2923},\n+abstract={Sparse code multiple access (SCMA) is a novel non-orthogonal multiple access scheme, in which multiple users access the same channel with user-specific sparse codewords. In this paper, we consider an uplink SCMA system employing channel coding, and develop an iterative multiuser receiver which fully utilizes the diversity gain and coding gain in the system. The simulation results demonstrate the superiority of the proposed iterative receiver over the non-iterative one, and the performance gain increases with the system load. It is also shown that SCMA can work well in highly overloaded scenario, and the link-level performance does not degrade even if the load is as high as 300%.},\n+keywords={channel coding;iterative methods;receivers;iterative multiuser receiver;sparse code multiple access systems;novel nonorthogonal multiple access scheme;uplink SCMA system;channel coding;diversity gain;coding gain;OFDM;Decoding;Complexity theory},\n+doi={10.1109/ICC.2015.7248770},\n+ISSN={1550-3607},\n+month={June},}\n+\n+@InProceedings{Klimentyev2016,\n+author={V. P. Klimentyev and A. B. Sergienko},\n+booktitle={Conference of Open Innovations Association and Seminar on Information Security and Protection of Information Technology (FRUCT-ISPIT)},\n+title={Detection of SCMA Signal with Channel Estimation Error},\n+year={2016},\n+pages={106-112},\n+abstract={Fifth generation wireless communication systems should support, among other things, very large number of simultaneous connections. To address this requirement, various schemes of non-orthogonal multiple access (NOMA) were proposed that allow to increase the number of simultaneously active users. One of NOMA schemes is sparse code multiple access (SCMA), where sparse multidimensional codewords allow to use iterative detecting algorithms with reasonable complexity. In the paper, SCMA detection is investigated in the presence of channel estimation error. Uncoded and turbo coded SCMA is analyzed. Uplink channel with Rayleigh flat block fading is assumed. Simulation results show that required accuracy of the channel estimation depends on the turbo code block length. For full utilization of turbo code error-correction capability with short blocks (40 bits) normalized variance of channel estimation error should be less than 10<sup>-3</sup>, the same value applies to the case of uncoded SCMA. For turbo code with long blocks (1024 bits), estimation can be less accurate, with normalized variance up to 10<sup>-2</sup>. With such channel estimation accuracy, power loss is about 0.6-0.7 dB compared with the case of perfect estimation. Two different types of codebooks have shown the same performance for coded SCMA, that leads to conclusion that codebook with more simple structure that provides less complexity of detection algorithm is a good candidate for use in SCMA schemes. The comparison with traditional orthogonal multiple access scheme with the same overall spectral efficiency is provided for both uncoded and coded SCMA systems. In case of coded system, SCMA scheme is shown to have smaller BER in the range of bit error probabilities below 10<sup>-4</sup>-10<sup>-5</sup> for long blocks. The power gain is 0.5-1 dB for long blocks and a few tenths of dB for short blocks.},\n+keywords={block codes;channel coding;channel estimation;error correction codes;error statistics;multi-access systems;Rayleigh channels;signal detection;turbo codes;SCMA signal detection;channel estimation error;fifth generation wireless communication system;nonorthogonal multiple access scheme;NOMA scheme;sparse code multiple access;sparse multidimensional codeword;iterative detecting algorithm;turbo coded SCMA analyzed;uncoded SCMA analysis;uplink channel;Rayleigh flat block fading;turbo code error-correction capability;BER;bit error probability;Channel estimation;Fading channels;NOMA;Complexity theory;Turbo codes;Estimation;5G mobile communication},\n+doi={10.1109/FRUCT-ISPIT.2016.7561515},\n+ISSN={2305-7254},\n+month={April},}\n\\ No newline at end of file\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "doc/sphinx/source/user/simulation/parameters/modem/scma_readme.rst",
"diff": "+../../../../../../../conf/mod/SCMA/README.rst\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "refs",
"new_path": "refs",
"diff": "-Subproject commit 2f796ebad8418de171327aa07139bc8ae6e26444\n+Subproject commit 1d03a6e63c42d525266203285175fd9f9c0259ad\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Update conf/ refs/ and write doc on SCMA codebooks
|
8,490 |
17.12.2018 17:32:53
| -3,600 |
4253fa9d246cd76a47dcf9417455d5e2a609be1d
|
Use properly the '--abbrev' parameter.
|
[
{
"change_type": "MODIFY",
"old_path": "CMakeLists.txt",
"new_path": "CMakeLists.txt",
"diff": "@@ -79,7 +79,7 @@ set(AFF3CT_COMPILE_OPTIONS \"\")\ninclude(GetGitRevisionDescription)\nget_git_head_revision(GIT_REFSPEC GIT_SHA1)\n-git_describe(GIT_VERSION \"--tags\")\n+git_describe(GIT_VERSION \"--tags\" \"--abbrev=7\")\nstring(REGEX REPLACE \"^v\" \"\" GIT_VERSION_RMV ${GIT_VERSION})\nstring(REGEX REPLACE \"-.*\" \"\" GIT_VERSION_MMP ${GIT_VERSION_RMV})\n"
},
{
"change_type": "MODIFY",
"old_path": "cmake/Modules/GetGitRevisionDescription.cmake",
"new_path": "cmake/Modules/GetGitRevisionDescription.cmake",
"diff": "@@ -113,7 +113,6 @@ function(git_describe _var)\nexecute_process(COMMAND\n\"${GIT_EXECUTABLE}\"\ndescribe\n- --abbrev=7\n${hash}\n${ARGN}\nWORKING_DIRECTORY\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Use properly the '--abbrev' parameter.
|
8,483 |
18.12.2018 08:15:03
| -3,600 |
eccb778c0f4337490a7af32b5c1315cb758748ce
|
Doc: change '../conf' example path to 'conf/'.
|
[
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/interleaver/interleaver.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/interleaver/interleaver.rst",
"diff": "@@ -120,7 +120,7 @@ Description of the allowed values:\n:Type: file\n:Rights: read only\n- :Examples: ``--itl-path ../conf/itl/GSM-LDPC_4224.itl``\n+ :Examples: ``--itl-path conf/itl/GSM-LDPC_4224.itl``\n|factory::Interleaver_core::parameters::p+path|\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/modem/modem.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/modem/modem.rst",
"diff": "@@ -109,7 +109,7 @@ to 3.\n:Type: file\n:Rights: read/write\n- :Examples: ``--mdm-const-path ../conf/mod/16QAM_ANTI_GRAY.mod``\n+ :Examples: ``--mdm-const-path conf/mod/16QAM_ANTI_GRAY.mod``\n|factory::Modem::parameters::p+const-path|\n@@ -393,10 +393,12 @@ See the :ref:`mdm-mdm-no-sig2` parameter to disable the division by\n:Type: file\n:Rights: read/write\n- :Examples: ``--mdm-codebook ../conf/mod/SCMA/CS1.cb``\n+ :Examples: ``--mdm-codebook conf/mod/SCMA/CS1.cb``\n|factory::Modem::parameters::p+codebook|\n+.. note:: Only 3 |BPS| codebook symbols are supported at this time.\n+\n.. rubric:: Codebook format\nA codebook is designed for a **number_of_users** :math:`V`, a\n@@ -418,7 +420,6 @@ The codebook file then looks as a table of :math:`V \\times K` rows and\n... ... ... ... ...\nRe(User V, Resource K, Code 1) Im(User V, Resource K, Code 1) ... Re(User V, Resource K, Code M) Im(User V, Resource K, Code M)\n-\n.. rubric:: Descriptions of the codebooks of the configuration files\nCodebooks are normalized, so the average power of signal will be equal to 1.\n@@ -449,6 +450,7 @@ The simulation results for **CS8** can be found in :cite:`Klimentyev2016`\n(defined as **CS2** in the paper).\n+\n.. _mdm-mdm-rop-est:\n``--mdm-rop-est``\n"
},
{
"change_type": "DELETE",
"old_path": "doc/sphinx/source/user/simulation/parameters/modem/scma_readme.rst",
"new_path": null,
"diff": "-../../../../../../../conf/mod/SCMA/README.rst\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "doc/sphinx/source/user/simulation/parameters/source/source.rst",
"new_path": "doc/sphinx/source/user/simulation/parameters/source/source.rst",
"diff": "@@ -116,7 +116,7 @@ modulation (see the :ref:`mdm-mdm-type` ``SCMA`` parameter).\n:Type: file\n:Rights: read only\n- :Examples: ``--src-path ../conf/src/GSM-LDPC_2112.src``\n+ :Examples: ``--src-path conf/src/GSM-LDPC_2112.src``\n|factory::Source::parameters::p+path|\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Doc: change '../conf' example path to 'conf/'.
|
8,483 |
18.12.2018 08:45:34
| -3,600 |
a5f26938500b5af168791061cf3a0e36821258e0
|
Remove bps parameter to the Modem_SCMA because this information is already in the codebook. Need to construct the codebook first and to pass it by argument to the SCMA.
|
[
{
"change_type": "DELETE",
"old_path": "codebook_basic.cb",
"new_path": null,
"diff": "-6 4 4\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n--0.1815 -0.1318 -0.6351 -0.4615 0.6351 0.4615 0.1815 0.1318\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n- 0.7851 0.0000 -0.2243 0.0000 0.2243 0.0000 -0.7851 0.0000\n- 0.7851 0.0000 -0.2243 0.0000 0.2243 0.0000 -0.7851 0.0000\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n--0.1815 -0.1318 -0.6351 -0.4615 0.6351 0.4615 0.1815 0.1318\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n--0.6351 0.4615 0.1815 -0.1318 -0.1815 0.1318 0.6351 -0.4615\n- 0.1392 -0.1759 0.4873 -0.6156 -0.4873 0.6156 -0.1392 0.1759\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n- 0.7851 0.0000 -0.2243 0.0000 0.2243 0.0000 -0.7851 0.0000\n--0.0055 -0.2242 -0.0193 -0.7848 0.0193 0.7848 0.0055 0.2242\n--0.0055 -0.2242 -0.0193 -0.7848 0.0193 0.7848 0.0055 0.2242\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n--0.6351 0.4615 0.1815 -0.1318 -0.1815 0.1318 0.6351 -0.4615\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n- 0.7851 0.0000 -0.2243 0.0000 0.2243 0.0000 -0.7851 0.0000\n- 0.1392 -0.1759 0.4873 -0.6156 -0.4873 0.6156 -0.1392 0.1759\n- 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000 0.0000\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Factory/Module/Modem/Modem.cpp",
"new_path": "src/Factory/Module/Modem/Modem.cpp",
"diff": "@@ -150,8 +150,10 @@ void Modem::parameters\nif (this->type == \"SCMA\")\n{\n- this->bps = 3; // set by default the number of bits per symbol to 3 when SCMA mod\n- this->n_frames = tools::Codebook<float>(this->codebook).get_number_of_users();\n+ tools::Codebook<float> cb(this->codebook);\n+\n+ this->bps = cb.get_system_bps(); // codebook bps is float so here bps is stocked rounded\n+ this->n_frames = cb.get_number_of_users();\n}\nif(vals.exist({p+\"-fra-size\", \"N\"})) this->N = vals.to_int ({p+\"-fra-size\", \"N\"});\n@@ -290,10 +292,11 @@ template <typename B, typename R, typename Q>\nmodule::Modem<B,R,Q>* Modem::parameters\n::_build_scma() const\n{\n- if (this->psi == \"PSI0\") return new module::Modem_SCMA <B,R,Q,tools::psi_0<Q>>(this->N, this->codebook, tools::Sigma<R>((R)this->noise), this->bps, this->no_sig2, this->n_ite, this->n_frames);\n- if (this->psi == \"PSI1\") return new module::Modem_SCMA <B,R,Q,tools::psi_1<Q>>(this->N, this->codebook, tools::Sigma<R>((R)this->noise), this->bps, this->no_sig2, this->n_ite, this->n_frames);\n- if (this->psi == \"PSI2\") return new module::Modem_SCMA <B,R,Q,tools::psi_2<Q>>(this->N, this->codebook, tools::Sigma<R>((R)this->noise), this->bps, this->no_sig2, this->n_ite, this->n_frames);\n- if (this->psi == \"PSI3\") return new module::Modem_SCMA <B,R,Q,tools::psi_3<Q>>(this->N, this->codebook, tools::Sigma<R>((R)this->noise), this->bps, this->no_sig2, this->n_ite, this->n_frames);\n+ std::unique_ptr<tools::Codebook<R>> CB(new tools::Codebook<R>(this->codebook));\n+ if (this->psi == \"PSI0\") return new module::Modem_SCMA <B,R,Q,tools::psi_0<Q>>(this->N, std::move(CB), tools::Sigma<R>((R)this->noise), this->no_sig2, this->n_ite, this->n_frames);\n+ if (this->psi == \"PSI1\") return new module::Modem_SCMA <B,R,Q,tools::psi_1<Q>>(this->N, std::move(CB), tools::Sigma<R>((R)this->noise), this->no_sig2, this->n_ite, this->n_frames);\n+ if (this->psi == \"PSI2\") return new module::Modem_SCMA <B,R,Q,tools::psi_2<Q>>(this->N, std::move(CB), tools::Sigma<R>((R)this->noise), this->no_sig2, this->n_ite, this->n_frames);\n+ if (this->psi == \"PSI3\") return new module::Modem_SCMA <B,R,Q,tools::psi_3<Q>>(this->N, std::move(CB), tools::Sigma<R>((R)this->noise), this->no_sig2, this->n_ite, this->n_frames);\nthrow tools::cannot_allocate(__FILE__, __LINE__, __func__);\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Module/Modem/SCMA/Modem_SCMA.hpp",
"new_path": "src/Module/Modem/SCMA/Modem_SCMA.hpp",
"diff": "@@ -22,7 +22,9 @@ template <typename B = int, typename R = float, typename Q = R, tools::proto_psi\nclass Modem_SCMA : public Modem<B,R,Q>\n{\nprivate:\n- const tools::Codebook<R> CB;\n+ std::unique_ptr<const tools::Codebook<R>> CB_ptr;\n+ const tools::Codebook<R>& CB;\n+\ntools::Vector_4D<Q> arr_phi;\ntools::Vector_3D<Q> msg_user_to_resources;\ntools::Vector_3D<Q> msg_res_user;\n@@ -30,11 +32,10 @@ private:\nconst bool disable_sig2;\nR n0; // 1 / n0 = 179.856115108\nconst int n_ite;\n- const int bps;\npublic:\n- Modem_SCMA(const int N, const std::string& codebook_path, const tools::Noise<R>& noise = tools::Sigma<R>(), const int bps = 3, const bool disable_sig2 = false,\n- const int n_ite = 1, const int n_frames = 6);\n+ Modem_SCMA(const int N, std::unique_ptr<const tools::Codebook<R>>&& CB, const tools::Noise<R>& noise = tools::Sigma<R>(),\n+ const bool disable_sig2 = false, const int n_ite = 1, const int n_frames = 6);\nvirtual ~Modem_SCMA() = default;\nvirtual void set_noise(const tools::Noise<R>& noise);\n"
},
{
"change_type": "MODIFY",
"old_path": "src/Module/Modem/SCMA/Modem_SCMA.hxx",
"new_path": "src/Module/Modem/SCMA/Modem_SCMA.hxx",
"diff": "@@ -16,21 +16,21 @@ namespace module\n{\ntemplate <typename B, typename R, typename Q, tools::proto_psi<Q> PSI>\nModem_SCMA<B,R,Q,PSI>\n-::Modem_SCMA(const int N, const std::string& codebook_path, const tools::Noise<R>& noise, const int bps,\n+::Modem_SCMA(const int N, std::unique_ptr<const tools::Codebook<R>>&& _CB, const tools::Noise<R>& noise,\nconst bool disable_sig2, const int n_ite, const int n_frames)\n: Modem<B,R,Q>(N,\n- Modem_SCMA<B,R,Q,PSI>::size_mod(N, bps),\n- Modem_SCMA<B,R,Q,PSI>::size_fil(N, bps),\n+ Modem_SCMA<B,R,Q,PSI>::size_mod(N, _CB->get_system_bps()),\n+ Modem_SCMA<B,R,Q,PSI>::size_fil(N, _CB->get_system_bps()),\nnoise,\nn_frames),\n- CB (codebook_path),\n+ CB_ptr (std::move(_CB)),\n+ CB (*CB_ptr),\narr_phi (CB.get_number_of_resources(), CB.get_codebook_size(), CB.get_codebook_size(), CB.get_codebook_size(), (Q)0),\nmsg_user_to_resources(CB.get_number_of_users(), CB.get_number_of_resources(), CB.get_codebook_size(), (Q)0),\nmsg_res_user (CB.get_number_of_resources(), CB.get_number_of_users(), CB.get_codebook_size(), (Q)0),\nguess (CB.get_number_of_users(), CB.get_codebook_size(), (Q)0),\ndisable_sig2 (disable_sig2 ),\n- n_ite (n_ite ),\n- bps (bps )\n+ n_ite (n_ite )\n{\nconst std::string name = \"Modem_SCMA\";\nthis->set_name(name);\n@@ -43,13 +43,6 @@ Modem_SCMA<B,R,Q,PSI>\nthrow tools::invalid_argument(__FILE__, __LINE__, __func__, message.str());\n}\n- if (fabs(bps - CB.get_system_bps()) > std::numeric_limits<double>::epsilon())\n- {\n- std::stringstream message;\n- message << \"'bps' has to be equal to \" << CB.get_system_bps() << \" ('bps' = \" << bps << \").\";\n- throw tools::invalid_argument(__FILE__, __LINE__, __func__, message.str());\n- }\n-\nif (n_ite <= 0)\n{\nstd::stringstream message;\n"
}
] |
C++
|
MIT License
|
aff3ct/aff3ct
|
Remove bps parameter to the Modem_SCMA because this information is already in the codebook. Need to construct the codebook first and to pass it by argument to the SCMA.
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.