[FFmpeg-cvslog] doc/eval: fix/extend documentation for taylor() function

Stefano Sabatini git at videolan.org
Thu Jan 31 12:14:11 CET 2013


ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Tue Jan 22 23:53:39 2013 +0100| [41e5e28daf0a0f7ba258e054ab7e76c8a94c305e] | committer: Stefano Sabatini

doc/eval: fix/extend documentation for taylor() function

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=41e5e28daf0a0f7ba258e054ab7e76c8a94c305e
---

 doc/eval.texi |   21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/doc/eval.texi b/doc/eval.texi
index 37ca137..bf4274c 100644
--- a/doc/eval.texi
+++ b/doc/eval.texi
@@ -163,13 +163,20 @@ evaluation of @var{y}, return 0 otherwise.
 Evaluate @var{x}, and if the result is zero return the evaluation
 result of @var{y}, otherwise the evaluation result of @var{z}.
 
- at item taylor(expr, x) taylor(expr, x, id)
-Evaluate a taylor series at x.
-expr represents the LD(id)-th derivates of f(x) at 0. If id is not specified
-then 0 is assumed.
-note, when you have the derivatives at y instead of 0
-taylor(expr, x-y) can be used
-When the series does not converge the results are undefined.
+ at item taylor(expr, x)
+ at item taylor(expr, x, id)
+Evaluate a Taylor series at @var{x}, given an expression representing
+the @code{ld(id)}-th derivative of a function at 0.
+
+When the series does not converge the result is undefined.
+
+ at var{ld(id)} is used to represent the derivative order in @var{expr},
+which means that the given expression will be evaluated multiple times
+with various input values that the expression can access through
+ at code{ld(id)}. If @var{id} is not specified then 0 is assumed.
+
+Note, when you have the derivatives at y instead of 0,
+ at code{taylor(expr, x-y)} can be used.
 
 @item time(0)
 Return the current (wallclock) time in seconds.



More information about the ffmpeg-cvslog mailing list