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

[Michael Niedermayer]

On Wed, Jan 23, 2013 at 07:24:11PM +0100, Stefano Sabatini wrote:
> On date Tuesday 2013-01-22 23:54:09 +0100, Stefano Sabatini encoded:
> > ---
> >  doc/eval.texi |   19 ++++++++++++-------
> >  1 file changed, 12 insertions(+), 7 deletions(-)
> [...]
> 
> Updated.
> -- 
> FFmpeg = Fabulous and Faithless Mind-dumbing Powerful Embarassing Gadget

>  eval.texi |   20 +++++++++++++-------
>  1 file changed, 13 insertions(+), 7 deletions(-)
> bc0b6e9e6356978d26890a1a25fb0ece97ea58a4  0001-doc-eval-fix-extend-documentation-for-taylor-functio.patch
> From 55fe0913caa2ff5fd1d55093a3bb17b4443bc9d0 Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefasab at gmail.com>
> Date: Tue, 22 Jan 2013 23:53:39 +0100
> Subject: [PATCH] doc/eval: fix/extend documentation for taylor() function
> 
> ---
>  doc/eval.texi |   20 +++++++++++++-------
>  1 file changed, 13 insertions(+), 7 deletions(-)
> 
> diff --git a/doc/eval.texi b/doc/eval.texi
> index 1ea89d6..3fd6ca9 100644
> --- a/doc/eval.texi
> +++ b/doc/eval.texi
> @@ -155,13 +155,19 @@ the evaluation of @var{y}, return 0 otherwise.
>  Evaluate @var{x}, and if the result is zero return the result of the
>  evaluation of @var{y}, return 0 otherwise.
>  
> - 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 i-th derivative of the approximated function.
> +
> + at var{expr} computes the ld(@var{id})-th derivative at 0 of the
> +approximated function. The value stored in ld(@var{id}) is set to 0

> +and increased by 1 at each iteration step until the computation
> +converges. If @var{id} is not specified then 0 is assumed.

this documents the implementation which could change,
for example they could be evaluated in a different order
someone might based on these docs write something that depends on
the evaluation order ...


> +
> +Note, when you have the derivatives at y instead of 0,
> + at code{taylor(expr, x-y)} can be used. When the series does not
> +converge the result is undefined.
>  
>  @item root(expr, max)
>  Finds x where f(x)=0 in the interval 0..max.
> -- 
> 1.7.9.5
> 

> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel at ffmpeg.org
> http://ffmpeg.org/mailman/listinfo/ffmpeg-devel


-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Dictatorship naturally arises out of democracy, and the most aggravated
form of tyranny and slavery out of the most extreme liberty. -- Plato
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20130124/e473efe6/attachment.asc>