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 I<Note: NE is not yet implemented>
  46
  47 Pop two elements from the stack, compare them for the selected condition
  48 and return 1 for true or 0 for false. Comparing an I<unknown> or an
  49 I<infinite> value will always result in 0 (false).
  50
  51 B<UN, ISINF>
  52
  53 I<Note: ISINF is not yet implemented>
  54
  55 Pop one element from the stack, compare this to I<unknown> respectively
  56 to I<positive or negative infinity>. Returns 1 for true or 0 for false.
  57
  58 B<IF>
  59
  60 Pops three elements from the stack.  If the last element is 0 (false),
  61 the first value is pushed back onto the stack, otherwise the second
  62 popped value is pushed back. This does, indeed, mean that any value
  63 other than 0 is considered true.
  64 I<Note: Should this change? It should IMHO as all the other functions
  65 would return unknown if A,B or C were unknown>
  66
  67 Example: C<A,B,C,IF> should be read as C<if (A) then (B) else (C)>
  68
  69 Z<>
  70
  71 =item Comparing values
  72
  73 B<MIN, MAX>
  74
  75 Pops two elements from the stack and returns the lesser or larger.
  76 The two numbers shouldn't be I<infinite> or I<unknown>, if they are
  77 that value is pushed back onto the stack as the result.
  78
  79 B<LIMIT>
  80
  81 Pops two elements from the stack and uses them to define a range.
  82 Then it pops another element and if it falls inside the range, it
  83 is pushed back. If not, an I<unknown> is pushed.
  84
  85 The range defined includes the two boundaries (so: a number equal
  86 to one of the boundaries will be pushed back). If any of the three
  87 numbers involved is either I<unknown> or I<infinite> this function
  88 will always return an I<unknown>
  89
  90 Example: C<CDEF:a=alpha,0,100,LIMIT> will return I<unknown> if
  91 alpha is lower than 0 or if it is higher than 100.
  92
  93 Z<>
  94
  95 =item Arithmetics
  96
  97 B<+, -, *, /, %>
  98
  99 Add, subtract, multiply, divide, modulo
 100
 101 B<SIN, COS, LOG, EXP>
 102
 103 Sine, cosine (input in radians), log, exp (natural logarithm)
 104
 105 B<FLOOR, CEIL>
 106
 107 Round down,up to the nearest integer
 108
 109 Z<>
 110
 111 =item Special values
 112
 113 B<UNKN>
 114
 115 Pushes an unknown value on the stack
 116
 117 B<INF, NEGINF>
 118
 119 Pushes a positive or negative infinite value on the stack. When
 120 such a value is graphed, it appears at the top or bottom of the
 121 graph, no matter what the actual value on the y-axis is.
 122
 123 B<PREV>
 124
 125 Pushes an I<unknown> value if this is the first value of a data
 126 set or otherwise the result of this B<CDEF> at the previous time
 127 step. This allows you to do calculations across the data.  This
 128 function cannot be used in B<VDEF> instructions.
 129
 130 Z<>
 131
 132 =item Time
 133
 134 Time inside RRDtool is measured in seconds since the epoch. This
 135 epoch is defined to be S<C<Thu Jan  1 00:00:00 UTC 1970>>.
 136
 137 Z<>
 138
 139 =over 4
 140
 141 =item NOW
 142
 143 Pushes the current time on the stack.
 144
 145 Z<>
 146
 147 =item TIME
 148
 149 Pushes the time the currently processed value was taken onto the stack.
 150
 151 Z<>
 152
 153 =item LTIME
 154
 155 Takes the time as defined by B<TIME>, applies the time zone offset
 156 valid at that time including daylight saving time if your OS supports
 157 it, and pushes the result on the stack.  There is an elaborate example
 158 in the examples section on how to use this.
 159
 160 =back
 161
 162 For B<VDEF> operations, B<TIME> and B<LTIME> have a different meaning
 163 I<not yet implemented>.  As the B<VDEF> statement does not work per
 164 value but rather on a complete time series, there is no such thing as
 165 the currently processed value.  However, if you have used an operator
 166 that returned a time component and would like to have this available
 167 in the value component in stead (so you can use it as a number), you
 168 can use B<TIME> or B<LTIME> for that.
 169
 170 Z<>
 171
 172 =item Processing the stack directly
 173
 174 B<DUP, POP, EXC>
 175
 176 Duplicate the top element, remove the top element, exchange the two
 177 top elements.
 178
 179 Z<>
 180
 181 =item Selecting characteristics
 182
 183 These operators work only on B<VDEF> statements.
 184 I<We can make most of them work at DEF and CDEF statements. If we do
 185 so, we have a moving (not rolling!) average, max,min etcetera>
 186
 187 Z<>
 188
 189 =over 4
 190
 191 =item MAXIMUM, MINIMUM, AVERAGE
 192
 193 Return the corresponding value, MAXIMUM and MINIMUM also return
 194 the first occurance of that value in the time component.
 195
 196 Example: C<VDEF:avg=mydata,AVERAGE>
 197
 198 Z<>
 199
 200 =item LAST, FIRST
 201
 202 Return the last,first value including its time.  The time for
 203 FIRST is actually the start of the corresponding interval, where
 204 LASTs time component returns the end of the corresponding interval.
 205
 206 Example: C<VDEF:first=mydata,FIRST>
 207
 208 Z<>
 209
 210 =item TOTAL
 211
 212 Returns the rate from each defined timeslot multiplied with the
 213 step size.  This can for instance return total bytes transfered
 214 when you have logged bytes per second. The time component returns
 215 the amount of seconds
 216
 217 Example: C<VDEF:total=mydata,TOTAL>
 218
 219 Z<>
 220
 221 =item PERCENT
 222
 223 Should follow a B<DEF> or B<CDEF> I<vname>. This I<vname> is popped,
 224 another number is popped which is a certain percentage (0..100). The
 225 data set is then sorted and the value returned is chosen such that
 226 I<percentage> percent of the values is lower or equal than the result.
 227 I<Unknown> values are considered lower than any finite number for this
 228 purpose so if this operator returns an I<unknown> you have quite a lot
 229 of them in your data.  B<Inf>inite numbers are lesser, or more, than the
 230 finite numbers and are always more than the I<Unknown> numbers.
 231
 232 Example: C<VDEF:perc95=mydata,95,PERCENT>
 233
 234 =back
 235
 236 =back
 237
 238 =include see_also