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

[Michael Niedermayer]

On Sat, Jan 26, 2013 at 11:31:34AM +0100, Stefano Sabatini wrote:
> On date Thursday 2013-01-24 03:38:56 +0100, Michael Niedermayer encoded:
> > 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 ...
> 
> Changed.
> -- 
> FFmpeg = Formidable and Furious Martial Programmable Earthshaking Gladiator

>  eval.texi |   21 ++++++++++++++-------
>  1 file changed, 14 insertions(+), 7 deletions(-)
> cf41b01b2e3634e07cdf58e86866423ccc6c494a  0002-doc-eval-fix-extend-documentation-for-taylor-functio.patch
> From a0e0551ec92c3208b3d16b12df7b4c7a806c88d1 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 |   21 ++++++++++++++-------
>  1 file changed, 14 insertions(+), 7 deletions(-)
> 
> diff --git a/doc/eval.texi b/doc/eval.texi
> index dbe9381..7de82f9 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.
> +
> +When the series does not converge the result is undefined.
> +
> + at var{ld(id)} is used to represent the derivative order in @var{expr},
> +that means that the given expression will be evaluated multiple times
> +with various argument 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.

maybe nicolas wants to review this and the other math related patches
too ?

[...]


-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Opposition brings concord. Out of discord comes the fairest harmony.
-- Heraclitus
-------------- 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/20130126/04712f66/attachment.asc>