Changeset 133 for trunk/lib/GnuplotFE.h

Timestamp:

Aug 2, 2006, 9:52:39 PM (15 years ago)

Author:

Jari Häkkinen

Message:

Fixes ticket:31. Changed GnuplotFE plot and replot to make sure that data vectors have the same length.

File:

• trunk/lib/GnuplotFE.h (modified) (1 diff)

trunk/lib/GnuplotFE.h

@@ -60 +60 @@
 
     ///
+    /// Plot the data \a y. If a date vector is set with set_dates
+    /// function before calling this function, the date vector will be
+    /// used as x values using \a format as date format
+    /// description. If no date vector is set then the \a y data will
+    /// be plot as a function of subversion revision.
     ///
+    /// @see Gnuplot documentation for date formats.
     ///
-    void plot(const std::vector<u_int>& y,const std::string& format="%y-%b");
+    /// @note \a y may change in this call: In some cases the date and
+    /// \a y data vectors may have different length. This is an effect
+    /// from subversions treatment of revisions, i.e., subversion
+    /// controlled items may have different revisions but still up to
+    /// date (at the items last changed revision). The date vector
+    /// typically contains all revisions of the repository and thus a
+    /// clash of different sized vectors may occur in gnuplot. This
+    /// situation is resolved by adding elements to \a y such that the
+    /// vector sizes match. The date vector is never expected to be
+    /// shorter than \a y vector.
+    ///
+    void plot(std::vector<u_int>& y,const std::string& format="%y-%b");
 
     ///
+    /// Plot the data \a y as a function of \a x using the Gnuplot
+    /// 'replot' command, see plot documentation for information on x
+    /// axis data and possible modifications of \a y.
     ///
-    ///
-    void replot(const std::vector<u_int>& y);
+    void replot(std::vector<u_int>& y);
 
     ///