aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2012-08-21 13:16:13 +0200
committerStefano Sabatini <stefasab@gmail.com>2012-08-22 01:03:48 +0200
commit4a91962771f3e3ab84d6497c53da0f3675d19eec (patch)
tree8c26f61016f6dd7a4750810837c1ea4c77732871
parent4a32b30e0cd906523564e77e6db2f92aca37a10c (diff)
downloadffmpeg-4a91962771f3e3ab84d6497c53da0f3675d19eec.tar.gz
doc/eval: add missing documentation of functions
-rw-r--r--doc/eval.texi46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/eval.texi b/doc/eval.texi
index 1aeb87454d..1ea89d6755 100644
--- a/doc/eval.texi
+++ b/doc/eval.texi
@@ -21,32 +21,78 @@ The following unary operators are available: @code{+}, @code{-}.
The following functions are available:
@table @option
@item sinh(x)
+Compute hyperbolic sine of @var{x}.
+
@item cosh(x)
+Compute hyperbolic cosine of @var{x}.
+
@item tanh(x)
+Compute hyperbolic tangent of @var{x}.
+
@item sin(x)
+Compute sine of @var{x}.
+
@item cos(x)
+Compute cosine of @var{x}.
+
@item tan(x)
+Compute tangent of @var{x}.
+
@item atan(x)
+Compute arctangent of @var{x}.
+
@item asin(x)
+Compute arcsine of @var{x}.
+
@item acos(x)
+Compute arccosine of @var{x}.
+
@item exp(x)
+Compute exponential of @var{x} (with base @code{e}, the Euler's number).
+
@item log(x)
+Compute natural logarithm of @var{x}.
+
@item abs(x)
+Compute absolute value of @var{x}.
+
@item squish(x)
+Compute expression @code{1/(1 + exp(4*x))}.
+
@item gauss(x)
+Compute Gauss function of @var{x}, corresponding to
+@code{exp(-x*x/2) / sqrt(2*PI)}.
+
@item isinf(x)
Return 1.0 if @var{x} is +/-INFINITY, 0.0 otherwise.
+
@item isnan(x)
Return 1.0 if @var{x} is NAN, 0.0 otherwise.
@item mod(x, y)
+Compute the remainder of division of @var{x} by @var{y}.
+
@item max(x, y)
+Return the maximum between @var{x} and @var{y}.
+
@item min(x, y)
+Return the maximum between @var{x} and @var{y}.
+
@item eq(x, y)
+Return 1 if @var{x} and @var{y} are equivalent, 0 otherwise.
+
@item gte(x, y)
+Return 1 if @var{x} is greater than or equal to @var{y}, 0 otherwise.
+
@item gt(x, y)
+Return 1 if @var{x} is greater than @var{y}, 0 otherwise.
+
@item lte(x, y)
+Return 1 if @var{x} is lesser than or equal to @var{y}, 0 otherwise.
+
@item lt(x, y)
+Return 1 if @var{x} is lesser than @var{y}, 0 otherwise.
+
@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