program/doc/rrdgraph_rpn.pod

   1 =head1 NAME
   2
   3 rrdgraph_rpn - About RPN Math in rrdtool graph
   4
   5 =head1 SYNOPSIS
   6
   7 I<RPN expression>:=I<vname>|I<operator>|I<value>[,I<RPN expression>]
   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 implicitly, so whenever you specify a number or a variable, it gets
  16 pushed onto the stack automatically.
  17
  18 At the end of the calculation there should be one and only 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<VDEF:maximum=mydata,MAXIMUM>
  25
  26 This will set variable "maximum" which you now can use in the rest
  27 of your RRD script.
  28
  29 Example: C<CDEF:mydatabits=mydata,8,*>
  30
  31 This means:  push variable I<mydata>, push the number 8, execute
  32 the operator I<+>. The operator needs two elements and uses those
  33 to return one value.  This value is then stored in I<mydatabits>.
  34 As you may have guessed, this instruction means nothing more than
  35 I<mydatabits = mydata * 8>.  The real power of B<RPN> lies in the
  36 fact that it is always clear in which order to process the input.
  37 For expressions like C<a = b + 3 * 5> you need to multiply 3 with
  38 5 first before you add I<b> to get I<a>. However, with parentheses
  39 you could change this order: C<a = (b + 3) * 5>. In B<RPN>, you
  40 would do C<a = b, 3, +, 5, *> without the need for parentheses.
  41
  42 =head1 OPERATORS
  43
  44 =over 4
  45
  46 =item Boolean operators
  47
  48 B<LT, LE, GT, GE, EQ, NE>
  49
  50 Pop two elements from the stack, compare them for the selected condition
  51 and return 1 for true or 0 for false. Comparing an I<unknown> or an
  52 I<infinite> value will always result in 0 (false).
  53
  54 B<UN, ISINF>
  55
  56 Pop one element from the stack, compare this to I<unknown> respectively
  57 to I<positive or negative infinity>. Returns 1 for true or 0 for false.
  58
  59 B<IF>
  60
  61 Pops three elements from the stack.  If the element popped last is 0
  62 (false), the value popped first is pushed back onto the stack,
  63 otherwise the value popped second is pushed back. This does, indeed,
  64 mean that any value other than 0 is considered to be true.
  65
  66 Example: C<A,B,C,IF> should be read as C<if (A) then (B) else (C)>
  67
  68 Z<>
  69
  70 =item Comparing values
  71
  72 B<MIN, MAX>
  73
  74 Pops two elements from the stack and returns the smaller or larger,
  75 respectively.  The two numbers shouldn't be I<infinite> or I<unknown>,
  76 if they are that value is pushed back onto the stack as the result.
  77
  78 = for comment
  79 XXX What happens above if both a infinite and undefined value are on the
  80 XXX stack? Fritz
  81
  82 B<LIMIT>
  83
  84 Pops two elements from the stack and uses them to define a range.
  85 Then it pops another element and if it falls inside the range, it
  86 is pushed back. If not, an I<unknown> is pushed.
  87
  88 The range defined includes the two boundaries (so: a number equal
  89 to one of the boundaries will be pushed back). If any of the three
  90 numbers involved is either I<unknown> or I<infinite> this function
  91 will always return an I<unknown>
  92
  93 Example: C<CDEF:a=alpha,0,100,LIMIT> will return I<unknown> if
  94 alpha is lower than 0 or if it is higher than 100.
  95
  96 Z<>
  97
  98 =item Arithmetics
  99
 100 B<+, -, *, /, %>
 101
 102 Add, subtract, multiply, divide, modulo
 103
 104 B<SIN, COS, LOG, EXP, SQRT>
 105
 106 Sine and cosine (input in radians), log and exp (natural logarithm),
 107 square root.
 108
 109 B<ATAN>
 110
 111 Arctangent (output in radians).
 112
 113 B<FLOOR, CEIL>
 114
 115 Round down or up to the nearest integer.
 116
 117 Z<>
 118
 119 =item Set Operations
 120
 121 B<SORT, REV>
 122
 123 Pop one element from the stack.  This is the I<count> of items to be sorted
 124 (or reversed).  The top I<count> of the remaining elements are then sorted
 125 (or reversed) in place on the stack.
 126
 127 Example: C<CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/> will
 128 compute the average of the values v1 to v6 after removing the smallest and
 129 largest.
 130
 131 B<TREND>
 132
 133 Create a "sliding window" average of another data series.
 134
 135 Usage:
 136 CDEF:smoothed=x,1800,TREND
 137
 138 This will create a half-hour (1800 second) sliding window average of x.  The
 139 average is essentially computed as shown here:
 140
 141                  +---!---!---!---!---!---!---!---!--->
 142                                                      now
 143                        delay     t0
 144                  <--------------->
 145                          delay       t1
 146                      <--------------->
 147                               delay      t2
 148                          <--------------->
 149
 150
 151      Value at sample (t0) will be the average between (t0-delay) and (t0)
 152      Value at sample (t1) will be the average between (t1-delay) and (t1)
 153      Value at sample (t2) will be the average between (t2-delay) and (t2)
 154
 155 =item Special values
 156
 157 B<UNKN>
 158
 159 Pushes an unknown value on the stack
 160
 161 B<INF, NEGINF>
 162
 163 Pushes a positive or negative infinite value on the stack. When
 164 such a value is graphed, it appears at the top or bottom of the
 165 graph, no matter what the actual value on the y-axis is.
 166
 167 B<PREV>
 168
 169 Pushes an I<unknown> value if this is the first value of a data
 170 set or otherwise the result of this B<CDEF> at the previous time
 171 step. This allows you to do calculations across the data.  This
 172 function cannot be used in B<VDEF> instructions.
 173
 174 B<PREV(vname)>
 175
 176 Pushes an I<unknown> value if this is the first value of a data
 177 set or otherwise the result of the vname variable at the previous time
 178 step. This allows you to do calculations across the data. This
 179 function cannot be used in B<VDEF> instructions.
 180
 181 B<COUNT>
 182
 183 Pushes the number 1 if this is the first value of the data set, the
 184 number 2 if it is the second, and so on. This special value allows
 185 you to make calculations based on the position of the value within
 186 the data set. This function cannot be used in B<VDEF> instructions.
 187
 188 Z<>
 189
 190 =item Time
 191
 192 Time inside RRDtool is measured in seconds since the epoch. The
 193 epoch is defined to be S<C<Thu Jan  1 00:00:00 UTC 1970>>.
 194
 195 B<NOW>
 196
 197 Pushes the current time on the stack.
 198
 199 B<TIME>
 200
 201 Pushes the time the currently processed value was taken at onto the stack.
 202
 203 B<LTIME>
 204
 205 Takes the time as defined by B<TIME>, applies the time zone offset
 206 valid at that time including daylight saving time if your OS supports
 207 it, and pushes the result on the stack.  There is an elaborate example
 208 in the examples section below on how to use this.
 209
 210 =item Processing the stack directly
 211
 212 B<DUP, POP, EXC>
 213
 214 Duplicate the top element, remove the top element, exchange the two
 215 top elements.
 216
 217 Z<>
 218
 219 =back
 220
 221 =head1 VARIABLES
 222
 223 These operators work only on B<VDEF> statements.
 224
 225 =over 4
 226
 227 =item MAXIMUM, MINIMUM, AVERAGE
 228
 229 Return the corresponding value, MAXIMUM and MINIMUM also return
 230 the first occurrence of that value in the time component.
 231
 232 Example: C<VDEF:avg=mydata,AVERAGE>
 233
 234 =item LAST, FIRST
 235
 236 Return the last/first value including its time.  The time for
 237 FIRST is actually the start of the corresponding interval, whereas
 238 LAST returns the end of the corresponding interval.
 239
 240 Example: C<VDEF:first=mydata,FIRST>
 241
 242 =item TOTAL
 243
 244 Returns the rate from each defined time slot multiplied with the
 245 step size.  This can, for instance, return total bytes transfered
 246 when you have logged bytes per second. The time component returns
 247 the number of seconds.
 248
 249 Example: C<VDEF:total=mydata,TOTAL>
 250
 251 =item PERCENT
 252
 253 This should follow a B<DEF> or B<CDEF> I<vname>. The I<vname> is popped,
 254 another number is popped which is a certain percentage (0..100). The
 255 data set is then sorted and the value returned is chosen such that
 256 I<percentage> percent of the values is lower or equal than the result.
 257 I<Unknown> values are considered lower than any finite number for this
 258 purpose so if this operator returns an I<unknown> you have quite a lot
 259 of them in your data.  B<Inf>inite numbers are lesser, or more, than the
 260 finite numbers and are always more than the I<Unknown> numbers.
 261 (NaN E<lt> -INF E<lt> finite values E<lt> INF)
 262
 263 Example: C<VDEF:perc95=mydata,95,PERCENT>
 264
 265 =back
 266
 267 =head1 SEE ALSO
 268
 269 L<rrdgraph> gives an overview of how B<rrdtool graph> works.
 270 L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail.
 271 L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements.
 272 L<rrdgraph_graph> page describes all of the graph and print functions.
 273
 274 Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
 275
 276 =head1 AUTHOR
 277
 278 Program by Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
 279
 280 This manual page by Alex van den Bogaerdt E<lt>alex@ergens.op.het.netE<gt>