Difference between revisions of "LDPC Generator Matrix"

From GNU Radio
Jump to: navigation, search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
This block creates a LDPC Generator Matrix variable.
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary.  Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.
 
  
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
+
This variable can be used by:
 +
  1) LDPC Encoder Definition (via Generator) block
 +
  2) LDPC Bit Flip Decoder Definition block
 +
 
 +
Provide an alist file, which contains a Generator matrix, G, in the standard format G = [I P], where I is an identity matrix and P is the parity submatrix.
 +
 
 +
The format of alist files is described at:
 +
[http://www.inference.phy.cam.ac.uk/mackay/codes/alist.html]
  
 
== Parameters ==
 
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
 
; Param 1 (''R'')
 
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
 
  
; Param 2
+
; File
: blah blah blah
+
: Name of an alist file to use.
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 23:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/ldpc_G_matrix_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/ldpc_G_matrix_impl.h]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/include/gnuradio/fec/ldpc_G_matrix.h]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/variable_ldpc_G_matrix_object.block.yml]

Revision as of 14:01, 5 September 2019

This block creates a LDPC Generator Matrix variable.

This variable can be used by:

 1) LDPC Encoder Definition (via Generator) block
 2) LDPC Bit Flip Decoder Definition block

Provide an alist file, which contains a Generator matrix, G, in the standard format G = [I P], where I is an identity matrix and P is the parity submatrix.

The format of alist files is described at: [1]

Parameters

File
Name of an alist file to use.

Example Flowgraph

Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.

Source Files

C++ files
[2]
Header files
[3]
Public header files
[4]
Block definition
[5]