[FFmpegdevel] [PATCH] doc/eval: sort functions by name
Stefano Sabatini
stefasab at gmail.com
Sat Jan 26 15:25:59 CET 2013

doc/eval.texi  200 ++++++++++++++++++++++++++++
1 file changed, 100 insertions(+), 100 deletions()
diff git a/doc/eval.texi b/doc/eval.texi
index 61d7329..473834d 100644
 a/doc/eval.texi
+++ b/doc/eval.texi
@@ 20,111 +20,102 @@ The following unary operators are available: @code{+}, @code{}.
The following functions are available:
@table @option
 at item sinh(x)
Compute hyperbolic sine of @var{x}.
+ at item abs(x)
+Compute absolute value of @var{x}.
 at item cosh(x)
Compute hyperbolic cosine of @var{x}.
+ at item acos(x)
+Compute arccosine of @var{x}.
 at item tanh(x)
Compute hyperbolic tangent of @var{x}.
+ at item asin(x)
+Compute arcsine of @var{x}.
 at item sin(x)
Compute sine of @var{x}.
+ at item atan(x)
+Compute arctangent of @var{x}.
+
+ at item ceil(expr)
+Round the value of expression @var{expr} upwards to the nearest
+integer. For example, "ceil(1.5)" is "2.0".
@item cos(x)
Compute cosine of @var{x}.
 at item tan(x)
Compute tangent of @var{x}.

 at item atan(x)
Compute arctangent of @var{x}.

 at item asin(x)
Compute arcsine of @var{x}.
+ at item cosh(x)
+Compute hyperbolic cosine of @var{x}.
 at item acos(x)
Compute arccosine of @var{x}.
+ at item eq(x, y)
+Return 1 if @var{x} and @var{y} are equivalent, 0 otherwise.
@item exp(x)
Compute exponential of @var{x} (with base @code{e}, the Euler's number).
 at item log(x)
Compute natural logarithm of @var{x}.

 at item abs(x)
Compute absolute value of @var{x}.

 at item squish(x)
Compute expression @code{1/(1 + exp(4*x))}.
+ at item floor(expr)
+Round the value of expression @var{expr} downwards to the nearest
+integer. For example, "floor(1.5)" is "2.0".
@item gauss(x)
Compute Gauss function of @var{x}, corresponding to
@code{exp(x*x/2) / sqrt(2*PI)}.
 at item isinf(x)
Return 1.0 if @var{x} is +/INFINITY, 0.0 otherwise.

 at item isnan(x)
Return 1.0 if @var{x} is NAN, 0.0 otherwise.
+ at item gcd(x, y)
+Return the greatest common divisor of @var{x} and @var{y}. If both @var{x} and
+ at var{y} are 0 or either or both are less than zero then behavior is undefined.
 at item mod(x, y)
Compute the remainder of division of @var{x} by @var{y}.
+ at item gt(x, y)
+Return 1 if @var{x} is greater than @var{y}, 0 otherwise.
 at item max(x, y)
Return the maximum between @var{x} and @var{y}.
+ at item gte(x, y)
+Return 1 if @var{x} is greater than or equal to @var{y}, 0 otherwise.
 at item min(x, y)
Return the maximum between @var{x} and @var{y}.
+ at item hypot(x, y)
+This function is similar to the C function with the same name; it returns
+"sqrt(@var{x}*@var{x} + @var{y}*@var{y})", the length of the hypotenuse of a
+right triangle with sides of length @var{x} and @var{y}, or the distance of the
+point (@var{x}, @var{y}) from the origin.
 at item eq(x, y)
Return 1 if @var{x} and @var{y} are equivalent, 0 otherwise.
+ at item if(x, y)
+Evaluate @var{x}, and if the result is nonzero return the result of
+the evaluation of @var{y}, return 0 otherwise.
 at item gte(x, y)
Return 1 if @var{x} is greater than or equal to @var{y}, 0 otherwise.
+ at item if(x, y, z)
+Evaluate @var{x}, and if the result is nonzero return the evaluation
+result of @var{y}, otherwise the evaluation result of @var{z}.
 at item gt(x, y)
Return 1 if @var{x} is greater than @var{y}, 0 otherwise.
+ at item ifnot(x, y)
+Evaluate @var{x}, and if the result is zero return the result of the
+evaluation of @var{y}, return 0 otherwise.
 at item lte(x, y)
Return 1 if @var{x} is lesser than or equal to @var{y}, 0 otherwise.
+ at item ifnot(x, y, z)
+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 lt(x, y)
Return 1 if @var{x} is lesser than @var{y}, 0 otherwise.
+ at item isinf(x)
+Return 1.0 if @var{x} is +/INFINITY, 0.0 otherwise.
 at item st(var, expr)
Allow to store the value of the expression @var{expr} in an internal
variable. @var{var} specifies the number of the variable where to
store the value, and it is a value ranging from 0 to 9. The function
returns the value stored in the internal variable.
Note, Variables are currently not shared between expressions.
+ at item isnan(x)
+Return 1.0 if @var{x} is NAN, 0.0 otherwise.
@item ld(var)
Allow to load the value of the internal variable with number
@var{var}, which was previously stored with st(@var{var}, @var{expr}).
The function returns the loaded value.
 at item while(cond, expr)
Evaluate expression @var{expr} while the expression @var{cond} is
nonzero, and returns the value of the last @var{expr} evaluation, or
NAN if @var{cond} was always false.
+ at item log(x)
+Compute natural logarithm of @var{x}.
 at item ceil(expr)
Round the value of expression @var{expr} upwards to the nearest
integer. For example, "ceil(1.5)" is "2.0".
+ at item lt(x, y)
+Return 1 if @var{x} is lesser than @var{y}, 0 otherwise.
 at item floor(expr)
Round the value of expression @var{expr} downwards to the nearest
integer. For example, "floor(1.5)" is "2.0".
+ at item lte(x, y)
+Return 1 if @var{x} is lesser than or equal to @var{y}, 0 otherwise.
 at item trunc(expr)
Round the value of expression @var{expr} towards zero to the nearest
integer. For example, "trunc(1.5)" is "1.0".
+ at item max(x, y)
+Return the maximum between @var{x} and @var{y}.
 at item sqrt(expr)
Compute the square root of @var{expr}. This is equivalent to
"(@var{expr})^.5".
+ at item min(x, y)
+Return the maximum between @var{x} and @var{y}.
+
+ at item mod(x, y)
+Compute the remainder of division of @var{x} by @var{y}.
@item not(expr)
Return 1.0 if @var{expr} is zero, 0.0 otherwise.
@@ 137,31 +128,44 @@ Compute the power of @var{x} elevated @var{y}, it is equivalent to
Return a pseudo random value between 0.0 and 1.0. @var{x} is the index of the
internal variable which will be used to save the seed/state.
 at item hypot(x, y)
This function is similar to the C function with the same name; it returns
"sqrt(@var{x}*@var{x} + @var{y}*@var{y})", the length of the hypotenuse of a
right triangle with sides of length @var{x} and @var{y}, or the distance of the
point (@var{x}, @var{y}) from the origin.
+ at item root(expr, max)
+Find a value where the function represented by @var{expr} with argument
+ at var{ld(0)} is 0 in the interval 0.. at var{max}.
 at item gcd(x, y)
Return the greatest common divisor of @var{x} and @var{y}. If both @var{x} and
 at var{y} are 0 or either or both are less than zero then behavior is undefined.
+The expression in @var{expr} must denote a continuous function or the
+result is undefined.
 at item if(x, y)
Evaluate @var{x}, and if the result is nonzero return the result of
the evaluation of @var{y}, return 0 otherwise.
+ at var{ld(0)} is used to represent the function value, that means that
+the given expression will be evaluated multiple times with various
+values of x that the expression can access through @code{ld(0)}. When
+the expression evaluates to 0 then the value of @code{ld(0)} will be
+returned.
 at item if(x, y, z)
Evaluate @var{x}, and if the result is nonzero return the evaluation
result of @var{y}, otherwise the evaluation result of @var{z}.
+ at item sin(x)
+Compute sine of @var{x}.
 at item ifnot(x, y)
Evaluate @var{x}, and if the result is zero return the result of the
evaluation of @var{y}, return 0 otherwise.
+ at item sinh(x)
+Compute hyperbolic sine of @var{x}.
 at item ifnot(x, y, z)
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 sqrt(expr)
+Compute the square root of @var{expr}. This is equivalent to
+"(@var{expr})^.5".
+
+ at item squish(x)
+Compute expression @code{1/(1 + exp(4*x))}.
+
+ at item st(var, expr)
+Allow to store the value of the expression @var{expr} in an internal
+variable. @var{var} specifies the number of the variable where to
+store the value, and it is a value ranging from 0 to 9. The function
+returns the value stored in the internal variable.
+Note, Variables are currently not shared between expressions.
+
+ at item tan(x)
+Compute tangent of @var{x}.
+
+ at item tanh(x)
+Compute hyperbolic tangent of @var{x}.
@item taylor(expr, x)
@item taylor(expr, x, id)
@@ 181,18 +185,14 @@ Note, when you have the derivatives at y instead of 0,
@item time(0)
Return the current (wallclock) time in seconds.
 at item root(expr, max)
Find a value where the function represented by @var{expr} with argument
 at var{ld(0)} is 0 in the interval 0.. at var{max}.

The expression in @var{expr} must denote a continuous function or the
result is undefined.
+ at item trunc(expr)
+Round the value of expression @var{expr} towards zero to the nearest
+integer. For example, "trunc(1.5)" is "1.0".
 at var{ld(0)} is used to represent the function value, that means that
the given expression will be evaluated multiple times with various
values of x that the expression can access through @code{ld(0)}. When
the expression evaluates to 0 then the value of @code{ld(0)} will be
returned.
+ at item while(cond, expr)
+Evaluate expression @var{expr} while the expression @var{cond} is
+nonzero, and returns the value of the last @var{expr} evaluation, or
+NAN if @var{cond} was always false.
@end table
The following constants are available:

1.7.9.5
More information about the ffmpegdevel
mailing list