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