doc/rrdgraph_rpn.src

   1 =include name
   2
   3 =head1 SYNOPSYS
   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>
  98
  99 Sine, cosine (input in radians), log, exp (natural logarithm)
 100
 101 B<FLOOR, CEIL>
 102
 103 Round down,up to the nearest integer
 104
 105 Z<>
 106
 107 =item Special values
 108
 109 B<UNKN>
 110
 111 Pushes an unknown value on the stack
 112
 113 B<INF, NEGINF>
 114
 115 Pushes a positive or negative infinite value on the stack. When
 116 such a value is graphed, it appears at the top or bottom of the
 117 graph, no matter what the actual value on the y-axis is.
 118
 119 B<PREV>
 120
 121 Pushes an I<unknown> value if this is the first value of a data
 122 set or otherwise the result of this B<CDEF> at the previous time
 123 step. This allows you to do calculations across the data.  This
 124 function cannot be used in B<VDEF> instructions.
 125
 126 B<PREV(vname)>
 127
 128 Pushes an I<unknown> value if this is the first value of a data
 129 set or otherwise the result of vname variable at the previous time
 130 step. This allows you to do calculations across the data.  This
 131 function cannot be used in B<VDEF> instructions.
 132
 133 Z<>
 134
 135 =item Time
 136
 137 Time inside RRDtool is measured in seconds since the epoch. This
 138 epoch is defined to be S<C<Thu Jan  1 00:00:00 UTC 1970>>.
 139
 140 Z<>
 141
 142 =over 4
 143
 144 =item NOW
 145
 146 Pushes the current time on the stack.
 147
 148 Z<>
 149
 150 =item TIME
 151
 152 Pushes the time the currently processed value was taken onto the stack.
 153
 154 Z<>
 155
 156 =item LTIME
 157
 158 Takes the time as defined by B<TIME>, applies the time zone offset
 159 valid at that time including daylight saving time if your OS supports
 160 it, and pushes the result on the stack.  There is an elaborate example
 161 in the examples section on how to use this.
 162
 163 =back
 164
 165 For B<VDEF> operations, B<TIME> and B<LTIME> have a different meaning
 166 I<not yet implemented>.  As the B<VDEF> statement does not work per
 167 value but rather on a complete time series, there is no such thing as
 168 the currently processed value.  However, if you have used an operator
 169 that returned a time component and would like to have this available
 170 in the value component in stead (so you can use it as a number), you
 171 can use B<TIME> or B<LTIME> for that.
 172
 173 Z<>
 174
 175 =item Processing the stack directly
 176
 177 B<DUP, POP, EXC>
 178
 179 Duplicate the top element, remove the top element, exchange the two
 180 top elements.
 181
 182 Z<>
 183
 184 =item Selecting characteristics
 185
 186 These operators work only on B<VDEF> statements.
 187 I<We can make most of them work at DEF and CDEF statements. If we do
 188 so, we have a moving (not rolling!) average, max,min etcetera>
 189
 190 Z<>
 191
 192 =over 4
 193
 194 =item MAXIMUM, MINIMUM, AVERAGE
 195
 196 Return the corresponding value, MAXIMUM and MINIMUM also return
 197 the first occurance of that value in the time component.
 198
 199 Example: C<VDEF:avg=mydata,AVERAGE>
 200
 201 Z<>
 202
 203 =item LAST, FIRST
 204
 205 Return the last,first value including its time.  The time for
 206 FIRST is actually the start of the corresponding interval, where
 207 LASTs time component returns the end of the corresponding interval.
 208
 209 Example: C<VDEF:first=mydata,FIRST>
 210
 211 Z<>
 212
 213 =item TOTAL
 214
 215 Returns the rate from each defined timeslot multiplied with the
 216 step size.  This can for instance return total bytes transfered
 217 when you have logged bytes per second. The time component returns
 218 the amount of seconds
 219
 220 Example: C<VDEF:total=mydata,TOTAL>
 221
 222 Z<>
 223
 224 =item PERCENT
 225
 226 Should follow a B<DEF> or B<CDEF> I<vname>. This I<vname> is popped,
 227 another number is popped which is a certain percentage (0..100). The
 228 data set is then sorted and the value returned is chosen such that
 229 I<percentage> percent of the values is lower or equal than the result.
 230 I<Unknown> values are considered lower than any finite number for this
 231 purpose so if this operator returns an I<unknown> you have quite a lot
 232 of them in your data.  B<Inf>inite numbers are lesser, or more, than the
 233 finite numbers and are always more than the I<Unknown> numbers.
 234
 235 Example: C<VDEF:perc95=mydata,95,PERCENT>
 236
 237 =back
 238
 239 =back
 240
 241 =include see_also