summaryrefslogtreecommitdiff
path: root/doc/filters.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/filters.texi')
-rw-r--r--doc/filters.texi38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index f89b1d0b52..6d2672063c 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -2975,6 +2975,44 @@ atrim=end=5,areverse
@end example
@end itemize
+@section arls
+Apply Recursive Least Squares algorithm to the first audio stream using the second audio stream.
+
+This adaptive filter is used to mimic a desired filter by recursively finding the filter coefficients that
+relate to producing the minimal weighted linear least squares cost function of the error signal (difference
+between the desired, 2nd input audio stream and the actual signal, the 1st input audio stream).
+
+A description of the accepted options follows.
+
+@table @option
+@item order
+Set the filter order.
+
+@item lambda
+Set the forgetting factor.
+
+@item delta
+Set the coefficient to initialize internal covariance matrix.
+
+@item out_mode
+Set the filter output samples. It accepts the following values:
+@table @option
+@item i
+Pass the 1st input.
+
+@item d
+Pass the 2nd input.
+
+@item o
+Pass filtered samples.
+
+@item n
+Pass difference between desired and filtered samples.
+
+Default value is @var{o}.
+@end table
+@end table
+
@section arnndn
Reduce noise from speech using Recurrent Neural Networks.