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

[Stefano Sabatini]

On date Thursday 2013-01-24 00:17:38 +0100, Michael Niedermayer encoded:
> On Wed, Jan 23, 2013 at 07:18:48PM +0100, Stefano Sabatini wrote:
[...]
> I wrote the code
> I dont understand the docs you write
> 
> if you want to make it clearer IMHO put less in the sentance and
> clearer not more
> 
> Finds the value x at which f(x)=0 in the interval 0 <= x <= max.
> ld(0) is used to represent x, that means that your given expression
> will be evaluated multiple times with various values of x that the
> expression can access through ld(0).
> When your expression evaluates to 0 then the value of ld(0) will be
> returned by root()
> 
> f() must be continuous or the result is undefined.

Edited and somehow readjusted based on your suggestion. What I mostly
dislike about the current doc is the mention of "f()" out of the blue,
which is not really clear what it really refers to.

BTW in case the function has no roots it currently returns max, NaN
may be a saner choice (currently undocumented so it should be OK to
change the implementation).
-- 
FFmpeg = Frenzy and Fostering Mystic Peaceful Entertaining Geisha
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0002-doc-eval-fix-extend-documentation-for-root-function.patch
Type: text/x-diff
Size: 1231 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20130126/eb242e0c/attachment.bin>