-
Notifications
You must be signed in to change notification settings - Fork 0
/
classapf_1_1BlockDelayLine.html
633 lines (565 loc) · 36.1 KB
/
classapf_1_1BlockDelayLine.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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
<!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::BlockDelayLine< T, Container > 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_1BlockDelayLine.html">BlockDelayLine</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classapf_1_1BlockDelayLine-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">apf::BlockDelayLine< T, Container > Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Block-based delay line.
<a href="classapf_1_1BlockDelayLine.html#details">More...</a></p>
<p><code>#include <<a class="el" href="blockdelayline_8h_source.html">apf/blockdelayline.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a08e30eb3059a17df4eca09b3b1c1c341"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a08e30eb3059a17df4eca09b3b1c1c341">size_type</a> = typename Container::size_type</td></tr>
<tr class="separator:a08e30eb3059a17df4eca09b3b1c1c341"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe8bf580c7e1771563bc653525e5f1c4"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#afe8bf580c7e1771563bc653525e5f1c4">difference_type</a> = typename Container::difference_type</td></tr>
<tr class="separator:afe8bf580c7e1771563bc653525e5f1c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab8f0e01e3aae29fe29193e8e5543885"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#aab8f0e01e3aae29fe29193e8e5543885">pointer</a> = typename Container::pointer</td></tr>
<tr class="separator:aab8f0e01e3aae29fe29193e8e5543885"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d4918a62cb4701f9dc3344daa8a9829"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a9d4918a62cb4701f9dc3344daa8a9829">circulator</a> = <a class="el" href="classapf_1_1circular__iterator.html">apf::circular_iterator</a>< typename Container::iterator ></td></tr>
<tr class="separator:a9d4918a62cb4701f9dc3344daa8a9829"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a6412ee03e9fd04c41dde7bed0f48afbb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a6412ee03e9fd04c41dde7bed0f48afbb">BlockDelayLine</a> (size_type block_size, size_type max_delay)</td></tr>
<tr class="memdesc:a6412ee03e9fd04c41dde7bed0f48afbb"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classapf_1_1BlockDelayLine.html#a6412ee03e9fd04c41dde7bed0f48afbb">More...</a><br /></td></tr>
<tr class="separator:a6412ee03e9fd04c41dde7bed0f48afbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63204ea357c8365b0988442388026d68"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a63204ea357c8365b0988442388026d68">delay_is_valid</a> (size_type delay, size_type &corrected) const</td></tr>
<tr class="memdesc:a63204ea357c8365b0988442388026d68"><td class="mdescLeft"> </td><td class="mdescRight">Check if a given delay is valid. <a href="classapf_1_1BlockDelayLine.html#a63204ea357c8365b0988442388026d68">More...</a><br /></td></tr>
<tr class="separator:a63204ea357c8365b0988442388026d68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77dc69ef1d87688a81b2227b86644a0c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a77dc69ef1d87688a81b2227b86644a0c">delay_is_valid</a> (size_type delay) const</td></tr>
<tr class="memdesc:a77dc69ef1d87688a81b2227b86644a0c"><td class="mdescLeft"> </td><td class="mdescRight">Return <b>true</b> if <code>delay</code> is valid. <a href="classapf_1_1BlockDelayLine.html#a77dc69ef1d87688a81b2227b86644a0c">More...</a><br /></td></tr>
<tr class="separator:a77dc69ef1d87688a81b2227b86644a0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b89b44fdc1f7dd3bdecd3a58c6c47c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a3b89b44fdc1f7dd3bdecd3a58c6c47c3">advance</a> ()</td></tr>
<tr class="memdesc:a3b89b44fdc1f7dd3bdecd3a58c6c47c3"><td class="mdescLeft"> </td><td class="mdescRight">Advance the internal iterators/pointers to the next block. <a href="classapf_1_1BlockDelayLine.html#a3b89b44fdc1f7dd3bdecd3a58c6c47c3">More...</a><br /></td></tr>
<tr class="separator:a3b89b44fdc1f7dd3bdecd3a58c6c47c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab128577db27eeb2c0e341df97f27d83f"><td class="memTemplParams" colspan="2">template<typename Iterator > </td></tr>
<tr class="memitem:ab128577db27eeb2c0e341df97f27d83f"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#ab128577db27eeb2c0e341df97f27d83f">write_block</a> (Iterator source)</td></tr>
<tr class="memdesc:ab128577db27eeb2c0e341df97f27d83f"><td class="mdescLeft"> </td><td class="mdescRight">Write a block of data to the delay line. <a href="classapf_1_1BlockDelayLine.html#ab128577db27eeb2c0e341df97f27d83f">More...</a><br /></td></tr>
<tr class="separator:ab128577db27eeb2c0e341df97f27d83f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4a0c228c818d55b50cce167828e1fd5"><td class="memTemplParams" colspan="2">template<typename Iterator > </td></tr>
<tr class="memitem:aa4a0c228c818d55b50cce167828e1fd5"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#aa4a0c228c818d55b50cce167828e1fd5">read_block</a> (Iterator destination, size_type delay) const</td></tr>
<tr class="memdesc:aa4a0c228c818d55b50cce167828e1fd5"><td class="mdescLeft"> </td><td class="mdescRight">Read a block of data from the delay line. <a href="classapf_1_1BlockDelayLine.html#aa4a0c228c818d55b50cce167828e1fd5">More...</a><br /></td></tr>
<tr class="separator:aa4a0c228c818d55b50cce167828e1fd5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afec5abc94b8f231b1b39f3c1dd80c81a"><td class="memTemplParams" colspan="2">template<typename Iterator > </td></tr>
<tr class="memitem:afec5abc94b8f231b1b39f3c1dd80c81a"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#afec5abc94b8f231b1b39f3c1dd80c81a">read_block</a> (Iterator destination, size_type delay, T weight) const</td></tr>
<tr class="memdesc:afec5abc94b8f231b1b39f3c1dd80c81a"><td class="mdescLeft"> </td><td class="mdescRight">Read from the delay line and multiply each element by a given factor. <a href="classapf_1_1BlockDelayLine.html#afec5abc94b8f231b1b39f3c1dd80c81a">More...</a><br /></td></tr>
<tr class="separator:afec5abc94b8f231b1b39f3c1dd80c81a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0554f7b7e4d6537dfeb682370be3b002"><td class="memItemLeft" align="right" valign="top">pointer </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a0554f7b7e4d6537dfeb682370be3b002">get_write_pointer</a> () const</td></tr>
<tr class="memdesc:a0554f7b7e4d6537dfeb682370be3b002"><td class="mdescLeft"> </td><td class="mdescRight">Get the write pointer. <a href="classapf_1_1BlockDelayLine.html#a0554f7b7e4d6537dfeb682370be3b002">More...</a><br /></td></tr>
<tr class="separator:a0554f7b7e4d6537dfeb682370be3b002"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9774d36c26b58b1487220a6832267f15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classapf_1_1circular__iterator.html">circulator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a9774d36c26b58b1487220a6832267f15">get_read_circulator</a> (size_type delay=0) const</td></tr>
<tr class="memdesc:a9774d36c26b58b1487220a6832267f15"><td class="mdescLeft"> </td><td class="mdescRight">Get the read circulator. <a href="classapf_1_1BlockDelayLine.html#a9774d36c26b58b1487220a6832267f15">More...</a><br /></td></tr>
<tr class="separator:a9774d36c26b58b1487220a6832267f15"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aedbb09fc15ddd696fc8d83bbe4673f55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classapf_1_1circular__iterator.html">circulator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#aedbb09fc15ddd696fc8d83bbe4673f55">_get_data_circulator</a> () const</td></tr>
<tr class="memdesc:aedbb09fc15ddd696fc8d83bbe4673f55"><td class="mdescLeft"> </td><td class="mdescRight">Get a circular iterator to the sample with time 0. <a href="classapf_1_1BlockDelayLine.html#aedbb09fc15ddd696fc8d83bbe4673f55">More...</a><br /></td></tr>
<tr class="separator:aedbb09fc15ddd696fc8d83bbe4673f55"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a499ee411350674ed2c5763fc833bdb75"><td class="memItemLeft" align="right" valign="top">const size_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a499ee411350674ed2c5763fc833bdb75">_block_size</a></td></tr>
<tr class="memdesc:a499ee411350674ed2c5763fc833bdb75"><td class="mdescLeft"> </td><td class="mdescRight">Size of read/write blocks. <a href="classapf_1_1BlockDelayLine.html#a499ee411350674ed2c5763fc833bdb75">More...</a><br /></td></tr>
<tr class="separator:a499ee411350674ed2c5763fc833bdb75"><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 T, typename Container = std::vector<T>><br />
class apf::BlockDelayLine< T, Container ></div><p >Block-based delay line. </p>
<p >This is a "write once, read many times" delay line. The write operation is simple and fast. The desired delay is specified at the more flexible read operation. </p>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00047">47</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a08e30eb3059a17df4eca09b3b1c1c341" name="a08e30eb3059a17df4eca09b3b1c1c341"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08e30eb3059a17df4eca09b3b1c1c341">◆ </a></span>size_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container = std::vector<T>> </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::size_type = typename Container::size_type</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00050">50</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
</div>
</div>
<a id="afe8bf580c7e1771563bc653525e5f1c4" name="afe8bf580c7e1771563bc653525e5f1c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe8bf580c7e1771563bc653525e5f1c4">◆ </a></span>difference_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container = std::vector<T>> </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::difference_type = typename Container::difference_type</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00051">51</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
</div>
</div>
<a id="aab8f0e01e3aae29fe29193e8e5543885" name="aab8f0e01e3aae29fe29193e8e5543885"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab8f0e01e3aae29fe29193e8e5543885">◆ </a></span>pointer</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container = std::vector<T>> </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::pointer = typename Container::pointer</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00052">52</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
</div>
</div>
<a id="a9d4918a62cb4701f9dc3344daa8a9829" name="a9d4918a62cb4701f9dc3344daa8a9829"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d4918a62cb4701f9dc3344daa8a9829">◆ </a></span>circulator</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container = std::vector<T>> </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::circulator = <a class="el" href="classapf_1_1circular__iterator.html">apf::circular_iterator</a><typename Container::iterator></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00053">53</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a6412ee03e9fd04c41dde7bed0f48afbb" name="a6412ee03e9fd04c41dde7bed0f48afbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6412ee03e9fd04c41dde7bed0f48afbb">◆ </a></span>BlockDelayLine()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::BlockDelayLine </td>
<td>(</td>
<td class="paramtype">size_type </td>
<td class="paramname"><em>block_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_type </td>
<td class="paramname"><em>max_delay</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">block_size</td><td>Block size </td></tr>
<tr><td class="paramname">max_delay</td><td>Maximum delay in samples </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00121">121</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
<p class="reference">References <a class="el" href="blockdelayline_8h_source.html#l00100">apf::BlockDelayLine< T, Container >::_block_size</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a63204ea357c8365b0988442388026d68" name="a63204ea357c8365b0988442388026d68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63204ea357c8365b0988442388026d68">◆ </a></span>delay_is_valid() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container = std::vector<T>> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::delay_is_valid </td>
<td>(</td>
<td class="paramtype">size_type </td>
<td class="paramname"><em>delay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_type & </td>
<td class="paramname"><em>corrected</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</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>Check if a given delay is valid. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">delay</td><td>Desired delay </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">corrected</td><td>If valid, the same as <code>delay</code>, if not, the maximum possible delay. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><b>true</b> if <code>delay</code> is valid. </dd></dl>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00062">62</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="blockdelayline_8h_source.html#l00266">apf::NonCausalBlockDelayLine< T, Container >::delay_is_valid()</a>, and <a class="el" href="blockdelayline_8h_source.html#l00070">apf::BlockDelayLine< T, Container >::delay_is_valid()</a>.</p>
</div>
</div>
<a id="a77dc69ef1d87688a81b2227b86644a0c" name="a77dc69ef1d87688a81b2227b86644a0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77dc69ef1d87688a81b2227b86644a0c">◆ </a></span>delay_is_valid() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container = std::vector<T>> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::delay_is_valid </td>
<td>(</td>
<td class="paramtype">size_type </td>
<td class="paramname"><em>delay</em></td><td>)</td>
<td> const</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>Return <b>true</b> if <code>delay</code> is valid. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classapf_1_1BlockDelayLine.html#a63204ea357c8365b0988442388026d68" title="Check if a given delay is valid.">delay_is_valid()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00070">70</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
<p class="reference">References <a class="el" href="blockdelayline_8h_source.html#l00062">apf::BlockDelayLine< T, Container >::delay_is_valid()</a>.</p>
</div>
</div>
<a id="a3b89b44fdc1f7dd3bdecd3a58c6c47c3" name="a3b89b44fdc1f7dd3bdecd3a58c6c47c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b89b44fdc1f7dd3bdecd3a58c6c47c3">◆ </a></span>advance()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container = std::vector<T>> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::advance </td>
<td>(</td>
<td class="paramname"></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>Advance the internal iterators/pointers to the next block. </p>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00077">77</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
<p class="reference">References <a class="el" href="blockdelayline_8h_source.html#l00100">apf::BlockDelayLine< T, Container >::_block_size</a>.</p>
</div>
</div>
<a id="ab128577db27eeb2c0e341df97f27d83f" name="ab128577db27eeb2c0e341df97f27d83f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab128577db27eeb2c0e341df97f27d83f">◆ </a></span>write_block()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container > </div>
<div class="memtemplate">
template<typename Iterator > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::write_block </td>
<td>(</td>
<td class="paramtype">Iterator </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a block of data to the delay line. </p>
<p >Before writing, the read and write pointers are advanced to the next block. If you don't want to use this function, you can also call <a class="el" href="classapf_1_1BlockDelayLine.html#a3b89b44fdc1f7dd3bdecd3a58c6c47c3" title="Advance the internal iterators/pointers to the next block.">advance()</a>, get the write pointer with <a class="el" href="classapf_1_1BlockDelayLine.html#a0554f7b7e4d6537dfeb682370be3b002" title="Get the write pointer.">get_write_pointer()</a> and write directly to it. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>Pointer/iterator where the block of data shall be read from. </td></tr>
</table>
</dd>
</dl>
<dl class="section attention"><dt>Attention</dt><dd>In <code>source</code> there must be enough data to read from! </dd></dl>
<dl class="section note"><dt>Note</dt><dd><code>source</code> must be a random access iterator. If you want to use another iterator, you'll have to do it on your own (as written above). </dd></dl>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00152">152</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
</div>
</div>
<a id="aa4a0c228c818d55b50cce167828e1fd5" name="aa4a0c228c818d55b50cce167828e1fd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4a0c228c818d55b50cce167828e1fd5">◆ </a></span>read_block() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container > </div>
<div class="memtemplate">
template<typename Iterator > </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::read_block </td>
<td>(</td>
<td class="paramtype">Iterator </td>
<td class="paramname"><em>destination</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_type </td>
<td class="paramname"><em>delay</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a block of data from the delay line. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">destination</td><td>Iterator to destination </td></tr>
<tr><td class="paramname">delay</td><td>Delay in samples </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><b>true</b> on success </dd></dl>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00167">167</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="blockdelayline_8h_source.html#l00289">apf::NonCausalBlockDelayLine< T, Container >::read_block()</a>.</p>
</div>
</div>
<a id="afec5abc94b8f231b1b39f3c1dd80c81a" name="afec5abc94b8f231b1b39f3c1dd80c81a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afec5abc94b8f231b1b39f3c1dd80c81a">◆ </a></span>read_block() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container > </div>
<div class="memtemplate">
template<typename Iterator > </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::read_block </td>
<td>(</td>
<td class="paramtype">Iterator </td>
<td class="paramname"><em>destination</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_type </td>
<td class="paramname"><em>delay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"><em>weight</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read from the delay line and multiply each element by a given factor. </p>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00183">183</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
</div>
</div>
<a id="a0554f7b7e4d6537dfeb682370be3b002" name="a0554f7b7e4d6537dfeb682370be3b002"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0554f7b7e4d6537dfeb682370be3b002">◆ </a></span>get_write_pointer()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classapf_1_1BlockDelayLine.html">BlockDelayLine</a>< T, Container >::pointer <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::get_write_pointer</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the write pointer. </p>
<dl class="section attention"><dt>Attention</dt><dd>Before the write operation, <a class="el" href="classapf_1_1BlockDelayLine.html#a3b89b44fdc1f7dd3bdecd3a58c6c47c3" title="Advance the internal iterators/pointers to the next block.">advance()</a> must be called to update read and write pointers. </dd>
<dd>
You must not write more than one block with this pointer! For the next block, you have to get a new pointer. </dd></dl>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00201">201</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
</div>
</div>
<a id="a9774d36c26b58b1487220a6832267f15" name="a9774d36c26b58b1487220a6832267f15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9774d36c26b58b1487220a6832267f15">◆ </a></span>get_read_circulator()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classapf_1_1BlockDelayLine.html">BlockDelayLine</a>< T, Container >::circulator <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::get_read_circulator </td>
<td>(</td>
<td class="paramtype">size_type </td>
<td class="paramname"><em>delay</em> = <code>0</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the read circulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">delay</td><td>Delay in samples </td></tr>
</table>
</dd>
</dl>
<dl class="section attention"><dt>Attention</dt><dd>There is no check if the delay is in the valid range between 0 and <code>max_delay</code>. You are responsible for checking that! </dd></dl>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00213">213</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="blockdelayline_8h_source.html#l00306">apf::NonCausalBlockDelayLine< T, Container >::get_read_circulator()</a>.</p>
</div>
</div>
<a id="aedbb09fc15ddd696fc8d83bbe4673f55" name="aedbb09fc15ddd696fc8d83bbe4673f55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedbb09fc15ddd696fc8d83bbe4673f55">◆ </a></span>_get_data_circulator()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container = std::vector<T>> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classapf_1_1circular__iterator.html">circulator</a> <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::_get_data_circulator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a circular iterator to the sample with time 0. </p>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00098">98</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a499ee411350674ed2c5763fc833bdb75" name="a499ee411350674ed2c5763fc833bdb75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a499ee411350674ed2c5763fc833bdb75">◆ </a></span>_block_size</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Container = std::vector<T>> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const size_type <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>< T, Container >::_block_size</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of read/write blocks. </p>
<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00100">100</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="blockdelayline_8h_source.html#l00077">apf::BlockDelayLine< T, Container >::advance()</a>, and <a class="el" href="blockdelayline_8h_source.html#l00121">apf::BlockDelayLine< T, Container >::BlockDelayLine()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>apf/<a class="el" href="blockdelayline_8h_source.html">blockdelayline.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>