X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdgraph_rpn.pod;h=b79e4e2db3b42d7f7be588aaeee6cf91423beccd;hb=1ed31d581dfed23377a61d4df88bb9c2b9b2c94b;hp=f54bd381de2bf6e6a46b782fa56f4b27fc7f601b;hpb=ade8a598c4569fbbd663b857be6e360a2dbdb895;p=rrdtool.git

diff --git a/doc/rrdgraph_rpn.pod b/doc/rrdgraph_rpn.pod
index f54bd38..b79e4e2 100644
--- a/doc/rrdgraph_rpn.pod
+++ b/doc/rrdgraph_rpn.pod
@@ -1,21 +1,10 @@
-=head1 NAME
+=head1 NAME  
 
-rrdtool graph - Round Robin Database tool grapher functions
+rrdgraph_rpn - About RPN Math in rrdtool graph
 
-WARNING: This is for version 1.1.x which is B<I<BETA>> software.
-The software may contain serious bugs. Some of the items
-described in here may not yet exist (although this should
-be mentioned) or still be in the alpha stage.  As with every
-other RRDtool release: use at your own risk.  In contrast with
-the stable version of RRDtool, this release may contain bugs
-known to the authors.  It is highly recommended that you subscribe
-to the mailing list.
+=head1 SYNOPSIS
 
-=head1 SYNOPSYS
-
-I<E<lt>RPN expressionE<gt>> := 
-I<E<lt>vnameE<gt>>|I<E<lt>operatorE<gt>>|I<E<lt>valueE<gt>>
-[ , I<E<lt>RPN expressionE<gt>>]
+I<RPN expression>:=I<vname>|I<operator>|I<value>[,I<RPN expression>]
 
 =head1 DESCRIPTION
 
@@ -32,6 +21,11 @@ this is what is put into the I<vname>.  For B<CDEF> instructions,
 the stack is processed for each data point on the graph. B<VDEF>
 instructions work on an entire data set in one run.
 
+Example: C<VDEF:maximum=mydata,MAXIMUM>
+
+This will set variable "maximum" which you now can use in the rest
+of your RRD script.
+
 Example: C<CDEF:mydatabits=mydata,8,*>
 
 This means:  push variable I<mydata>, push the number 8, execute
@@ -53,16 +47,12 @@ would do C<a = b, 3, +, 5, *> and need no parentheses.
 
 B<LT, LE, GT, GE, EQ, NE>
 
-I<Note: NE is not yet implemented>
-
 Pop two elements from the stack, compare them for the selected condition
 and return 1 for true or 0 for false. Comparing an I<unknown> or an
 I<infinite> value will always result in 0 (false).
 
 B<UN, ISINF>
 
-I<Note: ISINF is not yet implemented>
-
 Pop one element from the stack, compare this to I<unknown> respectively
 to I<positive or negative infinity>. Returns 1 for true or 0 for false.
 
@@ -71,9 +61,7 @@ B<IF>
 Pops three elements from the stack.  If the last element is 0 (false),
 the first value is pushed back onto the stack, otherwise the second
 popped value is pushed back. This does, indeed, mean that any value
-other than 0 is considered true.
-I<Note: Should this change? It should IMHO as all the other functions
-would return unknown if A,B or C were unknown>
+other than 0 is considered to be true.
 
 Example: C<A,B,C,IF> should be read as C<if (A) then (B) else (C)>
 
@@ -109,9 +97,13 @@ B<+, -, *, /, %>
 
 Add, subtract, multiply, divide, modulo
 
-B<SIN, COS, LOG, EXP>
+B<SIN, COS, LOG, EXP, SQRT>
+
+Sine, cosine (input in radians), log, exp (natural logarithm), square root
+
+B<ATAN>
 
-Sine, cosine (input in radians), log, exp (natural logarithm)
+Arctangent. Output in radians.
 
 B<FLOOR, CEIL>
 
@@ -119,6 +111,42 @@ Round down,up to the nearest integer
 
 Z<>
 
+=item Set Operations
+
+B<SORT, REV>
+
+Pop one element from the stack.  This is the I<count> of items to be sorted
+(or reversed).  The top I<count> of the remaining elements are then sorted
+(or reversed) in place on the stack.
+
+Example: C<CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/> will
+compute the average of the values v1..v6 after removing the smallest and
+largest.
+
+B<TREND>
+
+Create a "sliding window" average of another data series.
+
+Usage:
+CDEF:smoothed=x,1800,TREND
+
+This will create a half-hour (1800 second) sliding window average of x.  The
+average is essentially computed as shown here:
+
+                 +---!---!---!---!---!---!---!---!--->
+                                                     now
+                       delay     t0
+                 <--------------->
+                         delay       t1
+                     <--------------->  
+                              delay      t2
+                         <--------------->
+
+
+     Value at sample (t0) will be the average between (t0-delay) and  (t0)
+     Value at sample (t1) will be the average between (t1-delay) and  (t1)
+     Value at sample (t2) will be the average between (t2-delay) and  (t2)
+
 =item Special values
 
 B<UNKN>
@@ -138,6 +166,20 @@ set or otherwise the result of this B<CDEF> at the previous time
 step. This allows you to do calculations across the data.  This
 function cannot be used in B<VDEF> instructions.
 
+B<PREV(vname)>
+
+Pushes an I<unknown> value if this is the first value of a data
+set or otherwise the result of vname variable at the previous time
+step. This allows you to do calculations across the data.  This
+function cannot be used in B<VDEF> instructions.
+
+B<COUNT>
+
+Pushes the number 1 if this is the first value of the data set, the 
+number 2 if it is the second, and so on. This special value, allows 
+you to make calculations based on the position of the value within 
+the data set. This function cannot be used in B<VDEF> instructions.
+
 Z<>
 
 =item Time
@@ -145,41 +187,21 @@ Z<>
 Time inside RRDtool is measured in seconds since the epoch. This
 epoch is defined to be S<C<Thu Jan  1 00:00:00 UTC 1970>>.
 
-Z<>
-
-=over 4
-
-=item NOW
+B<NOW>
 
 Pushes the current time on the stack.
 
-Z<>
-
-=item TIME
+B<TIME>
 
 Pushes the time the currently processed value was taken onto the stack.
 
-Z<>
-
-=item LTIME
+B<LTIME>
 
 Takes the time as defined by B<TIME>, applies the time zone offset
 valid at that time including daylight saving time if your OS supports
 it, and pushes the result on the stack.  There is an elaborate example
 in the examples section on how to use this.
 
-=back
-
-For B<VDEF> operations, B<TIME> and B<LTIME> have a different meaning
-I<not yet implemented>.  As the B<VDEF> statement does not work per
-value but rather on a complete time series, there is no such thing as
-the currently processed value.  However, if you have used an operator
-that returned a time component and would like to have this available
-in the value component in stead (so you can use it as a number), you
-can use B<TIME> or B<LTIME> for that.
-
-Z<>
-
 =item Processing the stack directly
 
 B<DUP, POP, EXC>
@@ -189,46 +211,38 @@ top elements.
 
 Z<>
 
-=item Selecting characteristics
+=back
 
-These operators work only on B<VDEF> statements.
-I<We can make most of them work at DEF and CDEF statements. If we do
-so, we have a moving (not rolling!) average, max,min etcetera>
+=head1 VARIABLES
 
-Z<>
+These operators work only on B<VDEF> statements.
 
 =over 4
 
 =item MAXIMUM, MINIMUM, AVERAGE
 
 Return the corresponding value, MAXIMUM and MINIMUM also return
-the first occurance of that value in the time component.
+the first occurrence of that value in the time component.
 
 Example: C<VDEF:avg=mydata,AVERAGE>
 
-Z<>
-
 =item LAST, FIRST
 
 Return the last,first value including its time.  The time for
 FIRST is actually the start of the corresponding interval, where
-LASTs time component returns the end of the corresponding interval.
+the LAST time component returns the end of the corresponding interval.
 
 Example: C<VDEF:first=mydata,FIRST>
 
-Z<>
-
 =item TOTAL
 
-Returns the rate from each defined timeslot multiplied with the
+Returns the rate from each defined time slot multiplied with the
 step size.  This can for instance return total bytes transfered
 when you have logged bytes per second. The time component returns
 the amount of seconds 
 
 Example: C<VDEF:total=mydata,TOTAL>
 
-Z<>
-
 =item PERCENT
 
 Should follow a B<DEF> or B<CDEF> I<vname>. This I<vname> is popped,
@@ -239,13 +253,12 @@ I<Unknown> values are considered lower than any finite number for this
 purpose so if this operator returns an I<unknown> you have quite a lot
 of them in your data.  B<Inf>inite numbers are lesser, or more, than the
 finite numbers and are always more than the I<Unknown> numbers.
+(NaN E<lt> -INF E<lt> finite values E<lt> INF)
 
 Example: C<VDEF:perc95=mydata,95,PERCENT>
 
 =back
 
-=back
-
 =head1 SEE ALSO
 
 L<rrdgraph> gives an overview of how B<rrdtool graph> works.