aboutsummaryrefslogtreecommitdiffstats
path: root/doc/eval.texi
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2013-01-23 11:45:31 +0100
committerStefano Sabatini <stefasab@gmail.com>2013-01-31 12:09:13 +0100
commitd99bc8475232ef7f72042c7a7328b77cc3771fa4 (patch)
tree2724ecadd54afef397adf025fbe4d311673a6f7e /doc/eval.texi
parentcdf0877bc341684c56ac1fe057397adbadf329ee (diff)
downloadffmpeg-d99bc8475232ef7f72042c7a7328b77cc3771fa4.tar.gz
doc/eval: fix/extend documentation for root() function
Diffstat (limited to 'doc/eval.texi')
-rw-r--r--doc/eval.texi13
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/eval.texi b/doc/eval.texi
index f77b87deac..37ca137b96 100644
--- a/doc/eval.texi
+++ b/doc/eval.texi
@@ -175,8 +175,17 @@ When the series does not converge the results are undefined.
Return the current (wallclock) time in seconds.
@item root(expr, max)
-Finds x where f(x)=0 in the interval 0..max.
-f() must be continuous or the result is undefined.
+Find an input value for which the function represented by @var{expr}
+with argument @var{ld(0)} is 0 in the interval 0..@var{max}.
+
+The expression in @var{expr} must denote a continuous function or the
+result is undefined.
+
+@var{ld(0)} is used to represent the function input value, which means
+that the given expression will be evaluated multiple times with
+various input values that the expression can access through
+@code{ld(0)}. When the expression evaluates to 0 then the
+corresponding input value will be returned.
@end table
The following constants are available: