a = b, 3, +, 5, * without the need for parentheses.
LT, LE, GT, GE, EQ, NE
-Pop two elements from the stack, compare them for the selected condition and return 1 for true or 0 for false. Comparing an unknown or an infinite value will always result in 0 (false).
-UN, ISINF
-Pop one element from the stack, compare this to unknown respectively to positive or negative infinity. Returns 1 for true or 0 for false.
-IF
-Pops three elements from the stack. If the element popped last is 0 (false), the value popped first is pushed back onto the stack, otherwise the value popped second is pushed back. This does, indeed, mean that any value other than 0 is considered to be true.
-Example: A,B,C,IF should be read as if (A) then (B) else (C)
MIN, MAX
-Pops two elements from the stack and returns the smaller or larger, respectively. Note that infinite is larger than anything else. If one of the input numbers is unknown then the result of the operation will be unknown too.
-LIMIT
-Pops two elements from the stack and uses them to define a range. Then it pops another element and if it falls inside the range, it is pushed back. If not, an unknown is pushed.
-The range defined includes the two boundaries (so: a number equal to one of the boundaries will be pushed back). If any of the three numbers involved is either unknown or infinite this function will always return an unknown
-Example: CDEF:a=alpha,0,100,LIMIT will return unknown if
alpha is lower than 0 or if it is higher than 100.
+, -, *, /, %
-Add, subtract, multiply, divide, modulo
-ADDNAN
+NAN-safe addition. If one parameter is NAN/UNKNOWN it'll be treated as +zero. If both parameters are NAN/UNKNOWN, NAN/UNKNOWN will be returned.
SIN, COS, LOG, EXP, SQRT
-Sine and cosine (input in radians), log and exp (natural logarithm), square root.
-ATAN
-Arctangent (output in radians).
-ATAN2
-Arctangent of y,x components (output in radians). This pops one element from the stack, the x (cosine) component, and then a second, which is the y (sine) component. It then pushes the arctangent of their ratio, resolving the ambiguity between quadrants.
-Example: CDEF:angle=Y,X,ATAN2,RAD2DEG will convert X,Y
components into an angle in degrees.
FLOOR, CEIL
-Round down or up to the nearest integer.
-DEG2RAD, RAD2DEG
-Convert angle in degrees to radians, or radians to degrees.
-ABS
-Take the absolute value.
SORT, REV
-Pop one element from the stack. This is the count of items to be sorted (or reversed). The top count of the remaining elements are then sorted (or reversed) in place on the stack.
-Example: CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/ will
compute the average of the values v1 to v6 after removing the smallest and
largest.
AVG
-Pop one element (count) from the stack. Now pop count elements and build the average, ignoring all UNKNOWN values in the process.
-Example: CDEF:x=a,b,c,d,4,AVG
TREND
-TREND, TRENDNAN
Create a ``sliding window'' average of another data series.
-Usage: CDEF:smoothed=x,1800,TREND
-This will create a half-hour (1800 second) sliding window average of x. The average is essentially computed as shown here:
-
+---!---!---!---!---!---!---!---!--->
now
@@ -239,99 +165,63 @@ average is essentially computed as shown here:
<--------------->
delay t2
<--------------->
-
Value at sample (t0) will be the average between (t0-delay) and (t0)
Value at sample (t1) will be the average between (t1-delay) and (t1)
Value at sample (t2) will be the average between (t2-delay) and (t2)
+TRENDNAN is - in contrast to TREND - NAN-safe. If you use TREND and one +source value is NAN the complete sliding window is affected. The TRENDNAN +operation ignores all NAN-values in a sliding window and computes the +average of the remaining values.
UNKN
-Pushes an unknown value on the stack
-INF, NEGINF
-Pushes a positive or negative infinite value on the stack. When such a value is graphed, it appears at the top or bottom of the graph, no matter what the actual value on the y-axis is.
-PREV
-Pushes an unknown value if this is the first value of a data set or otherwise the result of this CDEF at the previous time step. This allows you to do calculations across the data. This function cannot be used in VDEF instructions.
-PREV(vname)
-Pushes an unknown value if this is the first value of a data set or otherwise the result of the vname variable at the previous time step. This allows you to do calculations across the data. This function cannot be used in VDEF instructions.
-COUNT
-Pushes the number 1 if this is the first value of the data set, the number 2 if it is the second, and so on. This special value allows you to make calculations based on the position of the value within the data set. This function cannot be used in VDEF instructions.
Time inside RRDtool is measured in seconds since the epoch. The
epoch is defined to be Thu Jan 1 00:00:00 UTC 1970.
NOW
-Pushes the current time on the stack.
-TIME
-Pushes the time the currently processed value was taken at onto the stack.
-LTIME
-Takes the time as defined by TIME, applies the time zone offset valid at that time including daylight saving time if your OS supports it, and pushes the result on the stack. There is an elaborate example in the examples section below on how to use this.
DUP, POP, EXC
-Duplicate the top element, remove the top element, exchange the two top elements.
-@@ -339,40 +229,37 @@ top elements.
These operators work only on VDEF statements. Note that currently ONLY these work for VDEF.
Return the corresponding value, MAXIMUM and MINIMUM also return the first occurrence of that value in the time component.
+Example: VDEF:avg=mydata,AVERAGE
Example: VDEF:avg=mydata,AVERAGE
Returns the standard deviation of the values.
+Example: VDEF:stdev=mydata,STDEV
Return the last/first value including its time. The time for FIRST is actually the start of the corresponding interval, whereas LAST returns the end of the corresponding interval.
-Example: VDEF:first=mydata,FIRST
Returns the rate from each defined time slot multiplied with the step size. This can, for instance, return total bytes transfered when you have logged bytes per second. The time component returns the number of seconds.
-Example: VDEF:total=mydata,TOTAL
This should follow a DEF or CDEF vname. The vname is popped, @@ -384,12 +271,9 @@ purpose so if this operator returns an unknown you have quite a lot of them in your data. Infinite numbers are lesser, or more, than the finite numbers and are always more than the Unknown numbers. (NaN < -INF < finite values < INF)
-Example: VDEF:perc95=mydata,95,PERCENT
Return the parameters for a Least Squares Line (y = mx +b) @@ -399,11 +283,8 @@ y-intercept (b), which happens also to be the first data point on the graph. LSLCORREL is the Correlation Coefficient (also know as Pearson's Product Moment Correlation Coefficient). It will range from 0 to +/-1 and represents the quality of fit for the approximation.
-Example: VDEF:slope=mydata,LSLSLOPE