Difference between revisions of "Fast Multiply Const"

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...")
 
(add notes to intro section)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
Multiplies the input by a '''scalar''' constant. The "Fast" refers to the performance of the block.  
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.
+
output = input * scalar constant
 +
 
 +
See [[Multiply_Const]] for a vector multiply block.
 +
 
 +
Note: This block uses VOLK (Vector-Optimized Library of Kernels) to improve execution speed.
  
 
== Parameters ==
 
== Parameters ==
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
  
; Param 1 (''R'')
+
; Constant (''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).
+
: Scalar constant
 
 
; Param 2
 
: blah blah blah
 
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 21:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/multiply_const_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/multiply_const_impl.h]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/include/gnuradio/blocks/multiply_const.h]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_multiply_const_xx.block.yml]

Latest revision as of 17:37, 30 October 2019

Multiplies the input by a scalar constant. The "Fast" refers to the performance of the block.

output = input * scalar constant

See Multiply_Const for a vector multiply block.

Note: This block uses VOLK (Vector-Optimized Library of Kernels) to improve execution speed.

Parameters[edit]

(R): Run-time adjustable

Constant (R)
Scalar constant

Example Flowgraph[edit]

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[edit]

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