doc/rrdgraph_rpn.src

   1 =include name
   2
   3 =head1 SYNOPSIS
   4
   5 I<E<lt>RPN expressionE<gt>> :=
   6 I<E<lt>vnameE<gt>>|I<E<lt>operatorE<gt>>|I<E<lt>valueE<gt>>
   7 [ , I<E<lt>RPN expressionE<gt>>]
   8
   9 =head1 DESCRIPTION
  10
  11 If you have ever used a traditional HP calculator you already know
  12 B<RPN>. The idea behind B<RPN> is that you have a stack and push
  13 your data onto this stack. Whenever you execute an operation, it
  14 takes as many elements from the stack as needed. Pushing is done
  15 implicit so whenever you specify a number or a variable, it gets
  16 pushed automatically.
  17
  18 At the end of the calculation there should be one and exactly one
  19 value left on the stack.  This is the outcome of the function and
  20 this is what is put into the I<vname>.  For B<CDEF> instructions,
  21 the stack is processed for each data point on the graph. B<VDEF>
  22 instructions work on an entire data set in one run.
  23
  24 Example: C<CDEF:mydatabits=mydata,8,*>
  25
  26 This means:  push variable I<mydata>, push the number 8, execute
  27 the operator I<+>. The operator needs two elements and uses those
  28 to return one value.  This value is then stored in I<mydatabits>.
  29 As you may have guessed, this instruction means nothing more than
  30 I<mydatabits = mydata * 8>.  The real power of B<RPN> lies in the
  31 fact that it is always clear in which order to process the input.
  32 For expressions like C<a = b + 3 * 5> you need to multiply 3 with
  33 5 first before you add I<b> to get I<a>. However, with parentheses
  34 you could change this order: C<a = (b + 3) * 5>. In B<RPN>, you
  35 would do C<a = b, 3, +, 5, *> and need no parentheses.
  36
  37 =head1 OPERATORS
  38
  39 =over 4
  40
  41 =item Boolean operators
  42
  43 B<LT, LE, GT, GE, EQ, NE>
  44
  45 Pop two elements from the stack, compare them for the selected condition
  46 and return 1 for true or 0 for false. Comparing an I<unknown> or an
  47 I<infinite> value will always result in 0 (false).
  48
  49 B<UN, ISINF>
  50
  51 Pop one element from the stack, compare this to I<unknown> respectively
  52 to I<positive or negative infinity>. Returns 1 for true or 0 for false.
  53
  54 B<IF>
  55
  56 Pops three elements from the stack.  If the last element is 0 (false),
  57 the first value is pushed back onto the stack, otherwise the second
  58 popped value is pushed back. This does, indeed, mean that any value
  59 other than 0 is considered true.
  60 I<Note: Should this change? It should IMHO as all the other functions
  61 would return unknown if A,B or C were unknown>
  62
  63 Example: C<A,B,C,IF> should be read as C<if (A) then (B) else (C)>
  64
  65 Z<>
  66
  67 =item Comparing values
  68
  69 B<MIN, MAX>
  70
  71 Pops two elements from the stack and returns the lesser or larger.
  72 The two numbers shouldn't be I<infinite> or I<unknown>, if they are
  73 that value is pushed back onto the stack as the result.
  74
  75 B<LIMIT>
  76
  77 Pops two elements from the stack and uses them to define a range.
  78 Then it pops another element and if it falls inside the range, it
  79 is pushed back. If not, an I<unknown> is pushed.
  80
  81 The range defined includes the two boundaries (so: a number equal
  82 to one of the boundaries will be pushed back). If any of the three
  83 numbers involved is either I<unknown> or I<infinite> this function
  84 will always return an I<unknown>
  85
  86 Example: C<CDEF:a=alpha,0,100,LIMIT> will return I<unknown> if
  87 alpha is lower than 0 or if it is higher than 100.
  88
  89 Z<>
  90
  91 =item Arithmetics
  92
  93 B<+, -, *, /, %>
  94
  95 Add, subtract, multiply, divide, modulo
  96
  97 B<SIN, COS, LOG, EXP, SQRT>
  98
  99 Sine, cosine (input in radians), log, exp (natural logarithm), square root
 100
 101 B<ATAN>
 102
 103 Arctangent. Output in radians.
 104
 105 B<FLOOR, CEIL>
 106
 107 Round down,up to the nearest integer
 108
 109 Z<>
 110
 111 =item Ordering Operations
 112
 113 B<SORT, REV>
 114
 115 Pop one element from the stack.  This is the I<count> of items to be sorted
 116 (or reversed).  The top I<count> of the remaining elements are then sorted
 117 (or reversed) in place on the stack.
 118
 119 Example: C<CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/> will
 120 compute the average of the values v1..v6 after removing the smallest and
 121 largest.
 122
 123 =item Special values
 124
 125 B<UNKN>
 126
 127 Pushes an unknown value on the stack
 128
 129 B<INF, NEGINF>
 130
 131 Pushes a positive or negative infinite value on the stack. When
 132 such a value is graphed, it appears at the top or bottom of the
 133 graph, no matter what the actual value on the y-axis is.
 134
 135 B<PREV>
 136
 137 Pushes an I<unknown> value if this is the first value of a data
 138 set or otherwise the result of this B<CDEF> at the previous time
 139 step. This allows you to do calculations across the data.  This
 140 function cannot be used in B<VDEF> instructions.
 141
 142 B<PREV(vname)>
 143
 144 Pushes an I<unknown> value if this is the first value of a data
 145 set or otherwise the result of vname variable at the previous time
 146 step. This allows you to do calculations across the data.  This
 147 function cannot be used in B<VDEF> instructions.
 148
 149 B<COUNT>
 150
 151 Pushes the number 1 if this is the first value of the data set, the
 152 number 2 if it is the second, and so on. This special value, allows
 153 you to make calculations based on the position of the value within
 154 the data set. This function cannot be used in B<VDEF> instructions.
 155
 156 Z<>
 157
 158 =item Time
 159
 160 Time inside RRDtool is measured in seconds since the epoch. This
 161 epoch is defined to be S<C<Thu Jan  1 00:00:00 UTC 1970>>.
 162
 163 Z<>
 164
 165 =over 4
 166
 167 =item NOW
 168
 169 Pushes the current time on the stack.
 170
 171 Z<>
 172
 173 =item TIME
 174
 175 Pushes the time the currently processed value was taken onto the stack.
 176
 177 Z<>
 178
 179 =item LTIME
 180
 181 Takes the time as defined by B<TIME>, applies the time zone offset
 182 valid at that time including daylight saving time if your OS supports
 183 it, and pushes the result on the stack.  There is an elaborate example
 184 in the examples section on how to use this.
 185
 186 =back
 187
 188 For B<VDEF> operations, B<TIME> and B<LTIME> have a different meaning
 189 I<not yet implemented>.  As the B<VDEF> statement does not work per
 190 value but rather on a complete time series, there is no such thing as
 191 the currently processed value.  However, if you have used an operator
 192 that returned a time component and would like to have this available
 193 in the value component in stead (so you can use it as a number), you
 194 can use B<TIME> or B<LTIME> for that.
 195
 196 Z<>
 197
 198 =item Processing the stack directly
 199
 200 B<DUP, POP, EXC>
 201
 202 Duplicate the top element, remove the top element, exchange the two
 203 top elements.
 204
 205 Z<>
 206
 207 =item Selecting characteristics
 208
 209 These operators work only on B<VDEF> statements.
 210 I<We can make most of them work at DEF and CDEF statements. If we do
 211 so, we have a moving (not rolling!) average, max,min etcetera>
 212
 213 Z<>
 214
 215 =over 4
 216
 217 =item MAXIMUM, MINIMUM, AVERAGE
 218
 219 Return the corresponding value, MAXIMUM and MINIMUM also return
 220 the first occurrence of that value in the time component.
 221
 222 Example: C<VDEF:avg=mydata,AVERAGE>
 223
 224 Z<>
 225
 226 =item LAST, FIRST
 227
 228 Return the last,first value including its time.  The time for
 229 FIRST is actually the start of the corresponding interval, where
 230 the LAST time component returns the end of the corresponding interval.
 231
 232 Example: C<VDEF:first=mydata,FIRST>
 233
 234 Z<>
 235
 236 =item TOTAL
 237
 238 Returns the rate from each defined time slot multiplied with the
 239 step size.  This can for instance return total bytes transfered
 240 when you have logged bytes per second. The time component returns
 241 the amount of seconds
 242
 243 Example: C<VDEF:total=mydata,TOTAL>
 244
 245 Z<>
 246
 247 =item PERCENT
 248
 249 Should follow a B<DEF> or B<CDEF> I<vname>. This I<vname> is popped,
 250 another number is popped which is a certain percentage (0..100). The
 251 data set is then sorted and the value returned is chosen such that
 252 I<percentage> percent of the values is lower or equal than the result.
 253 I<Unknown> values are considered lower than any finite number for this
 254 purpose so if this operator returns an I<unknown> you have quite a lot
 255 of them in your data.  B<Inf>inite numbers are lesser, or more, than the
 256 finite numbers and are always more than the I<Unknown> numbers.
 257
 258 Example: C<VDEF:perc95=mydata,95,PERCENT>
 259
 260 =back
 261
 262 =back
 263
 264 =include see_also