-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassapf_1_1CombineChannels.html
239 lines (228 loc) · 19.6 KB
/
classapf_1_1CombineChannels.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audio Processing Framework (APF): apf::CombineChannels< L, Out > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Audio Processing Framework (APF)<span id="projectnumber"> version 0.5.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceapf.html">apf</a></li><li class="navelem"><a class="el" href="classapf_1_1CombineChannels.html">CombineChannels</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classapf_1_1CombineChannels-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">apf::CombineChannels< L, Out > Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Combine channels: transform and accumulate.
<a href="classapf_1_1CombineChannels.html#details">More...</a></p>
<p><code>#include <<a class="el" href="combine__channels_8h_source.html">apf/combine_channels.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for apf::CombineChannels< L, Out >:</div>
<div class="dyncontent">
<div class="center"><img src="classapf_1_1CombineChannels__inherit__graph.png" border="0" usemap="#aapf_1_1CombineChannels_3_01L_00_01Out_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="aapf_1_1CombineChannels_3_01L_00_01Out_01_4_inherit__map" id="aapf_1_1CombineChannels_3_01L_00_01Out_01_4_inherit__map">
<area shape="rect" title="Combine channels: transform and accumulate." alt="" coords="30,199,198,240"/>
<area shape="rect" href="classapf_1_1CombineChannelsBase.html" title=" " alt="" coords="10,95,218,151"/>
<area shape="rect" href="classapf_1_1CRTP.html" title=" " alt="" coords="5,5,223,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a02ee56806cf22d1a8b54d4f3f14ead91"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannels.html#a02ee56806cf22d1a8b54d4f3f14ead91">CombineChannels</a> (const L &in, Out &out)</td></tr>
<tr class="separator:a02ee56806cf22d1a8b54d4f3f14ead91"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13a263154107daec8e6b7ddc9d46d4fb"><td class="memTemplParams" colspan="2">template<typename ItemType , typename F > </td></tr>
<tr class="memitem:a13a263154107daec8e6b7ddc9d46d4fb"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannels.html#a13a263154107daec8e6b7ddc9d46d4fb">case_one</a> (const ItemType &item, F &f)</td></tr>
<tr class="separator:a13a263154107daec8e6b7ddc9d46d4fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classapf_1_1CombineChannelsBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classapf_1_1CombineChannelsBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classapf_1_1CombineChannelsBase.html">apf::CombineChannelsBase< CombineChannels< L, Out >, L, Out ></a></td></tr>
<tr class="memitem:af62abaf07e79f8fd7394559d0a69371a inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#af62abaf07e79f8fd7394559d0a69371a">CombineChannelsBase</a> (L &in, Out &out)</td></tr>
<tr class="memdesc:af62abaf07e79f8fd7394559d0a69371a inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classapf_1_1CombineChannelsBase.html#af62abaf07e79f8fd7394559d0a69371a">More...</a><br /></td></tr>
<tr class="separator:af62abaf07e79f8fd7394559d0a69371a inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac453fbb3da9fc0f92a92dc87792af27c inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#ac453fbb3da9fc0f92a92dc87792af27c">process</a> (F f)</td></tr>
<tr class="memdesc:ac453fbb3da9fc0f92a92dc87792af27c inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="mdescLeft"> </td><td class="mdescRight">Do the actual combining. <a href="classapf_1_1CombineChannelsBase.html#ac453fbb3da9fc0f92a92dc87792af27c">More...</a><br /></td></tr>
<tr class="separator:ac453fbb3da9fc0f92a92dc87792af27c inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4fef7ccdc948ae85d33200564630de80 inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#a4fef7ccdc948ae85d33200564630de80">before_the_loop</a> ()</td></tr>
<tr class="separator:a4fef7ccdc948ae85d33200564630de80 inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0520d0e0af3be778b4d0683803e1321 inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#ae0520d0e0af3be778b4d0683803e1321">case_one</a> (const ItemType &, F &)</td></tr>
<tr class="separator:ae0520d0e0af3be778b4d0683803e1321 inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5de4742b3405dcd7847b46b71c54e435 inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#a5de4742b3405dcd7847b46b71c54e435">case_two</a> (const ItemType &, F &)</td></tr>
<tr class="separator:a5de4742b3405dcd7847b46b71c54e435 inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22598c6a210547b29a7728abc1b6c6c0 inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#a22598c6a210547b29a7728abc1b6c6c0">after_the_loop</a> ()</td></tr>
<tr class="separator:a22598c6a210547b29a7728abc1b6c6c0 inherit pub_methods_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classapf_1_1CRTP"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classapf_1_1CRTP')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classapf_1_1CRTP.html">apf::CRTP< CombineChannels< L, Out > ></a></td></tr>
<tr class="memitem:a663184d1b9c1c2ee270166457c87c731 inherit pub_methods_classapf_1_1CRTP"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classapf_1_1CombineChannels.html">CombineChannels</a>< L, Out > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CRTP.html#a663184d1b9c1c2ee270166457c87c731">derived</a> ()</td></tr>
<tr class="separator:a663184d1b9c1c2ee270166457c87c731 inherit pub_methods_classapf_1_1CRTP"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_types_classapf_1_1CombineChannelsBase"><td colspan="2" onclick="javascript:toggleInherit('pro_types_classapf_1_1CombineChannelsBase')"><img src="closed.png" alt="-"/> Protected Types inherited from <a class="el" href="classapf_1_1CombineChannelsBase.html">apf::CombineChannelsBase< CombineChannels< L, Out >, L, Out ></a></td></tr>
<tr class="memitem:afec38e9bfecca54d1f90323cdad0489a inherit pro_types_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#afec38e9bfecca54d1f90323cdad0489a">T</a> = typename std::iterator_traits< typename std::remove_reference< L >::type::value_type::iterator >::value_type</td></tr>
<tr class="separator:afec38e9bfecca54d1f90323cdad0489a inherit pro_types_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classapf_1_1CombineChannelsBase"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classapf_1_1CombineChannelsBase')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classapf_1_1CombineChannelsBase.html">apf::CombineChannelsBase< CombineChannels< L, Out >, L, Out ></a></td></tr>
<tr class="memitem:a1e24368b50ee12b2c65492e6b782c8b6 inherit pro_methods_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#a1e24368b50ee12b2c65492e6b782c8b6">_case_one_copy</a> (const ItemType &item)</td></tr>
<tr class="separator:a1e24368b50ee12b2c65492e6b782c8b6 inherit pro_methods_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21f0cacfa2dbbadd68ed53d9d56cd574 inherit pro_methods_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#a21f0cacfa2dbbadd68ed53d9d56cd574">_case_one_transform</a> (const ItemType &item, FunctionType &f)</td></tr>
<tr class="separator:a21f0cacfa2dbbadd68ed53d9d56cd574 inherit pro_methods_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classapf_1_1CRTP"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classapf_1_1CRTP')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classapf_1_1CRTP.html">apf::CRTP< CombineChannels< L, Out > ></a></td></tr>
<tr class="memitem:aa678e203f13c2311737549f44cedb093 inherit pro_methods_classapf_1_1CRTP"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CRTP.html#aa678e203f13c2311737549f44cedb093">~CRTP</a> ()=default</td></tr>
<tr class="memdesc:aa678e203f13c2311737549f44cedb093 inherit pro_methods_classapf_1_1CRTP"><td class="mdescLeft"> </td><td class="mdescRight">Protected destructor to avoid base class pointers. <a href="classapf_1_1CRTP.html#aa678e203f13c2311737549f44cedb093">More...</a><br /></td></tr>
<tr class="separator:aa678e203f13c2311737549f44cedb093 inherit pro_methods_classapf_1_1CRTP"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classapf_1_1CombineChannelsBase"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classapf_1_1CombineChannelsBase')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classapf_1_1CombineChannelsBase.html">apf::CombineChannelsBase< CombineChannels< L, Out >, L, Out ></a></td></tr>
<tr class="memitem:a5aee4cf1a19b8602f92f17dd29684a67 inherit pro_attribs_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top">Out & </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#a5aee4cf1a19b8602f92f17dd29684a67">_out</a></td></tr>
<tr class="separator:a5aee4cf1a19b8602f92f17dd29684a67 inherit pro_attribs_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a82a1c45509eb409700b697333b4ada inherit pro_attribs_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top">CombineChannelsResult::type </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#a3a82a1c45509eb409700b697333b4ada">_selection</a></td></tr>
<tr class="separator:a3a82a1c45509eb409700b697333b4ada inherit pro_attribs_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16c6bbc8d8f861dd4cb2174435ff52eb inherit pro_attribs_classapf_1_1CombineChannelsBase"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CombineChannelsBase.html#a16c6bbc8d8f861dd4cb2174435ff52eb">_accumulate</a></td></tr>
<tr class="separator:a16c6bbc8d8f861dd4cb2174435ff52eb inherit pro_attribs_classapf_1_1CombineChannelsBase"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template<typename L, typename Out><br />
class apf::CombineChannels< L, Out ></div><p >Combine channels: transform and accumulate. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="jack_dynamic_inputs_8cpp-example.html#_a2">jack_dynamic_inputs.cpp</a>, and <a class="el" href="simpleprocessor_8h-example.html#_a3">simpleprocessor.h</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="combine__channels_8h_source.html#l00214">214</a> of file <a class="el" href="combine__channels_8h_source.html">combine_channels.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a02ee56806cf22d1a8b54d4f3f14ead91" name="a02ee56806cf22d1a8b54d4f3f14ead91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02ee56806cf22d1a8b54d4f3f14ead91">◆ </a></span>CombineChannels()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename L , typename Out > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classapf_1_1CombineChannels.html">apf::CombineChannels</a>< L, Out >::CombineChannels </td>
<td>(</td>
<td class="paramtype">const L & </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out & </td>
<td class="paramname"><em>out</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="combine__channels_8h_source.html#l00221">221</a> of file <a class="el" href="combine__channels_8h_source.html">combine_channels.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a13a263154107daec8e6b7ddc9d46d4fb" name="a13a263154107daec8e6b7ddc9d46d4fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13a263154107daec8e6b7ddc9d46d4fb">◆ </a></span>case_one()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename L , typename Out > </div>
<div class="memtemplate">
template<typename ItemType , typename F > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classapf_1_1CombineChannels.html">apf::CombineChannels</a>< L, Out >::case_one </td>
<td>(</td>
<td class="paramtype">const ItemType & </td>
<td class="paramname"><em>item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">F & </td>
<td class="paramname"><em>f</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="combine__channels_8h_source.html#l00224">224</a> of file <a class="el" href="combine__channels_8h_source.html">combine_channels.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>apf/<a class="el" href="combine__channels_8h_source.html">combine_channels.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>