<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.2.2 C++ API: gr_keep_one_in_n Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>gr_keep_one_in_n Class Reference<br/>
<small>
[<a class="el" href="group__slicedice__blk.html">Slicing and Dicing Streams</a>]</small>
</h1><!-- doxytag: class="gr_keep_one_in_n" --><!-- doxytag: inherits="gr_block" -->
<p>decimate a stream, keeping one item out of every n.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__keep__one__in__n_8h_source.html">gr_keep_one_in_n.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_keep_one_in_n:</div>
<div class="dynsection">
<div class="center"><img src="classgr__keep__one__in__n__inherit__graph.png" border="0" usemap="#gr__keep__one__in__n_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__keep__one__in__n_inherit__map" id="gr__keep__one__in__n_inherit__map">
<area shape="rect" id="node2" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="33,83,103,112"/><area shape="rect" id="node4" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="13,5,123,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__keep__one__in__n-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__keep__one__in__n.html#ab57aecd5051ea7dfbba9d15a91441acd">general_work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compute output items from input items <a href="#ab57aecd5051ea7dfbba9d15a91441acd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__keep__one__in__n.html#a18e80e05b8866661ac5e18f022b2347a">set_n</a> (int n)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__keep__one__in__n.html#a5e7b40f9af7ea668d7df71146c0160c2">gr_keep_one_in_n</a> (size_t item_size, int n)</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_keep_one_in_n_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__keep__one__in__n.html#aea0150514805b1891e03448e5e0f40dc">gr_make_keep_one_in_n</a> (size_t item_size, int n)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>decimate a stream, keeping one item out of every n. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5e7b40f9af7ea668d7df71146c0160c2"></a><!-- doxytag: member="gr_keep_one_in_n::gr_keep_one_in_n" ref="a5e7b40f9af7ea668d7df71146c0160c2" args="(size_t item_size, int n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_keep_one_in_n::gr_keep_one_in_n </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>item_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab57aecd5051ea7dfbba9d15a91441acd"></a><!-- doxytag: member="gr_keep_one_in_n::general_work" ref="ab57aecd5051ea7dfbba9d15a91441acd" args="(int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_keep_one_in_n::general_work </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>noutput_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_int</a> & </td>
<td class="paramname"> <em>ninput_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td>
<td class="paramname"> <em>input_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td>
<td class="paramname"> <em>output_items</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>compute output items from input items </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>noutput_items</em> </td><td>number of output items to write on each output stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ninput_items</em> </td><td>number of input items available on each input stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>input_items</em> </td><td>vector of pointers to the input items, one entry per input stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output_items</em> </td><td>vector of pointers to the output items, one entry per output stream</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 <= return value <= noutput_items</dd></dl>
<p>general_work must call consume or consume_each to indicate how many items were consumed on each input stream. </p>
<p>Implements <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="a18e80e05b8866661ac5e18f022b2347a"></a><!-- doxytag: member="gr_keep_one_in_n::set_n" ref="a18e80e05b8866661ac5e18f022b2347a" args="(int n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_keep_one_in_n::set_n </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="aea0150514805b1891e03448e5e0f40dc"></a><!-- doxytag: member="gr_keep_one_in_n::gr_make_keep_one_in_n" ref="aea0150514805b1891e03448e5e0f40dc" args="(size_t item_size, int n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_keep_one_in_n_sptr</a> gr_make_keep_one_in_n </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>item_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__keep__one__in__n_8h_source.html">gr_keep_one_in_n.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>
