summaryrefslogtreecommitdiff
path: root/doc/eval.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/eval.texi')
-rw-r--r--doc/eval.texi53
1 files changed, 49 insertions, 4 deletions
diff --git a/doc/eval.texi b/doc/eval.texi
index 7f8f3653b3..b481bfe17f 100644
--- a/doc/eval.texi
+++ b/doc/eval.texi
@@ -1,7 +1,7 @@
@chapter Expression Evaluation
@c man begin EXPRESSION EVALUATION
-When evaluating an arithmetic expression, Libav uses an internal
+When evaluating an arithmetic expression, FFmpeg uses an internal
formula evaluator, implemented through the @file{libavutil/eval.h}
interface.
@@ -50,6 +50,7 @@ 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.
@item ld(var)
Allow to load the value of the internal variable with number
@@ -79,21 +80,65 @@ Compute the square root of @var{expr}. This is equivalent to
@item not(expr)
Return 1.0 if @var{expr} is zero, 0.0 otherwise.
+
+@item pow(x, y)
+Compute the power of @var{x} elevated @var{y}, it is equivalent to
+"(@var{x})^(@var{y})".
+
+@item random(x)
+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.
+
+@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.
+
+@item gcd(x, y)
+Return the greatest common divisor of @var{x} and @var{y}. If both @var{x} and
+@var{y} are 0 or either or both are less than zero then behavior is undefined.
+
+@item if(x, y)
+Evaluate @var{x}, and if the result is non-zero return the result of
+the evaluation of @var{y}, return 0 otherwise.
+
+@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.
+
+@item taylor(expr, x)
+Evaluate a taylor series at x.
+expr represents the LD(0)-th derivates of f(x) at 0.
+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.
+@end table
+
+The following constants are available:
+@table @option
+@item PI
+area of the unit disc, approximately 3.14
+@item E
+exp(1) (Euler's number), approximately 2.718
+@item PHI
+golden ratio (1+sqrt(5))/2, approximately 1.618
@end table
-Note that:
+Assuming that an expression is considered "true" if it has a non-zero
+value, note that:
@code{*} works like AND
@code{+} works like OR
-thus
+and the construct:
@example
if A then B else C
@end example
is equivalent to
@example
-A*B + not(A)*C
+if(A,B) + ifnot(A,C)
@end example
In your C code, you can extend the list of unary and binary functions,