Boost-Commit :

Date view	Thread view	Subject view	Author view

From: JakeVoytko_at_[hidden]
Date: 2007-08-08 16:06:39

Next message: eric_at_[hidden]: "[Boost-commit] svn:boost r38538 - branches/proto"
Previous message: ghost_at_[hidden]: "[Boost-commit] svn:boost r38536 - in trunk/tools: bcp inspect/build"

Author: jakevoytko
Date: 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
New Revision: 38537
URL: http://svn.boost.org/trac/boost/changeset/38537

Log:
Added fix for MSVC, modified documentation

Text files modified:
   sandbox/SOC/2007/visualization/boost/svg_plot/detail/numeric_limits_handling.hpp | 4
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/HTML.manifest | 1
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html | 175 +
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/1d_special.html | 31
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/2d_special.html | 69
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/acknowledgements.html | 6
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html | 91
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_1d_layout.html | 6
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_2d_layout.html | 6
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults.html | 1122 +++++++--
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_1d_plot_interface.html | 1007 ++++++--
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_2d_plot_interface.html | 1279 ++++++++--
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_interface.html | 363 ++
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/todo.html | 7
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple.html | 37
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple.html | 40
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.qbk | 50
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.xml | 4440 ++++++++++++++++++++++++++++-----------
   18 files changed, 6343 insertions(+), 2391 deletions(-)

Modified: sandbox/SOC/2007/visualization/boost/svg_plot/detail/numeric_limits_handling.hpp
==============================================================================
--- sandbox/SOC/2007/visualization/boost/svg_plot/detail/numeric_limits_handling.hpp (original)
+++ sandbox/SOC/2007/visualization/boost/svg_plot/detail/numeric_limits_handling.hpp 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -32,7 +32,11 @@
{
     // Ternary operator used to remove warning of performance of casting
     // int to bool.
+#if defined (BOOST_MSVC)
     return _isnan(a) ? true : false;
+#else
+ return std::fpclassify(a) == FP_NAN;
+#endif
}

inline bool is_limit(double a)

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/HTML.manifest
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/HTML.manifest (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/HTML.manifest 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -7,6 +7,7 @@
svg_plot/tutorial_2d_code_simple.html
svg_plot/full_2d_layout.html
svg_plot/2d_special.html
+svg_plot/behavior.html
svg_plot/plot_defaults.html
svg_plot/svg_interface.html
svg_plot/svg_1d_plot_interface.html

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -23,12 +23,12 @@
<div>
<div><h2 class="title">
<a name="svg_plot"></a>SVG_Plot</h2></div>
-<div><div class="author"><h3 class="author">
+<div><div class="authorgroup"><div class="author"><h3 class="author">
Jake Voytko
-</h3></div></div>
+</h3></div></div></div>
<div>Copyright © 2007 Jake Voytko</div>
<div><div class="legalnotice">
-<a name="id321341"></a>
+<a name="id321345"></a>
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
@@ -49,68 +49,92 @@
<dd><dl>
<dt><a href="svg_plot/color.html#svg_plot.color.color_interface"> <code class="computeroutput">svg_color_constant</code>
 Interface</a></dt>
-<dt> Example of using svg_color_constant</dt>
-<dt> svg_color interface</dt>
-<dt> Example of using svg_color</dt>
+<dt><a href="svg_plot/color.html#svg_plot.color.svg_color_constant_example"> Example of
+ using <code class="computeroutput">svg_color_constant</code></a></dt>
+<dt><a href="svg_plot/color.html#svg_plot.color.rgb_interface"> <code class="computeroutput">svg_color</code>
+ interface</a></dt>
+<dt><a href="svg_plot/color.html#svg_plot.color.svg_color_example"> Example of using
+ <code class="computeroutput">svg_color</code></a></dt>
<dt> Internals and Rationale</dt>
</dl></dd>
-<dt> Tutorial: 1D Simple Program</dt>
+<dt><a href="svg_plot/tutorial_code_1d_simple.html"> Tutorial: 1D Simple
+ Program</a></dt>
<dd><dl>
-<dt> Code Example</dt>
+<dt><a href="svg_plot/tutorial_code_1d_simple.html#svg_plot.tutorial_code_1d_simple.tutorial_code_1d_example">
+ Code Example</a></dt>
<dt> Image</dt>
-<dt> A note on syntax</dt>
-<dt> Basic Example Breakdown</dt>
+<dt><a href="svg_plot/tutorial_code_1d_simple.html#svg_plot.tutorial_code_1d_simple.tutorial_syntax_explanation">
+ A note on syntax</a></dt>
+<dt><a href="svg_plot/tutorial_code_1d_simple.html#svg_plot.tutorial_code_1d_simple.tutorial_simple_exam">
+ Basic Example Breakdown</a></dt>
</dl></dd>
<dt> Tutorial: 1D Full Layout Example</dt>
<dt> Tutorial: 1D Special Features</dt>
<dd><dl>
<dt> X Axis Grid Lines</dt>
-<dt> X Axis External Style</dt>
+<dt><a href="svg_plot/1d_special.html#svg_plot.1d_special.x_axis_external_style"> X Axis External
+ Style</a></dt>
</dl></dd>
-<dt> Tutorial: Simple 2D Program</dt>
+<dt><a href="svg_plot/tutorial_2d_code_simple.html"> Tutorial: Simple 2D
+ Program</a></dt>
<dd><dl>
-<dt> Simple Code Example</dt>
-<dt> Simple Image</dt>
-<dt> Basic Example Breakdown</dt>
+<dt><a href="svg_plot/tutorial_2d_code_simple.html#svg_plot.tutorial_2d_code_simple.2d_simple_code_example">
+ Simple Code Example</a></dt>
+<dt><a href="svg_plot/tutorial_2d_code_simple.html#svg_plot.tutorial_2d_code_simple.2d_simple_image"> Simple
+ Image</a></dt>
+<dt><a href="svg_plot/tutorial_2d_code_simple.html#svg_plot.tutorial_2d_code_simple.tutorial_simple_exam">
+ Basic Example Breakdown</a></dt>
</dl></dd>
<dt> Tutorial: Full Layout Example</dt>
<dt> Tutorial: 2D Special Features</dt>
<dd><dl>
<dt> Y Axis Grid Lines</dt>
-<dt> External Y Axis Style</dt>
-<dt> Fill the area between the plot and the axis</dt>
+<dt><a href="svg_plot/2d_special.html#svg_plot.2d_special.external_y_axis"> External Y Axis
+ Style</a></dt>
+<dt><a href="svg_plot/2d_special.html#svg_plot.2d_special.fill_axis_plot"> Fill the area between
+ the plot and the axis</a></dt>
<dt> Curve Interpolation</dt>
</dl></dd>
+<dt> Behavior</dt>
+<dd><dl><dt> Numerical Limits</dt></dl></dd>
<dt> Defaults</dt>
<dd><dl>
-<dt> svg_1d_plot Defaults</dt>
-<dt> svg_2d_plot Defaults</dt>
+<dt><a href="svg_plot/plot_defaults.html#svg_plot.plot_defaults.1d_defaults"> <code class="computeroutput">svg_1d_plot</code>
+ Defaults</a></dt>
+<dt><a href="svg_plot/plot_defaults.html#svg_plot.plot_defaults.2d_defaults"> <code class="computeroutput">svg_2d_plot</code>
+ Defaults</a></dt>
</dl></dd>
<dt> SVG Public Interface</dt>
-<dt> svg_1d_plot Public Interface</dt>
+<dt><a href="svg_plot/svg_1d_plot_interface.html"> <code class="computeroutput">svg_1d_plot</code>
+ Public Interface</a></dt>
<dd><dl>
-<dt> Miscellaneous Functions</dt>
+<dt><a href="svg_plot/svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.svg_1d_inter_misc"> Miscellaneous
+ Functions</a></dt>
<dt> Commands</dt>
-<dt> Color Information</dt>
-<dt> Axis Information</dt>
-<dt><a href="svg_plot/svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_plot_function"> The <code class="computeroutput">plot()</code>
+<dt><a href="svg_plot/svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_inter_color"> Color
+ Information</a></dt>
+<dt><a href="svg_plot/svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_inter_axis_information">
+ Axis Information</a></dt>
+<dt><a href="svg_plot/svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_plot_function"> The
+ <code class="computeroutput">plot()</code>
 Method</a></dt>
</dl></dd>
-<dt> svg_2d_plot Public Interface</dt>
+<dt><a href="svg_plot/svg_2d_plot_interface.html"> <code class="computeroutput">svg_2d_plot</code>
+ Public Interface</a></dt>
<dd><dl>
<dt> Miscellaneous</dt>
<dt> Commands</dt>
-<dt></dt>
+<dt> Color</dt>
<dt> Axis Information</dt>
-<dt><a href="svg_plot/svg_2d_plot_interface.html#svg_plot.svg_2d_plot_interface.plot_function"> The <code class="computeroutput">plot()</code>
- Method</a></dt>
+<dt> The plot() Method</dt>
</dl></dd>
<dt> Acknowledgements</dt>
</dl>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.howtouse"></a> How To Use This Documentation</h2></div></div></div>
+<a name="svg_plot.howtouse"></a> How To Use This Documentation
+</h2></div></div></div>
<div class="toc"><dl>
<dt> Admonishments</dt>
<dt> Preface</dt>
@@ -148,45 +172,71 @@
</ul></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.howtouse.admonishments"></a> Admonishments</h3></div></div></div>
+<a name="svg_plot.howtouse.admonishments"></a> Admonishments
+</h3></div></div></div>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
- These blocks typically go into more detail about an explanation given above.
- </td></tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ 
+
+ These blocks typically go into more detail about an explanation given
+ above.
+ 
+
+ 
+</td></tr>
</table></div>
<div class="tip"><table border="0" summary="Tip">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/tip.png"></td>
<th align="left">Tip</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
- These blocks contain information that you may find helpful while coding.
- </td></tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ 
+
+ These blocks contain information that you may find helpful while coding.
+ 
+
+ 
+</td></tr>
</table></div>
<div class="important"><table border="0" summary="Important">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="images/important.png"></td>
<th align="left">Important</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
- These contain information that is imperative to understanding a concept.
- Failure to follow these blocks will likely result in undesired behavior.
- Read all of these you find.
- </td></tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ 
+
+ These contain information that is imperative to understanding a concept.
+ Failure to follow these blocks will likely result in undesired behavior.
+ Read all of these you find.
+ 
+
+ 
+</td></tr>
</table></div>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="images/warning.png"></td>
<th align="left">Warning</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
- It is imperative that you follow these. Failure to do so will lead to incorrect,
- and likely undesired, results in the plot
- </td></tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ 
+
+ It is imperative that you follow these. Failure to do so will lead to
+ incorrect, and likely undesired, results in the plot
+ 
+
+ 
+</td></tr>
</table></div>

 And the first admonishment I will use is as follows:
@@ -196,15 +246,22 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="images/important.png"></td>
<th align="left">Important</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
- This is not currently a Boost library. It is a GSoC project whose mentor
- organization is Boost.
- </td></tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ 
+
+ This is not currently a Boost library. It is a GSoC project whose mentor
+ organization is Boost.
+ 
+
+ 
+</td></tr>
</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.howtouse.preface"></a> Preface</h3></div></div></div>
+<a name="svg_plot.howtouse.preface"></a> Preface
+</h3></div></div></div>

 The first task when dealing with numerical data is to plot it. Humans have
 a fantastic capacity for visual understanding, and merely looking at data
@@ -242,17 +299,23 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
- I have only a student's grasp of C++, so if you have a suggestion to help
- me with design or implementation, email me at jakevoytko (at) gmail (dot)
- com
- </td></tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ 
+
+ I have only a student's grasp of C++, so if you have a suggestion to
+ help me with design or implementation, email me at jakevoytko (at) gmail
+ (dot) com
+ 
+
+ 
+</td></tr>
</table></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: July 31, 2007 at 01:11:42 GMT</td>
+<td align="left">Last revised: August 08, 2007 at 20:04:42 GMT</td>
<td align="right"></td>
</tr></table>
<hr>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/1d_special.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/1d_special.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/1d_special.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -7,7 +7,8 @@
<link rel="start" href="../index.html" title="SVG_Plot">
<link rel="up" href="../index.html" title="SVG_Plot">
<link rel="prev" href="full_1d_layout.html" title=" Tutorial: 1D Full Layout Example">
-<link rel="next" href="tutorial_2d_code_simple.html" title=" Tutorial: Simple 2D Program">
+<link rel="next" href="tutorial_2d_code_simple.html" title=" Tutorial: Simple 2D
+ Program">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
@@ -24,14 +25,17 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.1d_special"></a> Tutorial: 1D Special Features</h2></div></div></div>
+<a name="svg_plot.1d_special"></a> Tutorial: 1D Special Features
+</h2></div></div></div>
<div class="toc"><dl>
<dt> X Axis Grid Lines</dt>
-<dt> X Axis External Style</dt>
+<dt><a href="1d_special.html#svg_plot.1d_special.x_axis_external_style"> X Axis External
+ Style</a></dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.1d_special.x_axis_grid"></a> X Axis Grid Lines</h3></div></div></div>
+<a name="svg_plot.1d_special.x_axis_grid"></a> X Axis Grid Lines
+</h3></div></div></div>

 If you would like grid lines that go across the graph, you can make the following
 call to <code class="computeroutput">svg_1d_plot</code>:
@@ -56,7 +60,10 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.1d_special.x_axis_external_style"></a> X Axis External Style</h3></div></div></div>
+<a name="svg_plot.1d_special.x_axis_external_style"></a><a href="1d_special.html#svg_plot.1d_special.x_axis_external_style" title=" X Axis External
+ Style"> X Axis External
+ Style</a>
+</h3></div></div></div>

 For an alternate way to display a regular axis, you can use an external style:
 
@@ -75,10 +82,16 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../images/important.png"></td>
<th align="left">Important</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
- If the axis is turned off, <code class="computeroutput">x_external_style_on(true)</code>
- will not turn the axis back on. To do that, you must call <code class="computeroutput">axis_on(true)</code>
- </td></tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ 
+
+ If the axis is turned off, <code class="computeroutput">x_external_style_on(true)</code> will not turn the axis back on. To do
+ that, you must call <code class="computeroutput">axis_on(true)</code>
+ 
+
+ 
+</td></tr>
</table></div>
</div>
</div>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/2d_special.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/2d_special.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/2d_special.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -7,7 +7,7 @@
<link rel="start" href="../index.html" title="SVG_Plot">
<link rel="up" href="../index.html" title="SVG_Plot">
<link rel="prev" href="full_2d_layout.html" title=" Tutorial: Full Layout Example">
-<link rel="next" href="plot_defaults.html" title=" Defaults">
+<link rel="next" href="behavior.html" title=" Behavior">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
@@ -20,20 +20,24 @@
</table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="full_2d_layout.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="plot_defaults.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="full_2d_layout.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="behavior.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.2d_special"></a> Tutorial: 2D Special Features</h2></div></div></div>
+<a name="svg_plot.2d_special"></a> Tutorial: 2D Special Features
+</h2></div></div></div>
<div class="toc"><dl>
<dt> Y Axis Grid Lines</dt>
-<dt> External Y Axis Style</dt>
-<dt> Fill the area between the plot and the axis</dt>
+<dt><a href="2d_special.html#svg_plot.2d_special.external_y_axis"> External Y Axis
+ Style</a></dt>
+<dt><a href="2d_special.html#svg_plot.2d_special.fill_axis_plot"> Fill the area between
+ the plot and the axis</a></dt>
<dt> Curve Interpolation</dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.2d_special.y_grid_lines"></a> Y Axis Grid Lines</h3></div></div></div>
+<a name="svg_plot.2d_special.y_grid_lines"></a> Y Axis Grid Lines
+</h3></div></div></div>

 If you would like grid lines that go across the graph, you can make the following
 call to <code class="computeroutput">svg_1d_plot</code>:
@@ -58,7 +62,10 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.2d_special.external_y_axis"></a> External Y Axis Style</h3></div></div></div>
+<a name="svg_plot.2d_special.external_y_axis"></a><a href="2d_special.html#svg_plot.2d_special.external_y_axis" title=" External Y Axis
+ Style"> External Y Axis
+ Style</a>
+</h3></div></div></div>

 For an alternate way to display a regular axis, you can use an external style:
 
@@ -70,15 +77,24 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../images/important.png"></td>
<th align="left">Important</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
- If the axis is turned off, <code class="computeroutput">y_external_style_on(true)</code>
- will not turn the axis back on. To do that, you must call <code class="computeroutput">axis_on(true)</code>
- </td></tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ 
+
+ If the axis is turned off, <code class="computeroutput">y_external_style_on(true)</code> will not turn the axis back on. To do
+ that, you must call <code class="computeroutput">axis_on(true)</code>
+ 
+
+ 
+</td></tr>
</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.2d_special.fill_axis_plot"></a> Fill the area between the plot and the axis</h3></div></div></div>
+<a name="svg_plot.2d_special.fill_axis_plot"></a><a href="2d_special.html#svg_plot.2d_special.fill_axis_plot" title=" Fill the area between
+ the plot and the axis"> Fill the area between
+ the plot and the axis</a>
+</h3></div></div></div>

 When there is a call to the plot() method, define <code class="computeroutput">_area_fill_color</code>
 
@@ -97,7 +113,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.2d_special.curve_interpolation"></a> Curve Interpolation</h3></div></div></div>
+<a name="svg_plot.2d_special.curve_interpolation"></a> Curve Interpolation
+</h3></div></div></div>

 If you would like an interpolated curve shown over your data, simply use
 the following command:
@@ -116,14 +133,22 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../images/warning.png"></td>
<th align="left">Warning</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
- The <code class="computeroutput">_bezier_curve</code> feature
- is still very much in its infancy. If you play nice with it, it will play
- nice with you, but it still displays undesired behavior in extreme circumstances.
- Do not use this feature with curves that have a limit (<code class="computeroutput">-NaN</code>, for example), or with data that
- has high irregularity in X-Axis spacing (a clump of points between (0,
- 1) on the X axis, with the next one at 100 on the X axis, for example)
- </td></tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ 
+
+ The <code class="computeroutput">_bezier_curve</code> feature
+ is still very much in its infancy. If you play nice with it, it will
+ play nice with you, but it still displays undesired behavior in extreme
+ circumstances. Do not use this feature with curves that have a limit
+ (<code class="computeroutput">-NaN</code>,
+ for example), or with data that has high irregularity in X-Axis spacing
+ (a clump of points between (0, 1) on the X axis, with the next one at
+ 100 on the X axis, for example)
+ 
+
+ 
+</td></tr>
</table></div>
</div>
</div>
@@ -133,7 +158,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="full_2d_layout.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="plot_defaults.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="full_2d_layout.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="behavior.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/acknowledgements.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/acknowledgements.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/acknowledgements.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -6,7 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
<link rel="start" href="../index.html" title="SVG_Plot">
<link rel="up" href="../index.html" title="SVG_Plot">
-<link rel="prev" href="svg_2d_plot_interface.html" title=" svg_2d_plot Public Interface">
+<link rel="prev" href="svg_2d_plot_interface.html" title=" svg_2d_plot
+ Public Interface">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
@@ -23,7 +24,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.acknowledgements"></a> Acknowledgements</h2></div></div></div>
+<a name="svg_plot.acknowledgements"></a> Acknowledgements
+</h2></div></div></div>

I would like to thank the following people:

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -7,7 +7,8 @@
<link rel="start" href="../index.html" title="SVG_Plot">
<link rel="up" href="../index.html" title="SVG_Plot">
<link rel="prev" href="todo.html" title=" To Do List">
-<link rel="next" href="tutorial_code_1d_simple.html" title=" Tutorial: 1D Simple Program">
+<link rel="next" href="tutorial_code_1d_simple.html" title=" Tutorial: 1D Simple
+ Program">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
@@ -24,13 +25,17 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.color"></a> Colors</h2></div></div></div>
+<a name="svg_plot.color"></a> Colors
+</h2></div></div></div>
<div class="toc"><dl>
<dt><a href="color.html#svg_plot.color.color_interface"> <code class="computeroutput">svg_color_constant</code>
 Interface</a></dt>
-<dt> Example of using svg_color_constant</dt>
-<dt> svg_color interface</dt>
-<dt> Example of using svg_color</dt>
+<dt><a href="color.html#svg_plot.color.svg_color_constant_example"> Example of
+ using <code class="computeroutput">svg_color_constant</code></a></dt>
+<dt><a href="color.html#svg_plot.color.rgb_interface"> <code class="computeroutput">svg_color</code>
+ interface</a></dt>
+<dt><a href="color.html#svg_plot.color.svg_color_example"> Example of using
+ <code class="computeroutput">svg_color</code></a></dt>
<dt> Internals and Rationale</dt>
</dl></div>

@@ -40,8 +45,10 @@
 
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.color.color_interface"></a> <code class="computeroutput">svg_color_constant</code>
- Interface</h3></div></div></div>
+<a name="svg_plot.color.color_interface"></a><a href="color.html#svg_plot.color.color_interface" title=" svg_color_constant
+ Interface"> <code class="computeroutput">svg_color_constant</code>
+ Interface</a>
+</h3></div></div></div>

 <code class="computeroutput">svg_color_constant</code> is simply
 an enumerated list. The colors are defined here.
@@ -53,7 +60,9 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.color.svg_color_constant_example"></a> Example of using <code class="computeroutput">svg_color_constant</code>
+<a name="svg_plot.color.svg_color_constant_example"></a><a href="color.html#svg_plot.color.svg_color_constant_example" title=" Example of
+ using svg_color_constant"> Example of
+ using <code class="computeroutput">svg_color_constant</code></a>
</h3></div></div></div>
<pre class="programlisting">
using namespace boost::svg;
@@ -72,26 +81,33 @@
</tr>
<tr><td colspan="2" align="left" valign="top">

- <code class="computeroutput">svg_color</code> has a constructor
- for <code class="computeroutput">svg_color_constant</code>,
- so you can use a <code class="computeroutput">svg_color_constant</code>
- in place of a <code class="computeroutput">svg_color</code>
- and it will be implicitly converted. However, there is not currently an
- <code class="computeroutput">svg_color::operator=(svg_color_constant)</code>
- overload, so
+ 
+
+ <code class="computeroutput">svg_color</code> has a constructor
+ for <code class="computeroutput">svg_color_constant</code>,
+ so you can use a <code class="computeroutput">svg_color_constant</code>
+ in place of a <code class="computeroutput">svg_color</code>
+ and it will be implicitly converted. However, there is not currently
+ an <code class="computeroutput">svg_color::operator=(svg_color_constant)</code>
+ overload, so

<pre class="programlisting">
-svg_color my_color = red;
+svg_color my_color = red;
</pre>

- does not work.
+ does not work.
+ 
+
 
</td></tr>
</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.color.rgb_interface"></a> <code class="computeroutput">svg_color</code> interface</h3></div></div></div>
+<a name="svg_plot.color.rgb_interface"></a><a href="color.html#svg_plot.color.rgb_interface" title=" svg_color
+ interface"> <code class="computeroutput">svg_color</code>
+ interface</a>
+</h3></div></div></div>

 You can define a <code class="computeroutput">svg_color</code>
 using two different constructors
@@ -108,15 +124,23 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../images/important.png"></td>
<th align="left">Important</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
- Any integer value is accepted by the SVG standard, but negative values
- are rounded to 0, and positive values > 255 are rounded down to 255.
- </td></tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ 
+
+ Any integer value is accepted by the SVG standard, but negative values
+ are rounded to 0, and positive values > 255 are rounded down to 255.
+ 
+
+ 
+</td></tr>
</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.color.svg_color_example"></a> Example of using <code class="computeroutput">svg_color</code>
+<a name="svg_plot.color.svg_color_example"></a><a href="color.html#svg_plot.color.svg_color_example" title=" Example of using
+ svg_color"> Example of using
+ <code class="computeroutput">svg_color</code></a>
</h3></div></div></div>
<pre class="programlisting">
using namespace boost::svg;
@@ -131,17 +155,24 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
- <code class="computeroutput">svg_color</code>'s constructor
- takes in three integer values. The SVG 1.1 standard allows any integer
- to represent an RGB value, with values less than 0 and greater than 255
- being rounded to their respective min and max.
- </td></tr>
+<tr><td colspan="2" align="left" valign="top">
+
+ 
+
+ <code class="computeroutput">svg_color</code>'s constructor
+ takes in three integer values. The SVG 1.1 standard allows any integer
+ to represent an RGB value, with values less than 0 and greater than 255
+ being rounded to their respective min and max.
+ 
+
+ 
+</td></tr>
</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.color.color_internals"></a> Internals and Rationale</h3></div></div></div>
+<a name="svg_plot.color.color_internals"></a> Internals and Rationale
+</h3></div></div></div>

 Constants are defined in an enum, <code class="computeroutput">svg_color_constant</code>,
 in alphabetical order. This facilitates quick lookup of their RGB values

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_1d_layout.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_1d_layout.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_1d_layout.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -6,7 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
<link rel="start" href="../index.html" title="SVG_Plot">
<link rel="up" href="../index.html" title="SVG_Plot">
-<link rel="prev" href="tutorial_code_1d_simple.html" title=" Tutorial: 1D Simple Program">
+<link rel="prev" href="tutorial_code_1d_simple.html" title=" Tutorial: 1D Simple
+ Program">
<link rel="next" href="1d_special.html" title=" Tutorial: 1D Special Features">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -24,7 +25,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.full_1d_layout"></a> Tutorial: 1D Full Layout Example</h2></div></div></div>
+<a name="svg_plot.full_1d_layout"></a> Tutorial: 1D Full Layout Example
+</h2></div></div></div>
<pre class="programlisting">
#include <boost/svg_plot/svg_1d_plot.hpp>
#include <vector>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_2d_layout.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_2d_layout.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_2d_layout.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -6,7 +6,8 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
<link rel="start" href="../index.html" title="SVG_Plot">
<link rel="up" href="../index.html" title="SVG_Plot">
-<link rel="prev" href="tutorial_2d_code_simple.html" title=" Tutorial: Simple 2D Program">
+<link rel="prev" href="tutorial_2d_code_simple.html" title=" Tutorial: Simple 2D
+ Program">
<link rel="next" href="2d_special.html" title=" Tutorial: 2D Special Features">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -24,7 +25,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.full_2d_layout"></a> Tutorial: Full Layout Example</h2></div></div></div>
+<a name="svg_plot.full_2d_layout"></a> Tutorial: Full Layout Example
+</h2></div></div></div>
<pre class="programlisting">
#include <boost/svg_plot/svg_2d_plot.hpp>
#include <map>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -6,7 +6,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
<link rel="start" href="../index.html" title="SVG_Plot">
<link rel="up" href="../index.html" title="SVG_Plot">
-<link rel="prev" href="2d_special.html" title=" Tutorial: 2D Special Features">
+<link rel="prev" href="behavior.html" title=" Behavior">
<link rel="next" href="svg_interface.html" title=" SVG Public Interface">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -20,195 +20,476 @@
</table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="2d_special.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="svg_interface.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="behavior.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="svg_interface.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.plot_defaults"></a> Defaults</h2></div></div></div>
+<a name="svg_plot.plot_defaults"></a> Defaults
+</h2></div></div></div>
<div class="toc"><dl>
-<dt> svg_1d_plot Defaults</dt>
-<dt> svg_2d_plot Defaults</dt>
+<dt><a href="plot_defaults.html#svg_plot.plot_defaults.1d_defaults"> <code class="computeroutput">svg_1d_plot</code>
+ Defaults</a></dt>
+<dt><a href="plot_defaults.html#svg_plot.plot_defaults.2d_defaults"> <code class="computeroutput">svg_2d_plot</code>
+ Defaults</a></dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.plot_defaults.1d_defaults"></a> <code class="computeroutput">svg_1d_plot</code> Defaults</h3></div></div></div>
+<a name="svg_plot.plot_defaults.1d_defaults"></a><a href="plot_defaults.html#svg_plot.plot_defaults.1d_defaults" title=" svg_1d_plot
+ Defaults"> <code class="computeroutput">svg_1d_plot</code>
+ Defaults</a>
+</h3></div></div></div>

 You may have noticed that there are certain defaults that are true at the
 beginning of the plotting. Here is a table of the defaults:
 
-<div class="informaltable">
-<h4>
-<a name="id337510"></a>
- Default Values
- </h4>
-<table class="table">
+<div class="table">
+<a name="id338249"></a>Table 1. Default Values
+<table class="table" summary="Default Values">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
-<th>object</th>
-<th>Default value</th>
-<th>Rationale</th>
+<th>
+ 
+ object
+ 
+ </th>
+<th>
+ 
+ Default value
+ 
+ </th>
+<th>
+ 
+ Rationale
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td>All colors not defined in this table</td>
-<td>black</td>
-<td>K.I.S.S.
- Coloring will be highly dependent on user needs</td>
+<td>
+ 
+ All colors not defined in this table
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
+<td>
+ 
+ K.I.S.S. Coloring will be highly dependent on user needs
+ 
+ </td>
</tr>
<tr>
-<td>Axis</td>
-<td>On, internal style</td>
-<td>Most graphs
- include an axis of some kind. The internal axis style is used because
- this seems to be the default behavior in many textbooks I have owned.</td>
+<td>
+ 
+ Axis
+ 
+ </td>
+<td>
+ 
+ On, internal style
+ 
+ </td>
+<td>
+ 
+ Most graphs include an axis of some kind. The internal axis style is
+ used because this seems to be the default behavior in many textbooks
+ I have owned.
+ 
+ </td>
</tr>
<tr>
-<td>Distance between major X ticks</td>
-<td><code class="computeroutput">3 units</code></td>
-<td>Reasonably fits
- into a plot window</td>
+<td>
+ 
+ Distance between major X ticks
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">3 units</code>
+ 
+ </td>
+<td>
+ 
+ Reasonably fits into a plot window
+ 
+ </td>
</tr>
<tr>
-<td>Font size of the legend title</td>
-<td>12</td>
-<td>Reasonable
- when paired with the image size</td>
+<td>
+ 
+ Font size of the legend title
+ 
+ </td>
+<td>
+ 
+ 12
+ 
+ </td>
+<td>
+ 
+ Reasonable when paired with the image size
+ 
+ </td>
</tr>
<tr>
-<td>Font size of the X Label</td>
-<td>12</td>
-<td>Reasonable
- when paired with the image size</td>
+<td>
+ 
+ Font size of the X Label
+ 
+ </td>
+<td>
+ 
+ 12
+ 
+ </td>
+<td>
+ 
+ Reasonable when paired with the image size
+ 
+ </td>
</tr>
<tr>
-<td>Font size of the title</td>
-<td>30</td>
-<td>Makes
- the title stand out</td>
+<td>
+ 
+ Font size of the title
+ 
+ </td>
+<td>
+ 
+ 30
+ 
+ </td>
+<td>
+ 
+ Makes the title stand out
+ 
+ </td>
</tr>
<tr>
-<td>Grid lines</td>
-<td><code class="computeroutput">All off</code></td>
-<td>Grid lines are
- a user's personal choice, so I default with the simpler model</td>
+<td>
+ 
+ Grid lines
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">All off</code>
+ 
+ </td>
+<td>
+ 
+ Grid lines are a user's personal choice, so I default with the simpler
+ model
+ 
+ </td>
</tr>
<tr>
-<td>Image background</td>
-<td>white</td>
-<td>K.I.S.S.
- Coloring will be highly dependent on user needs.</td>
+<td>
+ 
+ Image background
+ 
+ </td>
+<td>
+ 
+ white
+ 
+ </td>
+<td>
+ 
+ K.I.S.S. Coloring will be highly dependent on user needs.
+ 
+ </td>
</tr>
<tr>
-<td>Image size</td>
-<td><code class="computeroutput">500 by 350</code></td>
-<td>Details
- discernable. The image is easily viewable by those using 800x600 monitors</td>
+<td>
+ 
+ Image size
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">500 by
+ 350</code>
+ 
+ </td>
+<td>
+ 
+ Details discernable. The image is easily viewable by those using 800x600
+ monitors
+ 
+ </td>
</tr>
<tr>
-<td>Legend</td>
-<td><code class="computeroutput">Off</code></td>
-<td>The
- goal of the defaults is to provide the cleanest possible plot as a
- default. Excluding the legend meets this goal. If there is a public
- outcry, I can change this.</td>
+<td>
+ 
+ Legend
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">Off</code>
+ 
+ </td>
+<td>
+ 
+ The goal of the defaults is to provide the cleanest possible plot as
+ a default. Excluding the legend meets this goal. If there is a public
+ outcry, I can change this.
+ 
+ </td>
</tr>
<tr>
-<td>Legend background</td>
-<td>white</td>
-<td>K.I.S.S.
- Coloring will be highly dependent on user needs</td>
+<td>
+ 
+ Legend background
+ 
+ </td>
+<td>
+ 
+ white
+ 
+ </td>
+<td>
+ 
+ K.I.S.S. Coloring will be highly dependent on user needs
+ 
+ </td>
</tr>
<tr>
-<td>Major tick length</td>
-<td>20 pixels</td>
-<td>Tasteful
- default when paired with the window size. This also makes the major
- ticks easily distinguishable from the minor ticks</td>
+<td>
+ 
+ Major tick length
+ 
+ </td>
+<td>
+ 
+ 20 pixels
+ 
+ </td>
+<td>
+ 
+ Tasteful default when paired with the window size. This also makes
+ the major ticks easily distinguishable from the minor ticks
+ 
+ </td>
</tr>
<tr>
-<td>Major tick width</td>
-<td>2 pixels</td>
-<td>Major
- ticks are more obvious than minor ticks</td>
+<td>
+ 
+ Major tick width
+ 
+ </td>
+<td>
+ 
+ 2 pixels
+ 
+ </td>
+<td>
+ 
+ Major ticks are more obvious than minor ticks
+ 
+ </td>
</tr>
<tr>
-<td>Minor tick length</td>
-<td>10 pixels</td>
-<td>Tasteful
- default when compared with the size of the grid. This makes the minor
- ticks less obvious than the major ticks</td>
+<td>
+ 
+ Minor tick length
+ 
+ </td>
+<td>
+ 
+ 10 pixels
+ 
+ </td>
+<td>
+ 
+ Tasteful default when compared with the size of the grid. This makes
+ the minor ticks less obvious than the major ticks
+ 
+ </td>
</tr>
<tr>
-<td>Minor tick width</td>
-<td>1 pixel</td>
-<td>This makes
- the minor tick less obvious than the major ticks</td>
+<td>
+ 
+ Minor tick width
+ 
+ </td>
+<td>
+ 
+ 1 pixel
+ 
+ </td>
+<td>
+ 
+ This makes the minor tick less obvious than the major ticks
+ 
+ </td>
</tr>
<tr>
-<td>Number of minor X ticks between each major X tick</td>
-<td>2</td>
-<td>This
- allows the minor ticks to appear on the integers</td>
+<td>
+ 
+ Number of minor X ticks between each major X tick
+ 
+ </td>
+<td>
+ 
+ 2
+ 
+ </td>
+<td>
+ 
+ This allows the minor ticks to appear on the integers
+ 
+ </td>
</tr>
<tr>
-<td>Plot Window</td>
-<td><code class="computeroutput">Off</code></td>
-<td>Initially
- off because it is the simplest case. I will change this if there is
- an outcry</td>
+<td>
+ 
+ Plot Window
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">Off</code>
+ 
+ </td>
+<td>
+ 
+ Initially off because it is the simplest case. I will change this if
+ there is an outcry
+ 
+ </td>
</tr>
<tr>
-<td>Plot window background</td>
-<td>white</td>
-<td>K.I.S.S.
- Coloring will be highly dependent on user needs</td>
+<td>
+ 
+ Plot window background
+ 
+ </td>
+<td>
+ 
+ white
+ 
+ </td>
+<td>
+ 
+ K.I.S.S. Coloring will be highly dependent on user needs
+ 
+ </td>
</tr>
<tr>
-<td>Title</td>
-<td>On, <code class="computeroutput">"Plot
- of data"</code>
-</td>
-<td>The title is on because
- this is one of the most basic elements of a graph. The title is set
- to a default because when <code class="computeroutput">title_on == true</code>,
- something should display</td>
+<td>
+ 
+ Title
+ 
+ </td>
+<td>
+ 
+ On, <code class="computeroutput">"Plot of data"</code>
+ 
+ </td>
+<td>
+ 
+ The title is on because this is one of the most basic elements of a
+ graph. The title is set to a default because when <code class="computeroutput">title_on
+ == true</code>,
+ something should display
+ 
+ </td>
</tr>
<tr>
-<td>Title size</td>
-<td><code class="computeroutput">30</code></td>
-<td>This
- is clearly visible in a variety of image sizes</td>
+<td>
+ 
+ Title size
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">30</code>
+ 
+ </td>
+<td>
+ 
+ This is clearly visible in a variety of image sizes
+ 
+ </td>
</tr>
<tr>
-<td>X Axis Label</td>
<td>
-<code class="computeroutput">"X
- Axis"</code>, Off</td>
-<td>"X Axis" is
- the label because something should display were the user to turn on
- the X axis label without setting text, and this is the most informative</td>
+ 
+ X Axis Label
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">"X Axis"</code>, Off
+ 
+ </td>
+<td>
+ 
+ "X Axis" is the label because something should display were
+ the user to turn on the X axis label without setting text, and this
+ is the most informative
+ 
+ </td>
</tr>
<tr>
-<td>X Axis Label Size</td>
-<td><code class="computeroutput">12</code></td>
-<td>This
- is a reasonable size at the default image size</td>
+<td>
+ 
+ X Axis Label Size
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">12</code>
+ 
+ </td>
+<td>
+ 
+ This is a reasonable size at the default image size
+ 
+ </td>
</tr>
<tr>
-<td>X Grid (Major and Minor)</td>
-<td>Off</td>
-<td>Turned
- off in the interest of providing simple, clean plots</td>
+<td>
+ 
+ X Grid (Major and Minor)
+ 
+ </td>
+<td>
+ 
+ Off
+ 
+ </td>
+<td>
+ 
+ Turned off in the interest of providing simple, clean plots
+ 
+ </td>
</tr>
<tr>
-<td>X Range</td>
-<td><code class="computeroutput">(-10, 10)</code></td>
-<td>Traditional
- plot viewport</td>
+<td>
+ 
+ X Range
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">(-10, 10)</code>
+ 
+ </td>
+<td>
+ 
+ Traditional plot viewport
+ 
+ </td>
</tr>
</tbody>
</table>
@@ -216,211 +497,532 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.plot_defaults.2d_defaults"></a> <code class="computeroutput">svg_2d_plot</code> Defaults</h3></div></div></div>
+<a name="svg_plot.plot_defaults.2d_defaults"></a><a href="plot_defaults.html#svg_plot.plot_defaults.2d_defaults" title=" svg_2d_plot
+ Defaults"> <code class="computeroutput">svg_2d_plot</code>
+ Defaults</a>
+</h3></div></div></div>

 You may have noticed that there are certain defaults that are true at the
 beginning of the plotting. Here is a table of the defaults:
 
-<div class="informaltable">
-<h4>
-<a name="id337996"></a>
- Default Values
- </h4>
-<table class="table">
+<div class="table">
+<a name="id339003"></a>Table 2. Default Values
+<table class="table" summary="Default Values">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
-<th>object</th>
-<th>Default value</th>
-<th>Rationale</th>
+<th>
+ 
+ object
+ 
+ </th>
+<th>
+ 
+ Default value
+ 
+ </th>
+<th>
+ 
+ Rationale
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td>All colors not defined in this table</td>
-<td>black</td>
-<td>K.I.S.S.
- Coloring will be highly dependent on user needs</td>
+<td>
+ 
+ All colors not defined in this table
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
+<td>
+ 
+ K.I.S.S. Coloring will be highly dependent on user needs
+ 
+ </td>
</tr>
<tr>
-<td>Axis</td>
-<td>On, internal style</td>
-<td>Most graphs
- include an axis of some kind. The internal axis style is used because
- this seems to be the default behavior in many textbooks I have owned.</td>
+<td>
+ 
+ Axis
+ 
+ </td>
+<td>
+ 
+ On, internal style
+ 
+ </td>
+<td>
+ 
+ Most graphs include an axis of some kind. The internal axis style is
+ used because this seems to be the default behavior in many textbooks
+ I have owned.
+ 
+ </td>
</tr>
<tr>
-<td>Distance between major X ticks</td>
-<td><code class="computeroutput">3 units</code></td>
-<td>Reasonably fits
- into a plot window</td>
+<td>
+ 
+ Distance between major X ticks
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">3 units</code>
+ 
+ </td>
+<td>
+ 
+ Reasonably fits into a plot window
+ 
+ </td>
</tr>
<tr>
-<td>Font size of the legend title</td>
-<td>12</td>
-<td>Reasonable
- when paired with the image size</td>
+<td>
+ 
+ Font size of the legend title
+ 
+ </td>
+<td>
+ 
+ 12
+ 
+ </td>
+<td>
+ 
+ Reasonable when paired with the image size
+ 
+ </td>
</tr>
<tr>
-<td>Font size of the X Label</td>
-<td>12</td>
-<td>Reasonable
- when paired with the image size</td>
+<td>
+ 
+ Font size of the X Label
+ 
+ </td>
+<td>
+ 
+ 12
+ 
+ </td>
+<td>
+ 
+ Reasonable when paired with the image size
+ 
+ </td>
</tr>
<tr>
-<td>Font size of the title</td>
-<td>30</td>
-<td>Makes
- the title stand out</td>
+<td>
+ 
+ Font size of the title
+ 
+ </td>
+<td>
+ 
+ 30
+ 
+ </td>
+<td>
+ 
+ Makes the title stand out
+ 
+ </td>
</tr>
<tr>
-<td>Grid lines</td>
-<td><code class="computeroutput">All off</code></td>
-<td>Grid lines are
- a user's personal choice, so I default with the simpler model</td>
+<td>
+ 
+ Grid lines
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">All off</code>
+ 
+ </td>
+<td>
+ 
+ Grid lines are a user's personal choice, so I default with the simpler
+ model
+ 
+ </td>
</tr>
<tr>
-<td>Image background</td>
-<td>white</td>
-<td>K.I.S.S.
- Coloring will be highly dependent on user needs.</td>
+<td>
+ 
+ Image background
+ 
+ </td>
+<td>
+ 
+ white
+ 
+ </td>
+<td>
+ 
+ K.I.S.S. Coloring will be highly dependent on user needs.
+ 
+ </td>
</tr>
<tr>
-<td>Image size</td>
-<td><code class="computeroutput">500 by 350</code></td>
-<td>Details
- discernable. The image is easily viewable by those using 800x600 monitors</td>
+<td>
+ 
+ Image size
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">500 by
+ 350</code>
+ 
+ </td>
+<td>
+ 
+ Details discernable. The image is easily viewable by those using 800x600
+ monitors
+ 
+ </td>
</tr>
<tr>
-<td>Legend</td>
-<td><code class="computeroutput">Off</code></td>
-<td>The
- goal of the defaults is to provide the cleanest possible plot as a
- default. Excluding the legend meets this goal. If there is a public
- outcry, I can change this.</td>
+<td>
+ 
+ Legend
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">Off</code>
+ 
+ </td>
+<td>
+ 
+ The goal of the defaults is to provide the cleanest possible plot as
+ a default. Excluding the legend meets this goal. If there is a public
+ outcry, I can change this.
+ 
+ </td>
</tr>
<tr>
-<td>Legend background</td>
-<td>white</td>
-<td>K.I.S.S.
- Coloring will be highly dependent on user needs</td>
+<td>
+ 
+ Legend background
+ 
+ </td>
+<td>
+ 
+ white
+ 
+ </td>
+<td>
+ 
+ K.I.S.S. Coloring will be highly dependent on user needs
+ 
+ </td>
</tr>
<tr>
-<td>Major tick length</td>
-<td>20 pixels</td>
-<td>Tasteful
- default when paired with the window size. This also makes the major
- ticks easily distinguishable from the minor ticks</td>
+<td>
+ 
+ Major tick length
+ 
+ </td>
+<td>
+ 
+ 20 pixels
+ 
+ </td>
+<td>
+ 
+ Tasteful default when paired with the window size. This also makes
+ the major ticks easily distinguishable from the minor ticks
+ 
+ </td>
</tr>
<tr>
-<td>Major tick width</td>
-<td>2 pixels</td>
-<td>Major
- ticks are more obvious than minor ticks</td>
+<td>
+ 
+ Major tick width
+ 
+ </td>
+<td>
+ 
+ 2 pixels
+ 
+ </td>
+<td>
+ 
+ Major ticks are more obvious than minor ticks
+ 
+ </td>
</tr>
<tr>
-<td>Minor tick length</td>
-<td>10 pixels</td>
-<td>Tasteful
- default when compared with the size of the grid. This makes the minor
- ticks less obvious than the major ticks</td>
+<td>
+ 
+ Minor tick length
+ 
+ </td>
+<td>
+ 
+ 10 pixels
+ 
+ </td>
+<td>
+ 
+ Tasteful default when compared with the size of the grid. This makes
+ the minor ticks less obvious than the major ticks
+ 
+ </td>
</tr>
<tr>
-<td>Minor tick width</td>
-<td>1 pixel</td>
-<td>This makes
- the minor tick less obvious than the major ticks</td>
+<td>
+ 
+ Minor tick width
+ 
+ </td>
+<td>
+ 
+ 1 pixel
+ 
+ </td>
+<td>
+ 
+ This makes the minor tick less obvious than the major ticks
+ 
+ </td>
</tr>
<tr>
-<td>Number of minor X ticks between each major X tick</td>
-<td>2</td>
-<td>This
- allows the minor ticks to appear on the integers</td>
+<td>
+ 
+ Number of minor X ticks between each major X tick
+ 
+ </td>
+<td>
+ 
+ 2
+ 
+ </td>
+<td>
+ 
+ This allows the minor ticks to appear on the integers
+ 
+ </td>
</tr>
<tr>
-<td>Plot Window</td>
-<td><code class="computeroutput">Off</code></td>
-<td>Initially
- off because it is the simplest case. I will change this if there is
- an outcry</td>
+<td>
+ 
+ Plot Window
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">Off</code>
+ 
+ </td>
+<td>
+ 
+ Initially off because it is the simplest case. I will change this if
+ there is an outcry
+ 
+ </td>
</tr>
<tr>
-<td>Plot window background</td>
-<td>white</td>
-<td>K.I.S.S.
- Coloring will be highly dependent on user needs</td>
+<td>
+ 
+ Plot window background
+ 
+ </td>
+<td>
+ 
+ white
+ 
+ </td>
+<td>
+ 
+ K.I.S.S. Coloring will be highly dependent on user needs
+ 
+ </td>
</tr>
<tr>
-<td>Title</td>
-<td>On, <code class="computeroutput">"Plot
- of data"</code>
-</td>
-<td>The title is on because
- this is one of the most basic elements of a graph. The title is set
- to a default because when <code class="computeroutput">title_on == true</code>,
- something should display</td>
+<td>
+ 
+ Title
+ 
+ </td>
+<td>
+ 
+ On, <code class="computeroutput">"Plot of data"</code>
+ 
+ </td>
+<td>
+ 
+ The title is on because this is one of the most basic elements of a
+ graph. The title is set to a default because when <code class="computeroutput">title_on
+ == true</code>,
+ something should display
+ 
+ </td>
</tr>
<tr>
-<td>Title size</td>
-<td><code class="computeroutput">30</code></td>
-<td>This
- is clearly visible in a variety of image sizes</td>
+<td>
+ 
+ Title size
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">30</code>
+ 
+ </td>
+<td>
+ 
+ This is clearly visible in a variety of image sizes
+ 
+ </td>
</tr>
<tr>
-<td>X Axis Label</td>
<td>
-<code class="computeroutput">"X
- Axis"</code>, Off</td>
-<td>"X Axis" is
- the label because something should display were the user to turn on
- the X axis label without setting text, and this is the most informative</td>
+ 
+ X Axis Label
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">"X Axis"</code>, Off
+ 
+ </td>
+<td>
+ 
+ "X Axis" is the label because something should display were
+ the user to turn on the X axis label without setting text, and this
+ is the most informative
+ 
+ </td>
</tr>
<tr>
-<td>X Axis Label Size</td>
-<td><code class="computeroutput">12</code></td>
-<td>This
- is a reasonable size at the default image size</td>
+<td>
+ 
+ X Axis Label Size
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">12</code>
+ 
+ </td>
+<td>
+ 
+ This is a reasonable size at the default image size
+ 
+ </td>
</tr>
<tr>
-<td>X Grid (Major and Minor)</td>
-<td>Off</td>
-<td>Turned
- off in the interest of providing simple, clean plots</td>
+<td>
+ 
+ X Grid (Major and Minor)
+ 
+ </td>
+<td>
+ 
+ Off
+ 
+ </td>
+<td>
+ 
+ Turned off in the interest of providing simple, clean plots
+ 
+ </td>
</tr>
<tr>
-<td>X Range</td>
-<td><code class="computeroutput">(-10, 10)</code></td>
-<td>Traditional
- plot viewport</td>
+<td>
+ 
+ X Range
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">(-10, 10)</code>
+ 
+ </td>
+<td>
+ 
+ Traditional plot viewport
+ 
+ </td>
</tr>
<tr>
-<td>Y Axis Label</td>
<td>
-<code class="computeroutput">"Y
- Axis"</code>, Off</td>
-<td>"Y Axis" is
- the label because something should display were the user to turn on
- the X axis label without setting text, and this is the most informative</td>
+ 
+ Y Axis Label
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">"Y Axis"</code>, Off
+ 
+ </td>
+<td>
+ 
+ "Y Axis" is the label because something should display were
+ the user to turn on the X axis label without setting text, and this
+ is the most informative
+ 
+ </td>
</tr>
<tr>
-<td>Y Axis Label Size</td>
-<td><code class="computeroutput">12</code></td>
-<td>This
- is a reasonable size at the default image size</td>
+<td>
+ 
+ Y Axis Label Size
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">12</code>
+ 
+ </td>
+<td>
+ 
+ This is a reasonable size at the default image size
+ 
+ </td>
</tr>
<tr>
-<td>Y Grid (Major and Minor)</td>
-<td>Off</td>
-<td>Turned
- off in the interest of providing simple, clean plots</td>
+<td>
+ 
+ Y Grid (Major and Minor)
+ 
+ </td>
+<td>
+ 
+ Off
+ 
+ </td>
+<td>
+ 
+ Turned off in the interest of providing simple, clean plots
+ 
+ </td>
</tr>
<tr>
-<td>Y Range</td>
-<td><code class="computeroutput">(-10, 10)</code></td>
-<td>Traditional
- plot viewport</td>
+<td>
+ 
+ Y Range
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">(-10, 10)</code>
+ 
+ </td>
+<td>
+ 
+ Traditional plot viewport
+ 
+ </td>
</tr>
</tbody>
</table>
@@ -433,7 +1035,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="2d_special.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="svg_interface.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="behavior.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="svg_interface.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_1d_plot_interface.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_1d_plot_interface.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_1d_plot_interface.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -1,13 +1,15 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> svg_1d_plot Public Interface</title>
+<title> svg_1d_plot
+ Public Interface</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
<link rel="start" href="../index.html" title="SVG_Plot">
<link rel="up" href="../index.html" title="SVG_Plot">
<link rel="prev" href="svg_interface.html" title=" SVG Public Interface">
-<link rel="next" href="svg_2d_plot_interface.html" title=" svg_2d_plot Public Interface">
+<link rel="next" href="svg_2d_plot_interface.html" title=" svg_2d_plot
+ Public Interface">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
@@ -24,348 +26,734 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.svg_1d_plot_interface"></a> <code class="computeroutput">svg_1d_plot</code> Public Interface</h2></div></div></div>
+<a name="svg_plot.svg_1d_plot_interface"></a><a href="svg_1d_plot_interface.html" title=" svg_1d_plot
+ Public Interface"> <code class="computeroutput">svg_1d_plot</code>
+ Public Interface</a>
+</h2></div></div></div>
<div class="toc"><dl>
-<dt> Miscellaneous Functions</dt>
+<dt><a href="svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.svg_1d_inter_misc"> Miscellaneous
+ Functions</a></dt>
<dt> Commands</dt>
-<dt> Color Information</dt>
-<dt> Axis Information</dt>
-<dt><a href="svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_plot_function"> The <code class="computeroutput">plot()</code>
+<dt><a href="svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_inter_color"> Color
+ Information</a></dt>
+<dt><a href="svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_inter_axis_information">
+ Axis Information</a></dt>
+<dt><a href="svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_plot_function"> The
+ <code class="computeroutput">plot()</code>
 Method</a></dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.svg_1d_plot_interface.svg_1d_inter_misc"></a> Miscellaneous Functions</h3></div></div></div>
-<div class="informaltable">
-<h4>
-<a name="id339657"></a>
- </h4>
-<table class="table">
+<a name="svg_plot.svg_1d_plot_interface.svg_1d_inter_misc"></a><a href="svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.svg_1d_inter_misc" title=" Miscellaneous
+ Functions"> Miscellaneous
+ Functions</a>
+</h3></div></div></div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Signature</th>
-<th>Description</th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_1d_plot()</code></td>
-<td>See the defaults section
- for further details</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot()</code>
+ 
+ </td>
+<td>
+ 
+ See the defaults section for further details
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& image_size(unsigned int, unsigned int)</code></td>
-<td>Sets the size of the
- image produced, in pixels</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ image_size(unsigned int, unsigned
+ int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the size of the image produced, in pixels
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& legend_title_font_size(unsigned int)</code></td>
-<td>Sets
- the font size for the legend title</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ legend_title_font_size(unsigned
+ int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the font size for the legend title
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& title(const std::string&)</code></td>
-<td>Sets
- the string to be used for the title</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ title(const std::string&)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the string to be used for the title
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& title_font_size(unsigned int)</code></td>
-<td>Sets
- the font size for the title</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ title_font_size(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the font size for the title
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& write(const std::string&)</code></td>
-<td>Writes
- the plot to the file passed as a parameter</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ write(const std::string&)</code>
+ 
+ </td>
+<td>
+ 
+ Writes the plot to the file passed as a parameter
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& write(ostream&)</code></td>
-<td>Writes the plot
- to a stream passed as a parameter</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ write(ostream&)</code>
+ 
+ </td>
+<td>
+ 
+ Writes the plot to a stream passed as a parameter
+ 
+ </td>
</tr>
</tbody>
-</table>
-</div>
+</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.svg_1d_plot_interface.1d_inter_commands"></a> Commands</h3></div></div></div>
-<div class="informaltable">
-<h4>
-<a name="id340024"></a>
- </h4>
-<table class="table">
+<a name="svg_plot.svg_1d_plot_interface.1d_inter_commands"></a> Commands
+</h3></div></div></div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Signature</th>
-<th>Description</th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_1d_plot& axis_on(bool)</code></td>
-<td>Sets whether the axis
- is on or off</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ axis_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Sets whether the axis is on or off
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& legend_on(bool)</code></td>
-<td>Sets whether the legend
- is on or off</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ legend_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Sets whether the legend is on or off
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& plot_window_on(bool)</code></td>
-<td>Sets whether the plot
- will be displayed in its own window, or will be "full screen"
- in the image</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ plot_window_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Sets whether the plot will be displayed in its own window, or will
+ be "full screen" in the image
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& title_on(bool)</code></td>
-<td>Determines whether or
- not the image title is displayed</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ title_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the image title is displayed
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_axis_on(bool)</code></td>
-<td>Determines whether or
- not the X axis is displayed</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_axis_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the X axis is displayed
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_external_style_on(bool)</code></td>
-<td>Determines whether or
- not the axis is inside or outside of the plot. Defaults to <code class="computeroutput">false</code>
-</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_external_style_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the axis is inside or outside of the plot.
+ Defaults to <code class="computeroutput">false</code>
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_label_on(bool)</code></td>
-<td>Sets whether or not
- the x axis label will show</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_label_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Sets whether or not the x axis label will show
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_major_labels_on(bool)</code></td>
-<td>sets whether or not
- the major ticks will be labelled on the x axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_major_labels_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ sets whether or not the major ticks will be labelled on the x axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_major_grid_on(bool)</code></td>
-<td>Determines whether or
- not the major grid on the X axis will be displayed</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_major_grid_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the major grid on the X axis will be displayed
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_minor_grid_on(bool)</code></td>
-<td>Determines whether or
- not the minor grid on the X axis will be displayed</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_minor_grid_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the minor grid on the X axis will be displayed
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& y_axis_on(bool)</code></td>
-<td>Determines whether or
- not the Y axis is displayed</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ y_axis_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the Y axis is displayed
+ 
+ </td>
</tr>
</tbody>
-</table>
-</div>
+</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.svg_1d_plot_interface.1d_inter_color"></a> Color Information</h3></div></div></div>
-<div class="informaltable">
-<h4>
-<a name="id340518"></a>
- </h4>
-<table class="table">
+<a name="svg_plot.svg_1d_plot_interface.1d_inter_color"></a><a href="svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_inter_color" title=" Color
+ Information"> Color
+ Information</a>
+</h3></div></div></div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Signature</th>
-<th>Description</th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_1d_plot& background_border_color(const svg_color &col)</code></td>
-<td>Set
- the background border color for the legend as <code class="computeroutput">col</code>,
- an RGB color</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ background_border_color(const svg_color &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the background border color for the legend as <code class="computeroutput">col</code>,
+ an RGB color
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& background_color(const svg_color &col)</code></td>
-<td>Set
- the background color for the whole image</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ background_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the background color for the whole image
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& legend_background_color(const svg_color &col)</code></td>
-<td>Set
- the background color for the legend as <code class="computeroutput">col</code>,
- an RGB color</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ legend_background_color(const svg_color &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the background color for the legend as <code class="computeroutput">col</code>,
+ an RGB color
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& legend_border_color(const svg_color &col)</code></td>
-<td>Set
- the border color for the legend as <code class="computeroutput">col</code>,
- an RGB color</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ legend_border_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the border color for the legend as <code class="computeroutput">col</code>,
+ an RGB color
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& plot_background_color(const svg_color &col)</code></td>
-<td>Set
- the color of the plot area. Note: this only goes into effect if plot_area(true)
- has been called</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ plot_background_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the color of the plot area. Note: this only goes into effect
+ if plot_area(true) has been called
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& title_color(const svg_color &col)</code></td>
-<td>Set
- the title color</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ title_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the title color
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_axis_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the lines that form the axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_axis_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the lines that form the axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_label_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the labels that go along the X axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_label_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the labels that go along the X axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_major_grid_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the grid that runs perpindicular to the X axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_major_grid_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the grid that runs perpindicular to the X axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_major_tick_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the major ticks of the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_major_tick_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the major ticks of the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_minor_grid_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the minor grid of the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_minor_grid_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the minor grid of the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_minor_tick_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the minor ticks of the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_minor_tick_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the minor ticks of the x-axis
+ 
+ </td>
</tr>
</tbody>
-</table>
-</div>
+</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.svg_1d_plot_interface.1d_inter_axis_information"></a> Axis Information</h3></div></div></div>
-<div class="informaltable">
-<h4>
-<a name="id341268"></a>
- </h4>
-<table class="table">
+<a name="svg_plot.svg_1d_plot_interface.1d_inter_axis_information"></a><a href="svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_inter_axis_information" title="
+ Axis Information">
+ Axis Information</a>
+</h3></div></div></div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Signature</th>
-<th>Description</th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_axis_width(unsigned int)</code></td>
-<td>Sets
- the stroke width of the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_axis_width(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the stroke width of the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_label(const std::string&)</code></td>
-<td>Sets
- the label of the x-axis. This does not guarantee that it will be shown.
- You must run <code class="computeroutput">x_label_on(true)</code> for that guarantee</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_label(const std::string&)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the label of the x-axis. This does not guarantee that it will
+ be shown. You must run <code class="computeroutput">x_label_on(true)</code> for that guarantee
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_major_interval(double)</code></td>
-<td>Sets the distance (in
- Cartesian units) between ticks on the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_major_interval(double)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the distance (in Cartesian units) between ticks on the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_major_tick_length(int)</code></td>
-<td>Sets the length (in
- pixels) of the x-axis major ticks</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_major_tick_length(int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the length (in pixels) of the x-axis major ticks
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_major_tick_width(unsigned int)</code></td>
-<td>Sets
- the width (in pixels) of the major ticks on the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_major_tick_width(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the width (in pixels) of the major ticks on the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_minor_tick_length(int)</code></td>
-<td>Sets the length (in
- pixels) of the x-axis minor tick lengths</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_minor_tick_length(int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the length (in pixels) of the x-axis minor tick lengths
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_minor_tick_width(unsigned int)</code></td>
-<td>Sets
- the width (in pixels) of the minor ticks on the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_minor_tick_width(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the width (in pixels) of the minor ticks on the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_num_minor_ticks(int)</code></td>
-<td>Sets the number of minor
- ticks between each major tick</td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_num_minor_ticks(int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the number of minor ticks between each major tick
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& x_range(double x1, double x2)</code></td>
-<td>Sets the scale of the
- x axis from x1 to x2. Throws an exception if x2<=x1 </td>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
+ x_range(double x1, double
+ x2)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the scale of the x axis from x1 to x2. Throws an exception if
+ x2<=x1
+ 
+ </td>
</tr>
</tbody>
-</table>
-</div>
+</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.svg_1d_plot_interface.1d_plot_function"></a> The <code class="computeroutput">plot()</code>
- Method</h3></div></div></div>
+<a name="svg_plot.svg_1d_plot_interface.1d_plot_function"></a><a href="svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_plot_function" title=" The
+ plot()
+ Method"> The
+ <code class="computeroutput">plot()</code>
+ Method</a>
+</h3></div></div></div>

 The <code class="computeroutput">plot()</code>
 method is defined using Boost.Parameter. As such, it supports a few extra
 named parameters, as well as a deduced parameter.
 
-<div class="informaltable">
-<h4>
-<a name="id341782"></a>
- Required parameter
- </h4>
-<table class="table">
+<div class="table">
+<a name="id343607"></a>Table 4. Required parameter
+<table class="table" summary="Required parameter">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
-<th>ID</th>
-<th>Type (* is a wildcard)</th>
-<th>Description</th>
+<th>
+ 
+ ID
+ 
+ </th>
+<th>
+ 
+ Type (* is a wildcard)
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td>_container</td>
-<td>*</td>
-<td>Any object that can
- return an iterator with begin() and end()</td>
-</tr>
-<tr>
-<td>_title</td>
-<td><code class="computeroutput">std::string</code></td>
-<td>The
- name of this series</td>
+<td>
+ 
+ _container
+ 
+ </td>
+<td>
+ 
+ *
+ 
+ </td>
+<td>
+ 
+ Any object that can return an iterator with begin() and end()
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ _title
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">std::string</code>
+ 
+ </td>
+<td>
+ 
+ The name of this series
+ 
+ </td>
</tr>
</tbody>
</table>
</div>
-<div class="informaltable">
-<h4>
-<a name="id341860"></a>
- Deduced parameter
- </h4>
-<table class="table">
+<div class="table">
+<a name="id343710"></a>Table 5. Deduced parameter
+<table class="table" summary="Deduced parameter">
<colgroup>
<col>
<col>
@@ -373,26 +761,55 @@
<col>
</colgroup>
<thead><tr>
-<th>ID</th>
-<th>Type</th>
-<th>Description</th>
-<th>Default</th>
+<th>
+ 
+ ID
+ 
+ </th>
+<th>
+ 
+ Type
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Default
+ 
+ </th>
</tr></thead>
<tbody><tr>
-<td>_fill_color</td>
-<td><code class="computeroutput">svg_color</code></td>
-<td>This
- is the color that shows up inside of the circle that is being drawn</td>
-<td>white</td>
+<td>
+ 
+ _fill_color
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">svg_color</code>
+ 
+ </td>
+<td>
+ 
+ This is the color that shows up inside of the circle that is being
+ drawn
+ 
+ </td>
+<td>
+ 
+ white
+ 
+ </td>
</tr></tbody>
</table>
</div>
-<div class="informaltable">
-<h4>
-<a name="id341923"></a>
- Optional Parameters
- </h4>
-<table class="table">
+<div class="table">
+<a name="id343794"></a>Table 6. Optional Parameters
+<table class="table" summary="Optional Parameters">
<colgroup>
<col>
<col>
@@ -400,60 +817,137 @@
<col>
</colgroup>
<thead><tr>
-<th>ID</th>
-<th>Type</th>
-<th>Description</th>
-<th>Default</th>
+<th>
+ 
+ ID
+ 
+ </th>
+<th>
+ 
+ Type
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Default
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td>_stroke_color</td>
-<td><code class="computeroutput">svg_color</code></td>
-<td>The
- outline of the circle that is being drawn</td>
-<td>black</td>
-</tr>
-<tr>
-<td>_point_style</td>
-<td><code class="computeroutput">point_shape</code></td>
-<td>This
- is the shape of the point. Options currently are between <code class="literal">none</code>,
- <code class="literal">circle</code>, and <code class="literal">square</code>.</td>
-<td>circle</td>
-</tr>
-<tr>
-<td>_size</td>
-<td><code class="computeroutput">unsigned int</code></td>
-<td>This is the height/width
- of the circle and square.</td>
-<td>10</td>
-</tr>
-<tr>
-<td>_x_functor</td>
-<td>*</td>
-<td>A class or that contains
- a conversion function. You will not have to worry about this, unless
- you are trying to accomplish stuff like plotting a vector of humans.
- For example:
-<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">
-class my_functor
+<td>
+ 
+ _stroke_color
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">svg_color</code>
+ 
+ </td>
+<td>
+ 
+ The outline of the circle that is being drawn
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ _point_style
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">point_shape</code>
+ 
+ </td>
+<td>
+ 
+ This is the shape of the point. Options currently are between <code class="literal">none</code>,
+ <code class="literal">circle</code>, and <code class="literal">square</code>.
+ 
+ </td>
+<td>
+ 
+ circle
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ _size
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unsigned int</code>
+ 
+ </td>
+<td>
+ 
+ This is the height/width of the circle and square.
+ 
+ </td>
+<td>
+ 
+ 10
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ _x_functor
+ 
+ </td>
+<td>
+ 
+ *
+ 
+ </td>
+<td>
+ 
+ A class or that contains a conversion function. You will not have to
+ worry about this, unless you are trying to accomplish stuff like plotting
+ a vector of humans. For example:
+
+<pre class="programlisting">
+class my_functor
{
- typdef double result_type;
+ typdef double result_type;

- double operator()(const human& _hum)
+ double operator()(const human& _hum)
 {
- return (double)(_hum.age());
+ return (double)(_hum.age());
 }
}

// snip

-plot(my_plot, my_data, "Lions", _x_functor = my_functor());
+plot(my_plot, my_data, "Lions", _x_functor = my_functor());
</pre>
- </td>
-<td> <code class="computeroutput">boost_default_convert</code>
+
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">boost_default_convert</code>
 is sufficient in all cases where the data stored in the container can
- be directly casted to a double</td>
+ be directly casted to a double
+ 
+ </td>
</tr>
</tbody>
</table>
@@ -462,8 +956,9 @@
 Here are some examples of correct uses:
 
<a name="svg_plot.svg_1d_plot_interface.1d_plot_function.using_fill_and_stroke_colors"></a><h3>
-<a name="id342293"></a>
- Using fill and stroke colors
+<a name="id344230"></a>
+ <a href="svg_1d_plot_interface.html#svg_plot.svg_1d_plot_interface.1d_plot_function.using_fill_and_stroke_colors">Using
+ fill and stroke colors</a>
 </h3>
<pre class="programlisting">
my_plot.plot(my_data, "Lions",

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_2d_plot_interface.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_2d_plot_interface.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_2d_plot_interface.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -1,12 +1,14 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> svg_2d_plot Public Interface</title>
+<title> svg_2d_plot
+ Public Interface</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
<link rel="start" href="../index.html" title="SVG_Plot">
<link rel="up" href="../index.html" title="SVG_Plot">
-<link rel="prev" href="svg_1d_plot_interface.html" title=" svg_1d_plot Public Interface">
+<link rel="prev" href="svg_1d_plot_interface.html" title=" svg_1d_plot
+ Public Interface">
<link rel="next" href="acknowledgements.html" title=" Acknowledgements">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -24,420 +26,910 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.svg_2d_plot_interface"></a> <code class="computeroutput">svg_2d_plot</code> Public Interface</h2></div></div></div>
+<a name="svg_plot.svg_2d_plot_interface"></a><a href="svg_2d_plot_interface.html" title=" svg_2d_plot
+ Public Interface"> <code class="computeroutput">svg_2d_plot</code>
+ Public Interface</a>
+</h2></div></div></div>
<div class="toc"><dl>
<dt> Miscellaneous</dt>
<dt> Commands</dt>
-<dt></dt>
+<dt> Color</dt>
<dt> Axis Information</dt>
-<dt><a href="svg_2d_plot_interface.html#svg_plot.svg_2d_plot_interface.plot_function"> The <code class="computeroutput">plot()</code>
- Method</a></dt>
+<dt> The plot() Method</dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.svg_2d_plot_interface.2d_inter_misc"></a> Miscellaneous</h3></div></div></div>
-<div class="informaltable">
-<h4>
-<a name="id342582"></a>
- </h4>
-<table class="table">
+<a name="svg_plot.svg_2d_plot_interface.2d_inter_misc"></a> Miscellaneous
+</h3></div></div></div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Signature</th>
-<th>Description</th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_2d_plot()</code></td>
-<td>See the defaults section
- for further details</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot()</code>
+ 
+ </td>
+<td>
+ 
+ See the defaults section for further details
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& image_size(unsigned int, unsigned int)</code></td>
-<td>Sets the size of the
- image produced, in pixels</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ image_size(unsigned int, unsigned
+ int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the size of the image produced, in pixels
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& title(const std::string&)</code></td>
-<td>Sets
- the string to be used for the title</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ title(const std::string&)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the string to be used for the title
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& title_font_size(unsigned int)</code></td>
-<td>Sets
- the font size for the title</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ title_font_size(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the font size for the title
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& legend_title_font_size(unsigned int)</code></td>
-<td>Sets
- the font size for the legend title</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ legend_title_font_size(unsigned
+ int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the font size for the legend title
+ 
+ </td>
</tr>
</tbody>
-</table>
-</div>
+</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.svg_2d_plot_interface.2d_inter_commands"></a> Commands</h3></div></div></div>
-<div class="informaltable">
-<h4>
-<a name="id342853"></a>
- </h4>
-<table class="table">
+<a name="svg_plot.svg_2d_plot_interface.2d_inter_commands"></a> Commands
+</h3></div></div></div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Signature</th>
-<th>Description</th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_2d_plot& axis_on(bool)</code></td>
-<td>Sets whether the axis
- is on or off</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ axis_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Sets whether the axis is on or off
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& legend_on(bool)</code></td>
-<td>Sets whether the legend
- is on or off</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ legend_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Sets whether the legend is on or off
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& plot_window_on(bool)</code></td>
-<td>Sets whether the plot
- will be displayed in its own window, or will be "full screen"
- in the image</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ plot_window_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Sets whether the plot will be displayed in its own window, or will
+ be "full screen" in the image
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& title_on(bool)</code></td>
-<td>Determines whether or
- not the image title is displayed</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ title_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the image title is displayed
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_label_on(bool)</code></td>
-<td>Sets whether or not
- the X axis label will show</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_label_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Sets whether or not the X axis label will show
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_major_grid_on(bool)</code></td>
-<td>Determines whether or
- not the major grid on the X axis will be displayed</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_major_grid_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the major grid on the X axis will be displayed
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_major_labels_on(bool)</code></td>
-<td>sets whether or not
- the major ticks will be labelled on the x axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_major_labels_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ sets whether or not the major ticks will be labelled on the x axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_minor_grid_on(bool)</code></td>
-<td>Determines whether or
- not the minor grid on the X axis will be displayed</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_minor_grid_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the minor grid on the X axis will be displayed
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_label_on(bool)</code></td>
-<td>Sets whether or not
- the Y axis label will show</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_label_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Sets whether or not the Y axis label will show
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_major_grid_on(bool)</code></td>
-<td>Determines whether or
- not the major grid on the Y axis will be displayed</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_major_grid_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the major grid on the Y axis will be displayed
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_major_labels_on(bool)</code></td>
-<td>sets whether or not
- the major ticks will be labelled on the Y axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_major_labels_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ sets whether or not the major ticks will be labelled on the Y axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_minor_grid_on(bool)</code></td>
-<td>Determines whether or
- not the minor grid on the Y axis will be displayed</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_minor_grid_on(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the minor grid on the Y axis will be displayed
+ 
+ </td>
</tr>
</tbody>
-</table>
-</div>
+</table></div>
</div>
<div class="section" lang="en">
-<div class="titlepage"></div>
-<div class="informaltable">
-<h4>
-<a name="id343378"></a>
- </h4>
-<table class="table">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="svg_plot.svg_2d_plot_interface.2d_inter_color"></a> Color
+</h3></div></div></div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Signature</th>
-<th>Description</th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_2d_plot& title_color(const svg_color &col)</code></td>
-<td>Set
- the title color</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ title_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the title color
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& background_color(const svg_color &col)</code></td>
-<td>Set
- the background color for the whole image</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ background_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the background color for the whole image
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& legend_background_color(const svg_color &col)</code></td>
-<td>Set
- the background color for the legend as <code class="computeroutput">col</code>,
- an RGB color</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ legend_background_color(const svg_color &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the background color for the legend as <code class="computeroutput">col</code>,
+ an RGB color
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& legend_border_color(const svg_color &col)</code></td>
-<td>Set
- the border color for the legend as <code class="computeroutput">col</code>,
- an RGB color</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ legend_border_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the border color for the legend as <code class="computeroutput">col</code>,
+ an RGB color
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& background_border_color(const svg_color &col)</code></td>
-<td>Set
- the background border color for the legend as <code class="computeroutput">col</code>,
- an RGB color</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ background_border_color(const svg_color &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the background border color for the legend as <code class="computeroutput">col</code>,
+ an RGB color
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& plot_background_color(const svg_color &col)</code></td>
-<td>Set
- the color of the plot area. Note: this only goes into effect if plot_area(true)
- has been called</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ plot_background_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the color of the plot area. Note: this only goes into effect
+ if plot_area(true) has been called
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_axis_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the lines that form the axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_axis_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the lines that form the axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_label_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the labels that go along the X axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_label_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the labels that go along the X axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_major_tick_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the major ticks of the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_major_tick_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the major ticks of the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_major_grid_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the grid that runs perpindicular to the X axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_major_grid_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the grid that runs perpindicular to the X axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_minor_tick_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the minor ticks of the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_minor_tick_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the minor ticks of the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_axis_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the lines that form the Y axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_axis_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the lines that form the Y axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_label_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the labels that go along the X axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_label_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the labels that go along the X axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_major_tick_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the major ticks of the Y-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_major_tick_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the major ticks of the Y-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_major_grid_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the grid that runs perpindicular to the Y axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_major_grid_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the grid that runs perpindicular to the Y axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_minor_tick_color(const svg_color &col)</code></td>
-<td>Sets
- the color of the minor ticks of the Y-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_minor_tick_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color of the minor ticks of the Y-axis
+ 
+ </td>
</tr>
</tbody>
-</table>
-</div>
+</table></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.svg_2d_plot_interface.2d_inter_axis"></a> Axis Information</h3></div></div></div>
-<div class="informaltable">
-<h4>
-<a name="id344355"></a>
- </h4>
-<table class="table">
+<a name="svg_plot.svg_2d_plot_interface.2d_inter_axis"></a> Axis Information
+</h3></div></div></div>
+<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Signature</th>
-<th>Description</th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_axis_width(unsigned int)</code></td>
-<td>Sets
- the stroke width of the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_axis_width(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the stroke width of the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_label(const std::string&)</code></td>
-<td>Sets
- the label of the x-axis. This does not guarantee that it will be shown.
- You must run <code class="computeroutput">x_label(true)</code> for that guarantee</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_label(const std::string&)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the label of the x-axis. This does not guarantee that it will
+ be shown. You must run <code class="computeroutput">x_label(true)</code> for that guarantee
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_major_interval(double)</code></td>
-<td>Sets the distance (in
- Cartesian units) between ticks on the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_major_interval(double)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the distance (in Cartesian units) between ticks on the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_major_tick_length(int)</code></td>
-<td>Sets the length (in
- pixels) of the x-axis major ticks</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_major_tick_length(int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the length (in pixels) of the x-axis major ticks
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_major_tick_width(unsigned int)</code></td>
-<td>Sets
- the width (in pixels) of the major ticks on the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_major_tick_width(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the width (in pixels) of the major ticks on the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_minor_tick(unsigned int)</code></td>
-<td>Sets
- the length (in pixels) of the x-axis minor ticks</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_minor_tick(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the length (in pixels) of the x-axis minor ticks
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_minor_tick_length(int)</code></td>
-<td>Sets the length (in
- pixels) of the x-axis minor tick lengths</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_minor_tick_length(int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the length (in pixels) of the x-axis minor tick lengths
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_minor_tick_width(unsigned int)</code></td>
-<td>Sets
- the width (in pixels) of the minor ticks on the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_minor_tick_width(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the width (in pixels) of the minor ticks on the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_num_minor_ticks(int)</code></td>
-<td>Sets the number of minor
- ticks between each major tick</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_num_minor_ticks(int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the number of minor ticks between each major tick
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& x_range(double x1, double x2)</code></td>
-<td>Sets the scale of the
- x axis from x1 to x2. Throws an exception if x2<=x1 </td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_range(double x1, double
+ x2)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the scale of the x axis from x1 to x2. Throws an exception if
+ x2<=x1
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_axis_width(unsigned int)</code></td>
-<td>Sets
- the stroke width of the x-axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_axis_width(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the stroke width of the x-axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_label(const std::string&)</code></td>
-<td>Sets
- the label of the x-axis. This does not guarantee that it will be shown.
- You must run <code class="computeroutput">x_label(true)</code> for that guarantee</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_label(const std::string&)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the label of the x-axis. This does not guarantee that it will
+ be shown. You must run <code class="computeroutput">x_label(true)</code> for that guarantee
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_major_tick(double)</code></td>
-<td>Sets the distance (in
- Cartesian units) between ticks on the Y axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_major_tick(double)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the distance (in Cartesian units) between ticks on the Y axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_major_tick_length(int)</code></td>
-<td>Sets the length (in
- pixels) of the Y axis major ticks</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_major_tick_length(int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the length (in pixels) of the Y axis major ticks
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_major_tick_width(unsigned int)</code></td>
-<td>Sets
- the width (in pixels) of the major ticks on the Y axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_major_tick_width(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the width (in pixels) of the major ticks on the Y axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_minor_tick(unsigned int)</code></td>
-<td>Sets
- the length (in pixels) of the Y axis minor ticks</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_minor_tick(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the length (in pixels) of the Y axis minor ticks
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_major_tick_length(int)</code></td>
-<td>Sets the length (in
- pixels) of the Y axis minor tick lengths</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_major_tick_length(int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the length (in pixels) of the Y axis minor tick lengths
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_minor_tick_width(unsigned int)</code></td>
-<td>Sets
- the width (in pixels) of the minor ticks on the Y axis</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_minor_tick_width(unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the width (in pixels) of the minor ticks on the Y axis
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_num_minor_ticks(int)</code></td>
-<td>Sets the number of minor
- ticks between each major tick</td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_num_minor_ticks(int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the number of minor ticks between each major tick
+ 
+ </td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& y_scale(double y1, double y2)</code></td>
-<td>Sets the scale of the
- Y axis from y1 to y2. Throws an exception if y2<=y1 </td>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_scale(double y1, double
+ y2)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the scale of the Y axis from y1 to y2. Throws an exception if
+ y2<=y1
+ 
+ </td>
</tr>
</tbody>
-</table>
-</div>
+</table></div>
</div>

 (Note: Getters omitted for now)
 
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.svg_2d_plot_interface.plot_function"></a> The <code class="computeroutput">plot()</code>
- Method</h3></div></div></div>
+<a name="svg_plot.svg_2d_plot_interface.plot_function"></a> The plot() Method
+</h3></div></div></div>

 The <code class="computeroutput">plot()</code>
 method is defined using Boost.Parameter. As such, it supports a few extra
 named parameters, as well as a deduced parameter.
 
-<div class="informaltable">
-<h4>
-<a name="id345405"></a>
- Required parameter
- </h4>
-<table class="table">
+<div class="table">
+<a name="id347819"></a>Table 7. Required parameter
+<table class="table" summary="Required parameter">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
-<th>ID</th>
-<th>Type (* is a wildcard)</th>
-<th>Description</th>
+<th>
+ 
+ ID
+ 
+ </th>
+<th>
+ 
+ Type (* is a wildcard)
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td>_container</td>
-<td>*</td>
-<td>Any object that can
- return an iterator with begin() and end()</td>
+<td>
+ 
+ _container
+ 
+ </td>
+<td>
+ 
+ *
+ 
+ </td>
+<td>
+ 
+ Any object that can return an iterator with begin() and end()
+ 
+ </td>
</tr>
<tr>
-<td>_title</td>
-<td><code class="computeroutput">std::string</code></td>
-<td>The
- name of this series</td>
+<td>
+ 
+ _title
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">std::string</code>
+ 
+ </td>
+<td>
+ 
+ The name of this series
+ 
+ </td>
</tr>
</tbody>
</table>
</div>
-<div class="informaltable">
-<h4>
-<a name="id345483"></a>
- Deduced parameter
- </h4>
-<table class="table">
+<div class="table">
+<a name="id347922"></a>Table 8. Deduced parameter
+<table class="table" summary="Deduced parameter">
<colgroup>
<col>
<col>
@@ -445,26 +937,55 @@
<col>
</colgroup>
<thead><tr>
-<th>ID</th>
-<th>Type</th>
-<th>Description</th>
-<th>Default</th>
+<th>
+ 
+ ID
+ 
+ </th>
+<th>
+ 
+ Type
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Default
+ 
+ </th>
</tr></thead>
<tbody><tr>
-<td>_fill_color</td>
-<td><code class="computeroutput">svg_color</code></td>
-<td>This
- is the color that shows up inside of the circle that is being drawn</td>
-<td>white</td>
+<td>
+ 
+ _fill_color
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">svg_color</code>
+ 
+ </td>
+<td>
+ 
+ This is the color that shows up inside of the circle that is being
+ drawn
+ 
+ </td>
+<td>
+ 
+ white
+ 
+ </td>
</tr></tbody>
</table>
</div>
-<div class="informaltable">
-<h4>
-<a name="id345546"></a>
- Optional Parameters
- </h4>
-<table class="table">
+<div class="table">
+<a name="id348006"></a>Table 9. Optional Parameters
+<table class="table" summary="Optional Parameters">
<colgroup>
<col>
<col>
@@ -472,95 +993,224 @@
<col>
</colgroup>
<thead><tr>
-<th>ID</th>
-<th>Type</th>
-<th>Description</th>
-<th>Default</th>
+<th>
+ 
+ ID
+ 
+ </th>
+<th>
+ 
+ Type
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Default
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td>_bezier_on</td>
-<td><code class="computeroutput">bool</code></td>
<td>
+ 
+ _bezier_on
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bool</code>
+ 
+ </td>
+<td>
+ 
 This determines whether or not Bézier curve interpolation will be
 applied to the plot lines. It is important to note that the curve interpolation
 is still in its infancy, and should only be used with reasonably nice
- data sets</td>
+ data sets
+ 
+ </td>
<td class="auto-generated"> </td>
</tr>
<tr>
-<td>_line_on</td>
-<td><code class="computeroutput">bool</code></td>
<td>
- This determines whether or not there are lines drawn between data points.</td>
-<td>false</td>
+ 
+ _line_on
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bool</code>
+ 
+ </td>
+<td>
+ 
+ This determines whether or not there are lines drawn between data points.
+ 
+ </td>
+<td>
+ 
+ false
+ 
+ </td>
</tr>
<tr>
-<td>_line_color</td>
-<td><code class="computeroutput">bool</code></td>
<td>
- This determines the color of the lines between data points </td>
-<td>black
- </td>
+ 
+ _line_color
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bool</code>
+ 
+ </td>
+<td>
+ 
+ This determines the color of the lines between data points
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
</tr>
<tr>
-<td>_area_fill_color</td>
-<td><code class="computeroutput">svg_color</code></td>
-<td>Defining
- this enables the "Fill Area Under Axis" feature. the color
- you define will be the fill color between a line and the area under
- the axis. This only takes effect if <code class="computeroutput">_line_on = true</code>
- is called.</td>
+<td>
+ 
+ _area_fill_color
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">svg_color</code>
+ 
+ </td>
+<td>
+ 
+ Defining this enables the "Fill Area Under Axis" feature.
+ the color you define will be the fill color between a line and the
+ area under the axis. This only takes effect if <code class="computeroutput">_line_on
+ = true</code>
+ is called.
+ 
+ </td>
<td class="auto-generated"> </td>
</tr>
<tr>
-<td>_stroke_color</td>
-<td><code class="computeroutput">svg_color</code></td>
-<td>The
- outline of the circle that is being drawn</td>
-<td>black</td>
-</tr>
-<tr>
-<td>_point_style</td>
-<td><code class="computeroutput">point_shape</code></td>
-<td>This
- is the shape of the point. Options currently are between <code class="literal">none</code>,
- <code class="literal">circle</code>, and <code class="literal">square</code>.</td>
-<td>circle</td>
-</tr>
-<tr>
-<td>_size</td>
-<td><code class="computeroutput">unsigned int</code></td>
-<td>This is the height/width
- of the circle and square.</td>
-<td>10</td>
-</tr>
-<tr>
-<td>_x_functor</td>
-<td>*</td>
-<td>A class or that contains
- a conversion function. You will not have to worry about this, unless
- you are trying to accomplish stuff like plotting a vector of humans.
- For example:
-<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">
-class my_functor
+<td>
+ 
+ _stroke_color
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">svg_color</code>
+ 
+ </td>
+<td>
+ 
+ The outline of the circle that is being drawn
+ 
+ </td>
+<td>
+ 
+ black
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ _point_style
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">point_shape</code>
+ 
+ </td>
+<td>
+ 
+ This is the shape of the point. Options currently are between <code class="literal">none</code>,
+ <code class="literal">circle</code>, and <code class="literal">square</code>.
+ 
+ </td>
+<td>
+ 
+ circle
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ _size
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unsigned int</code>
+ 
+ </td>
+<td>
+ 
+ This is the height/width of the circle and square.
+ 
+ </td>
+<td>
+ 
+ 10
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ _x_functor
+ 
+ </td>
+<td>
+ 
+ *
+ 
+ </td>
+<td>
+ 
+ A class or that contains a conversion function. You will not have to
+ worry about this, unless you are trying to accomplish stuff like plotting
+ a vector of humans. For example:
+
+<pre class="programlisting">
+class my_functor
{
- typdef pair<double, double> result_type;
+ typdef pair<double, double> result_type;

- pair<double, double> operator()(const human& _hum) const
+ pair<double, double> operator()(const human& _hum) const
 {
- return pair<double, double>(i, _hum.age());
+ return pair<double, double>(i, _hum.age());
 }
}

// snip

-plot(my_plot, my_data, "Lions", _x_functor = my_functor());
+plot(my_plot, my_data, "Lions", _x_functor = my_functor());
</pre>
- </td>
-<td> <code class="computeroutput">boost_default_2d_convert</code>
+
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">boost_default_2d_convert</code>
 (the default) is sufficient in all cases where the data stored in the
- container can be directly casted to a double</td>
+ container can be directly casted to a double
+ 
+ </td>
</tr>
</tbody>
</table>
@@ -569,8 +1219,9 @@
 Here are some examples of correct uses:
 
<a name="svg_plot.svg_2d_plot_interface.plot_function.using_fill_and_stroke_colors"></a><h3>
-<a name="id346102"></a>
- Using fill and stroke colors
+<a name="id348682"></a>
+ <a href="svg_2d_plot_interface.html#svg_plot.svg_2d_plot_interface.plot_function.using_fill_and_stroke_colors">Using
+ fill and stroke colors</a>
 </h3>
<pre class="programlisting">
my_plot.(my_data, "Lions",

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_interface.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_interface.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_interface.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -7,7 +7,8 @@
<link rel="start" href="../index.html" title="SVG_Plot">
<link rel="up" href="../index.html" title="SVG_Plot">
<link rel="prev" href="plot_defaults.html" title=" Defaults">
-<link rel="next" href="svg_1d_plot_interface.html" title=" svg_1d_plot Public Interface">
+<link rel="next" href="svg_1d_plot_interface.html" title=" svg_1d_plot
+ Public Interface">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
@@ -24,123 +25,279 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.svg_interface"></a> SVG Public Interface</h2></div></div></div>
-<div class="informaltable">
-<h4>
-<a name="id338555"></a>
- class svg
- </h4>
-<table class="table">
+<a name="svg_plot.svg_interface"></a> SVG Public Interface
+</h2></div></div></div>
+<div class="table">
+<a name="id339873"></a>Table 3. class svg
+<table class="table" summary="class svg">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
-<th>Signature</th>
-<th>Description</th>
-<th>Notes</th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Notes
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg()</code></td>
-<td>Constructor</td>
-<td>The
- default image size is (400, 400)</td>
-</tr>
-<tr>
-<td><code class="computeroutput">g_element& add_g_element()</code></td>
-<td>Adds
- a g_element at the root of the document tree. Acts as a <code class="computeroutput">push_back()</code>
-</td>
-<td>Returns
- the <code class="computeroutput">g_element</code> that is
- pushed back. This allows you to do something like the following: <code class="computeroutput">image.add_g_element().line(/**/).line(/**/).rect(/**/); </code>
- Which adds two lines and a rectangle to the g_element that was just created.</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg& circle(double x, double y, unsigned int radius = 5)</code></td>
-<td>Adds
- a point at (x,y) in the root level of the document</td>
-<td>If the
- user is calling the circle method, odds are they would prefer a real
- circle instead of a degenerate circle (a point). 5 is as good a default
- as any other, and the user does not likely want a point if they are making
- this call.</td>
-</tr>
-<tr>
-<td><code class="computeroutput">g_element& get_g_element(int)</code></td>
-<td>Gets
- the g_element at the index specified</td>
-<td>Gives a runtime error
- if you specify an index that does not contain a <code class="computeroutput">g_element</code>.
- I am considering providing an iterator interface to access these elements.</td>
-</tr>
-<tr>
-<td><code class="computeroutput">unsigned int get_x_size()</code></td>
-<td>Returns
- the width of the image</td>
-<td> </td>
-</tr>
-<tr>
-<td><code class="computeroutput">unsigned int get_y_size()</code></td>
-<td>Returns
- the height of the image</td>
-<td> </td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg& image_size(unsigned int, unsigned int)</code></td>
-<td>Sets
- the size of the image produced, in pixels</td>
-<td> </td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg& line(double x1, double y1, double x2, double y2)</code></td>
-<td>Adds
- a line from (x1,y1) to (x2,y2) in the root level of the document</td>
-<td> </td>
-</tr>
-<tr>
-<td><code class="computeroutput">path_element& path()</code></td>
-<td>Pushes
- a <code class="computeroutput">path_element</code> to the
- back of the tree and returns a reference to it. This allows you to do
- the following:
-<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">
-path_element& my_path = image.path();
+<td>
+ 
+ <code class="computeroutput">svg()</code>
+ 
+ </td>
+<td>
+ 
+ Constructor
+ 
+ </td>
+<td>
+ 
+ The default image size is (400, 400)
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">g_element&
+ add_g_element()</code>
+ 
+ </td>
+<td>
+ 
+ Adds a g_element at the root of the document tree. Acts as a <code class="computeroutput">push_back()</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">g_element</code>
+ that is pushed back. This allows you to do something like the following:
+ <code class="computeroutput">image.add_g_element().line(/**/).line(/**/).rect(/**/);
+ </code> Which adds two lines and a rectangle to the g_element that was
+ just created.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg&
+ circle(double x, double y, unsigned int
+ radius =
+ 5)</code>
+ 
+ </td>
+<td>
+ 
+ Adds a point at (x,y) in the root level of the document
+ 
+ </td>
+<td>
+ 
+ If the user is calling the circle method, odds are they would prefer
+ a real circle instead of a degenerate circle (a point). 5 is as good
+ a default as any other, and the user does not likely want a point if
+ they are making this call.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">g_element&
+ get_g_element(int)</code>
+ 
+ </td>
+<td>
+ 
+ Gets the g_element at the index specified
+ 
+ </td>
+<td>
+ 
+ Gives a runtime error if you specify an index that does not contain a
+ <code class="computeroutput">g_element</code>. I am considering
+ providing an iterator interface to access these elements.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">unsigned int
+ get_x_size()</code>
+ 
+ </td>
+<td>
+ 
+ Returns the width of the image
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">unsigned int
+ get_y_size()</code>
+ 
+ </td>
+<td>
+ 
+ Returns the height of the image
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg&
+ image_size(unsigned int, unsigned int)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the size of the image produced, in pixels
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg&
+ line(double x1, double y1, double x2, double y2)</code>
+ 
+ </td>
+<td>
+ 
+ Adds a line from (x1,y1) to (x2,y2) in the root level of the document
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">path_element&
+ path()</code>
+ 
+ </td>
+<td>
+ 
+ Pushes a <code class="computeroutput">path_element</code>
+ to the back of the tree and returns a reference to it. This allows you
+ to do the following:
+
+<pre class="programlisting">
+path_element& my_path = image.path();

-my_path.M(3, 3).l(150, 150);
+my_path.M(3, 3).l(150, 150);
</pre>
- I'm open to suggestions for how to improve this process. </td>
+
+ I'm open to suggestions for how to improve this process.
+ 
+ </td>
<td class="auto-generated"> </td>
</tr>
<tr>
-<td><code class="computeroutput">svg& rect(double x1, double y1, double width, double height)</code></td>
-<td>Adds
- a rectangle at point (x1, y1) that has width <code class="computeroutput">width</code>
+<td>
+ 
+ <code class="computeroutput">svg&
+ rect(double x1, double y1, double width, double height)</code>
+ 
+ </td>
+<td>
+ 
+ Adds a rectangle at point (x1, y1) that has width <code class="computeroutput">width</code>
and height <code class="computeroutput">height</code>
-</td>
-<td> </td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg& text(double x, double y, std::string text)</code></td>
-<td>Adds text <code class="computeroutput">text</code> at (x,y) in the root level of
- the document</td>
-<td> </td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg& write(const std::string&)</code></td>
-<td>Writes the document
- to the file represented by the argument</td>
-<td>Opens the file
- stream itself and tries to call <code class="computeroutput">write(std::ostream&)</code>. Throws <code class="computeroutput">std::runtime_exception</code>
- if it can not open the file.</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg& write(std::ostream&)</code></td>
-<td>Writes
- the document to the stream represented by the argument</td>
-<td> </td>
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg&
+ text(double x, double y, std::string text)</code>
+ 
+ </td>
+<td>
+ 
+ Adds text <code class="computeroutput">text</code> at (x,y)
+ in the root level of the document
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg&
+ write(const std::string&)</code>
+ 
+ </td>
+<td>
+ 
+ Writes the document to the file represented by the argument
+ 
+ </td>
+<td>
+ 
+ Opens the file stream itself and tries to call <code class="computeroutput">write(std::ostream&)</code>. Throws <code class="computeroutput">std::runtime_exception</code>
+ if it can not open the file.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg&
+ write(std::ostream&)</code>
+ 
+ </td>
+<td>
+ 
+ Writes the document to the stream represented by the argument
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
</tr>
</tbody>
</table>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/todo.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/todo.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/todo.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -24,7 +24,8 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.todo"></a> To Do List</h2></div></div></div>
+<a name="svg_plot.todo"></a> To Do List
+</h2></div></div></div>

 This project is still in development, so here is a list of things that I would
 still like to do by the end of the project. I recommend you check here first
@@ -86,6 +87,10 @@
 </li>
<li>Histogram</li>
<li>Box-and-whisker</li>
+<li>
+Modify line methods to deal with numerical
+ limits (such as -NaN)
+ </li>
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -1,7 +1,8 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Tutorial: Simple 2D Program</title>
+<title> Tutorial: Simple 2D
+ Program</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
<link rel="start" href="../index.html" title="SVG_Plot">
@@ -24,15 +25,24 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.tutorial_2d_code_simple"></a> Tutorial: Simple 2D Program</h2></div></div></div>
+<a name="svg_plot.tutorial_2d_code_simple"></a><a href="tutorial_2d_code_simple.html" title=" Tutorial: Simple 2D
+ Program"> Tutorial: Simple 2D
+ Program</a>
+</h2></div></div></div>
<div class="toc"><dl>
-<dt> Simple Code Example</dt>
-<dt> Simple Image</dt>
-<dt> Basic Example Breakdown</dt>
+<dt><a href="tutorial_2d_code_simple.html#svg_plot.tutorial_2d_code_simple.2d_simple_code_example">
+ Simple Code Example</a></dt>
+<dt><a href="tutorial_2d_code_simple.html#svg_plot.tutorial_2d_code_simple.2d_simple_image"> Simple
+ Image</a></dt>
+<dt><a href="tutorial_2d_code_simple.html#svg_plot.tutorial_2d_code_simple.tutorial_simple_exam">
+ Basic Example Breakdown</a></dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.tutorial_2d_code_simple.2d_simple_code_example"></a> Simple Code Example</h3></div></div></div>
+<a name="svg_plot.tutorial_2d_code_simple.2d_simple_code_example"></a><a href="tutorial_2d_code_simple.html#svg_plot.tutorial_2d_code_simple.2d_simple_code_example" title="
+ Simple Code Example">
+ Simple Code Example</a>
+</h3></div></div></div>
<pre class="programlisting">
#include <boost/svg_plot/svg_2d_plot.hpp>
#include <vector>
@@ -70,14 +80,20 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.tutorial_2d_code_simple.2d_simple_image"></a> Simple Image</h3></div></div></div>
+<a name="svg_plot.tutorial_2d_code_simple.2d_simple_image"></a><a href="tutorial_2d_code_simple.html#svg_plot.tutorial_2d_code_simple.2d_simple_image" title=" Simple
+ Image"> Simple
+ Image</a>
+</h3></div></div></div>

 <img src="../images/2d_simple.png" alt="2d_simple">
 
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.tutorial_2d_code_simple.tutorial_simple_exam"></a> Basic Example Breakdown</h3></div></div></div>
+<a name="svg_plot.tutorial_2d_code_simple.tutorial_simple_exam"></a><a href="tutorial_2d_code_simple.html#svg_plot.tutorial_2d_code_simple.tutorial_simple_exam" title="
+ Basic Example Breakdown">
+ Basic Example Breakdown</a>
+</h3></div></div></div>

 Let's examine what this does.
 
@@ -107,9 +123,8 @@
 that the legend will show up.
 </li>
<li>
-<code class="computeroutput">x_range(-1, 11)</code> means
- that the axis displayed will be between -1 and 11, as you can see in the
- above images.
+<code class="computeroutput">x_range(-1, 11)</code> means that the axis displayed will be
+ between -1 and 11, as you can see in the above images.
 </li>
<li>
<code class="computeroutput">background_border_color(black)</code> sets the border around the image to <code class="computeroutput">black</code>. Ordinarily it is left to be the

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple.html 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -1,7 +1,8 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title> Tutorial: 1D Simple Program</title>
+<title> Tutorial: 1D Simple
+ Program</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
<link rel="start" href="../index.html" title="SVG_Plot">
@@ -24,16 +25,25 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="svg_plot.tutorial_code_1d_simple"></a> Tutorial: 1D Simple Program</h2></div></div></div>
+<a name="svg_plot.tutorial_code_1d_simple"></a><a href="tutorial_code_1d_simple.html" title=" Tutorial: 1D Simple
+ Program"> Tutorial: 1D Simple
+ Program</a>
+</h2></div></div></div>
<div class="toc"><dl>
-<dt> Code Example</dt>
+<dt><a href="tutorial_code_1d_simple.html#svg_plot.tutorial_code_1d_simple.tutorial_code_1d_example">
+ Code Example</a></dt>
<dt> Image</dt>
-<dt> A note on syntax</dt>
-<dt> Basic Example Breakdown</dt>
+<dt><a href="tutorial_code_1d_simple.html#svg_plot.tutorial_code_1d_simple.tutorial_syntax_explanation">
+ A note on syntax</a></dt>
+<dt><a href="tutorial_code_1d_simple.html#svg_plot.tutorial_code_1d_simple.tutorial_simple_exam">
+ Basic Example Breakdown</a></dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.tutorial_code_1d_simple.tutorial_code_1d_example"></a> Code Example</h3></div></div></div>
+<a name="svg_plot.tutorial_code_1d_simple.tutorial_code_1d_example"></a><a href="tutorial_code_1d_simple.html#svg_plot.tutorial_code_1d_simple.tutorial_code_1d_example" title="
+ Code Example">
+ Code Example</a>
+</h3></div></div></div>
<pre class="programlisting">
#include <boost/svg_plot/svg_1d_plot.hpp>
#include <vector>
@@ -67,14 +77,18 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.tutorial_code_1d_simple.1d_simple_image"></a> Image</h3></div></div></div>
+<a name="svg_plot.tutorial_code_1d_simple.1d_simple_image"></a> Image
+</h3></div></div></div>

 <img src="../images/1d_simple.png" alt="1d_simple">
 
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.tutorial_code_1d_simple.tutorial_syntax_explanation"></a> A note on syntax</h3></div></div></div>
+<a name="svg_plot.tutorial_code_1d_simple.tutorial_syntax_explanation"></a><a href="tutorial_code_1d_simple.html#svg_plot.tutorial_code_1d_simple.tutorial_syntax_explanation" title="
+ A note on syntax">
+ A note on syntax</a>
+</h3></div></div></div>

 The syntax "<code class="computeroutput">my_plot.title("Hello").legend_on(true)...</code>"
 may appear unfamiliar. However, it works on the same principle that the assignment
@@ -102,7 +116,10 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.tutorial_code_1d_simple.tutorial_simple_exam"></a> Basic Example Breakdown</h3></div></div></div>
+<a name="svg_plot.tutorial_code_1d_simple.tutorial_simple_exam"></a><a href="tutorial_code_1d_simple.html#svg_plot.tutorial_code_1d_simple.tutorial_simple_exam" title="
+ Basic Example Breakdown">
+ Basic Example Breakdown</a>
+</h3></div></div></div>

 Let's examine what this does.
 
@@ -131,9 +148,8 @@
 that the legend will show up.
 </li>
<li>
-<code class="computeroutput">x_range(-1, 11)</code> means
- that the axis displayed will be between -1 and 11, as you can see in the
- above image.
+<code class="computeroutput">x_range(-1, 11)</code> means that the axis displayed will be
+ between -1 and 11, as you can see in the above image.
 </li>
</ul></div>
<pre class="programlisting">

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.qbk (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.qbk 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -105,6 +105,7 @@
* *Clipping* of the plot window, so that graph lines do not get drawn outside of the plot.
* *Histogram*
* *Box-and-whisker*
+* *Modify line methods* to deal with numerical limits (such as -NaN)

[endsect] [/section:todo To Do]

@@ -652,6 +653,53 @@
[endsect] [/curve_interpolation]
[endsect] [/2d_special Tutorial: 2D Special Features]

+[section:behavior Behavior]
+[section:behavior_limits Numerical Limits]
+All limits that are dealt with are double precision floating point limits.
+Limits are noticed upon the call to the `plot()` method. Currently, the line
+interpolation algorithms do not take limits into account, so behavior may
+be incorrect for such plots as `1 / x`. Limits are drawn as a circle with
+`_stroke_color = lightgray` and `_fill_color = whitesmoke`.
+This will become customizable.
+
+[section:behavior_NaN NaN]
+Any double precision floating point numbers that return a nonzero value for the
+function `_isnan(double)` is considered to be a NaN value. When plotted, the
+number will appear in the user-defined coordinates as 0.
+[endsect][/section:behavior_NaN NaN]
+
+[section:behavior_infinity Infinity]
+
+Any double precision floating point number that is equal to either of the
+following is considered to be Infinity:
+
+ std::numeric_limits<double>::max()
+ std::numeric_limits<double>::infinity()
+
+When plotted, these values will appear at the top of your plot window. If
+the plot window is not turned on, these points will appear at the top of
+the graph.
+[endsect][/section:behavior_infinity]
+[section:behavior_neg_infinity Negative Infinity]
+
+Any double precision floating point number that is equal to either of the
+following is considered to be Negative Infinity:
+
+ std::numeric_limits<double>::min()
+ -std::numeric_limits<double>::infinity()
+ std::numeric_limits<double>::denorm_min()
+
+When plotted, these values will appear at the bottom of your plot window. If
+the plot window is not turned on, these points will appear at the bottom of
+the graph.
+[endsect][/section:behavior_infinity]
+
+Here is an example of numeric limit handling in action:
+
+[$images/2d_limit.png]
+[endsect][/section:behavior_limits Numerical Limits]
+[endsect][/section:behavior Behavior]
+
[section:plot_defaults Defaults]

[section:1d_defaults `svg_1d_plot` Defaults]
@@ -905,7 +953,7 @@
 [[`svg_2d_plot& y_minor_grid_on(bool)`] [Determines whether or not the minor grid on the Y axis will be displayed]]]
[endsect][/section:2d_inter_commands]

-[section:2d_inter_color]
+[section:2d_inter_color Color]
[table
 [[Signature] [Description]]
 [[`svg_2d_plot& title_color(const svg_color &col)`] [Set the title color]]

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.xml
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.xml (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.xml 2007-08-08 16:06:37 EDT (Wed, 08 Aug 2007)
@@ -1,11 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
-<article id="svg_plot" name="SVG_Plot" dirname="svg_plot" last-revision="$Date: 2007/07/31 01:11:42 $"
+<article id="svg_plot" name="SVG_Plot" dirname="svg_plot" last-revision="$Date: 2007/08/08 20:04:42 $"
 xmlns:xi="http://www.w3.org/2001/XInclude">
 <articleinfo>
+ <authorgroup>
 <author>
 <firstname>Jake</firstname> <surname>Voytko</surname>
 </author>
+ </authorgroup>
 <copyright>
 <year>2007</year> <holder>Jake Voytko</holder>
 </copyright>
@@ -21,7 +23,7 @@
 </articleinfo>
 <title>SVG_Plot</title>
 <section id="svg_plot.howtouse">
- <title> How To Use This Documentation</title>
+ <title><link linkend="svg_plot.howtouse"> How To Use This Documentation</link></title>
 <itemizedlist>
 <listitem>
 Tutorial pages are intended for those who do not know how to use the program.
@@ -54,28 +56,37 @@
 </listitem>
 </itemizedlist>
 <section id="svg_plot.howtouse.admonishments">
- <title> Admonishments</title>
+ <title><link linkend="svg_plot.howtouse.admonishments"> Admonishments</link></title>
 <note>
 <para>
- These blocks typically go into more detail about an explanation given above.
+ <para>
+ These blocks typically go into more detail about an explanation given
+ above.
+ </para>
 </para>
 </note>
 <tip>
 <para>
- These blocks contain information that you may find helpful while coding.
+ <para>
+ These blocks contain information that you may find helpful while coding.
+ </para>
 </para>
 </tip>
 <important>
 <para>
- These contain information that is imperative to understanding a concept.
- Failure to follow these blocks will likely result in undesired behavior.
- Read all of these you find.
+ <para>
+ These contain information that is imperative to understanding a concept.
+ Failure to follow these blocks will likely result in undesired behavior.
+ Read all of these you find.
+ </para>
 </para>
 </important>
 <warning>
 <para>
- It is imperative that you follow these. Failure to do so will lead to incorrect,
- and likely undesired, results in the plot
+ <para>
+ It is imperative that you follow these. Failure to do so will lead to
+ incorrect, and likely undesired, results in the plot
+ </para>
 </para>
 </warning>
 <para>
@@ -83,13 +94,15 @@
 </para>
 <important>
 <para>
- This is not currently a Boost library. It is a GSoC project whose mentor
- organization is Boost.
+ <para>
+ This is not currently a Boost library. It is a GSoC project whose mentor
+ organization is Boost.
+ </para>
 </para>
 </important>
 </section>
 <section id="svg_plot.howtouse.preface">
- <title> Preface</title>
+ <title><link linkend="svg_plot.howtouse.preface"> Preface</link></title>
 <para>
 The first task when dealing with numerical data is to plot it. Humans have
 a fantastic capacity for visual understanding, and merely looking at data
@@ -125,15 +138,17 @@
 </itemizedlist>
 <note>
 <para>
- I have only a student's grasp of C++, so if you have a suggestion to help
- me with design or implementation, email me at jakevoytko (at) gmail (dot)
- com
+ <para>
+ I have only a student's grasp of C++, so if you have a suggestion to
+ help me with design or implementation, email me at jakevoytko (at) gmail
+ (dot) com
+ </para>
 </para>
 </note>
 </section>
 </section>
 <section id="svg_plot.todo">
- <title> To Do List</title>
+ <title><link linkend="svg_plot.todo"> To Do List</link></title>
 <para>
 This project is still in development, so here is a list of things that I would
 still like to do by the end of the project. I recommend you check here first
@@ -201,18 +216,22 @@
 <listitem>
 <emphasis role="bold">Box-and-whisker</emphasis>
 </listitem>
+ <listitem>
+ <emphasis role="bold">Modify line methods</emphasis> to deal with numerical
+ limits (such as -NaN)
+ </listitem>
 </itemizedlist>
 </section>
 <section id="svg_plot.color">
- <title> Colors</title>
+ <title><link linkend="svg_plot.color"> Colors</link></title>
 <para>
 The project supports any RGB color, as well as a number of constants that are
 <ulink url="http://www.w3.org/TR/SVG/types.html#ColorKeywords">named by the
 SVG standard</ulink>.
 </para>
 <section id="svg_plot.color.color_interface">
- <title> <code><phrase role="identifier">svg_color_constant</phrase></code>
- Interface</title>
+ <title><link linkend="svg_plot.color.color_interface"> <code><phrase role="identifier">svg_color_constant</phrase></code>
+ Interface</link></title>
 <para>
 <code><phrase role="identifier">svg_color_constant</phrase></code> is simply
 an enumerated list. The colors are defined <ulink url="http://www.w3.org/TR/SVG/types.html#ColorKeywords">here</ulink>.
@@ -223,7 +242,8 @@
 </para>
 </section>
 <section id="svg_plot.color.svg_color_constant_example">
- <title> Example of using <code><phrase role="identifier">svg_color_constant</phrase></code></title>
+ <title><link linkend="svg_plot.color.svg_color_constant_example"> Example of
+ using <code><phrase role="identifier">svg_color_constant</phrase></code></link></title>

<programlisting>
<phrase role="keyword">using</phrase> <phrase role="keyword">namespace</phrase> <phrase role="identifier">boost</phrase><phrase role="special">::</phrase><phrase role="identifier">svg</phrase><phrase role="special">;</phrase>
@@ -237,24 +257,27 @@
</programlisting>
 <note>
 <para>
- <code><phrase role="identifier">svg_color</phrase></code> has a constructor
- for <code><phrase role="identifier">svg_color_constant</phrase></code>,
- so you can use a <code><phrase role="identifier">svg_color_constant</phrase></code>
- in place of a <code><phrase role="identifier">svg_color</phrase></code>
- and it will be implicitly converted. However, there is not currently an
- <code><phrase role="identifier">svg_color</phrase><phrase role="special">::</phrase><phrase
- role="keyword">operator</phrase><phrase role="special">=(</phrase><phrase
- role="identifier">svg_color_constant</phrase><phrase role="special">)</phrase></code>
- overload, so
+ <para>
+ <code><phrase role="identifier">svg_color</phrase></code> has a constructor
+ for <code><phrase role="identifier">svg_color_constant</phrase></code>,
+ so you can use a <code><phrase role="identifier">svg_color_constant</phrase></code>
+ in place of a <code><phrase role="identifier">svg_color</phrase></code>
+ and it will be implicitly converted. However, there is not currently
+ an <code><phrase role="identifier">svg_color</phrase><phrase role="special">::</phrase><phrase
+ role="keyword">operator</phrase><phrase role="special">=(</phrase><phrase
+ role="identifier">svg_color_constant</phrase><phrase role="special">)</phrase></code>
+ overload, so
<programlisting>
-<phrase role="identifier">svg_color</phrase> <phrase role="identifier">my_color</phrase> <phrase role="special">=</phrase> <phrase role="identifier">red</phrase><phrase role="special">;</phrase>
+<phrase role="identifier">svg_color</phrase> <phrase role="identifier">my_color</phrase> <phrase role="special">=</phrase> <phrase role="identifier">red</phrase><phrase role="special">;</phrase>
</programlisting>
- does not work.
+ does not work.
+ </para>
 </para>
 </note>
 </section>
 <section id="svg_plot.color.rgb_interface">
- <title> <code><phrase role="identifier">svg_color</phrase></code> interface</title>
+ <title><link linkend="svg_plot.color.rgb_interface"> <code><phrase role="identifier">svg_color</phrase></code>
+ interface</link></title>
 <para>
 You can define a <code><phrase role="identifier">svg_color</phrase></code>
 using two different constructors
@@ -269,14 +292,16 @@
</programlisting>
 <important>
 <para>
- Any integer value is accepted by the SVG standard, but negative values
- are rounded to 0, and positive values > 255 are rounded down to 255.
+ <para>
+ Any integer value is accepted by the SVG standard, but negative values
+ are rounded to 0, and positive values > 255 are rounded down to 255.
+ </para>
 </para>
 </important>
 </section>
 <section id="svg_plot.color.svg_color_example">
- <title> Example of using <code><phrase role="identifier">svg_color</phrase></code></title>
-
+ <title><link linkend="svg_plot.color.svg_color_example"> Example of using
+ <code><phrase role="identifier">svg_color</phrase></code></link></title>
<programlisting>
<phrase role="keyword">using</phrase> <phrase role="keyword">namespace</phrase> <phrase role="identifier">boost</phrase><phrase role="special">::</phrase><phrase role="identifier">svg</phrase><phrase role="special">;</phrase>

@@ -287,15 +312,17 @@
</programlisting>
 <note>
 <para>
- <code><phrase role="identifier">svg_color</phrase></code>'s constructor
- takes in three integer values. The SVG 1.1 standard allows any integer
- to represent an RGB value, with values less than 0 and greater than 255
- being rounded to their respective min and max.
+ <para>
+ <code><phrase role="identifier">svg_color</phrase></code>'s constructor
+ takes in three integer values. The SVG 1.1 standard allows any integer
+ to represent an RGB value, with values less than 0 and greater than 255
+ being rounded to their respective min and max.
+ </para>
 </para>
 </note>
 </section>
 <section id="svg_plot.color.color_internals">
- <title> Internals and Rationale</title>
+ <title><link linkend="svg_plot.color.color_internals"> Internals and Rationale</link></title>
 <para>
 Constants are defined in an enum, <code><phrase role="identifier">svg_color_constant</phrase></code>,
 in alphabetical order. This facilitates quick lookup of their RGB values
@@ -313,9 +340,11 @@
 </section>
 </section>
 <section id="svg_plot.tutorial_code_1d_simple">
- <title> Tutorial: 1D Simple Program</title>
+ <title><link linkend="svg_plot.tutorial_code_1d_simple"> Tutorial: 1D Simple
+ Program</link></title>
 <section id="svg_plot.tutorial_code_1d_simple.tutorial_code_1d_example">
- <title> Code Example</title>
+ <title><link linkend="svg_plot.tutorial_code_1d_simple.tutorial_code_1d_example">
+ Code Example</link></title>
<programlisting>
<phrase role="preprocessor">#include</phrase> <phrase role="special"><</phrase><phrase role="identifier">boost</phrase><phrase role="special">/</phrase><phrase role="identifier">svg_plot</phrase><phrase role="special">/</phrase><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">.</phrase><phrase role="identifier">hpp</phrase><phrase role="special">></phrase>
<phrase role="preprocessor">#include</phrase> <phrase role="special"><</phrase><phrase role="identifier">vector</phrase><phrase role="special">></phrase>
@@ -348,7 +377,7 @@
</programlisting>
 </section>
 <section id="svg_plot.tutorial_code_1d_simple.1d_simple_image">
- <title> Image</title>
+ <title><link linkend="svg_plot.tutorial_code_1d_simple.1d_simple_image"> Image</link></title>
 <para>
 <inlinemediaobject><imageobject><imagedata fileref="images/1d_simple.png"></imagedata></imageobject>
 <textobject>
@@ -358,7 +387,8 @@
 </para>
 </section>
 <section id="svg_plot.tutorial_code_1d_simple.tutorial_syntax_explanation">
- <title> A note on syntax</title>
+ <title><link linkend="svg_plot.tutorial_code_1d_simple.tutorial_syntax_explanation">
+ A note on syntax</link></title>
 <para>
 The syntax "<code><phrase role="identifier">my_plot</phrase><phrase
 role="special">.</phrase><phrase role="identifier">title</phrase><phrase
@@ -391,7 +421,8 @@
 </para>
 </section>
 <section id="svg_plot.tutorial_code_1d_simple.tutorial_simple_exam">
- <title> Basic Example Breakdown</title>
+ <title><link linkend="svg_plot.tutorial_code_1d_simple.tutorial_simple_exam">
+ Basic Example Breakdown</link></title>
 <para>
 Let's examine what this does.
 </para>
@@ -424,10 +455,9 @@
 </listitem>
 <listitem>
 <code><phrase role="identifier">x_range</phrase><phrase role="special">(-</phrase><phrase
- role="number">1</phrase><phrase role="special">,</phrase> <phrase
- role="number">11</phrase><phrase role="special">)</phrase></code> means
- that the axis displayed will be between -1 and 11, as you can see in the
- above image.
+ role="number">1</phrase><phrase role="special">,</phrase> <phrase role="number">11</phrase><phrase
+ role="special">)</phrase></code> means that the axis displayed will be
+ between -1 and 11, as you can see in the above image.
 </listitem>
 </itemizedlist>

@@ -454,7 +484,8 @@
 </section>
 </section>
 <section id="svg_plot.full_1d_layout">
- <title> Tutorial: 1D Full Layout Example</title>
+ <title><link linkend="svg_plot.full_1d_layout"> Tutorial: 1D Full Layout Example</link></title>
+
<programlisting>
<phrase role="preprocessor">#include</phrase> <phrase role="special"><</phrase><phrase role="identifier">boost</phrase><phrase role="special">/</phrase><phrase role="identifier">svg_plot</phrase><phrase role="special">/</phrase><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">.</phrase><phrase role="identifier">hpp</phrase><phrase role="special">></phrase>
<phrase role="preprocessor">#include</phrase> <phrase role="special"><</phrase><phrase role="identifier">vector</phrase><phrase role="special">></phrase>
@@ -554,9 +585,9 @@
 </para>
 </section>
 <section id="svg_plot.1d_special">
- <title> Tutorial: 1D Special Features</title>
+ <title><link linkend="svg_plot.1d_special"> Tutorial: 1D Special Features</link></title>
 <section id="svg_plot.1d_special.x_axis_grid">
- <title> X Axis Grid Lines</title>
+ <title><link linkend="svg_plot.1d_special.x_axis_grid"> X Axis Grid Lines</link></title>
 <para>
 If you would like grid lines that go across the graph, you can make the following
 call to <code><phrase role="identifier">svg_1d_plot</phrase></code>:
@@ -586,7 +617,8 @@
 </para>
 </section>
 <section id="svg_plot.1d_special.x_axis_external_style">
- <title> X Axis External Style</title>
+ <title><link linkend="svg_plot.1d_special.x_axis_external_style"> X Axis External
+ Style</link></title>
 <para>
 For an alternate way to display a regular axis, you can use an external style:
 </para>
@@ -607,19 +639,24 @@
 </para>
 <important>
 <para>
- If the axis is turned off, <code><phrase role="identifier">x_external_style_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">true</phrase><phrase role="special">)</phrase></code>
- will not turn the axis back on. To do that, you must call <code><phrase
- role="identifier">axis_on</phrase><phrase role="special">(</phrase><phrase
- role="keyword">true</phrase><phrase role="special">)</phrase></code>
+ <para>
+ If the axis is turned off, <code><phrase role="identifier">x_external_style_on</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">true</phrase><phrase
+ role="special">)</phrase></code> will not turn the axis back on. To do
+ that, you must call <code><phrase role="identifier">axis_on</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">true</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
 </para>
 </important>
 </section>
 </section>
 <section id="svg_plot.tutorial_2d_code_simple">
- <title> Tutorial: Simple 2D Program</title>
+ <title><link linkend="svg_plot.tutorial_2d_code_simple"> Tutorial: Simple 2D
+ Program</link></title>
 <section id="svg_plot.tutorial_2d_code_simple.2d_simple_code_example">
- <title> Simple Code Example</title>
+ <title><link linkend="svg_plot.tutorial_2d_code_simple.2d_simple_code_example">
+ Simple Code Example</link></title>
<programlisting>
<phrase role="preprocessor">#include</phrase> <phrase role="special"><</phrase><phrase role="identifier">boost</phrase><phrase role="special">/</phrase><phrase role="identifier">svg_plot</phrase><phrase role="special">/</phrase><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">.</phrase><phrase role="identifier">hpp</phrase><phrase role="special">></phrase>
<phrase role="preprocessor">#include</phrase> <phrase role="special"><</phrase><phrase role="identifier">vector</phrase><phrase role="special">></phrase>
@@ -656,7 +693,8 @@
</programlisting>
 </section>
 <section id="svg_plot.tutorial_2d_code_simple.2d_simple_image">
- <title> Simple Image</title>
+ <title><link linkend="svg_plot.tutorial_2d_code_simple.2d_simple_image"> Simple
+ Image</link></title>
 <para>
 <inlinemediaobject><imageobject><imagedata fileref="images/2d_simple.png"></imagedata></imageobject>
 <textobject>
@@ -666,7 +704,8 @@
 </para>
 </section>
 <section id="svg_plot.tutorial_2d_code_simple.tutorial_simple_exam">
- <title> Basic Example Breakdown</title>
+ <title><link linkend="svg_plot.tutorial_2d_code_simple.tutorial_simple_exam">
+ Basic Example Breakdown</link></title>
 <para>
 Let's examine what this does.
 </para>
@@ -700,10 +739,9 @@
 </listitem>
 <listitem>
 <code><phrase role="identifier">x_range</phrase><phrase role="special">(-</phrase><phrase
- role="number">1</phrase><phrase role="special">,</phrase> <phrase
- role="number">11</phrase><phrase role="special">)</phrase></code> means
- that the axis displayed will be between -1 and 11, as you can see in the
- above images.
+ role="number">1</phrase><phrase role="special">,</phrase> <phrase role="number">11</phrase><phrase
+ role="special">)</phrase></code> means that the axis displayed will be
+ between -1 and 11, as you can see in the above images.
 </listitem>
 <listitem>
 <code><phrase role="identifier">background_border_color</phrase><phrase
@@ -739,7 +777,8 @@
 </section>
 </section>
 <section id="svg_plot.full_2d_layout">
- <title> Tutorial: Full Layout Example</title>
+ <title><link linkend="svg_plot.full_2d_layout"> Tutorial: Full Layout Example</link></title>
+
<programlisting>
<phrase role="preprocessor">#include</phrase> <phrase role="special"><</phrase><phrase role="identifier">boost</phrase><phrase role="special">/</phrase><phrase role="identifier">svg_plot</phrase><phrase role="special">/</phrase><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">.</phrase><phrase role="identifier">hpp</phrase><phrase role="special">></phrase>
<phrase role="preprocessor">#include</phrase> <phrase role="special"><</phrase><phrase role="identifier">map</phrase><phrase role="special">></phrase>
@@ -844,9 +883,9 @@
 </para>
 </section>
 <section id="svg_plot.2d_special">
- <title> Tutorial: 2D Special Features</title>
+ <title><link linkend="svg_plot.2d_special"> Tutorial: 2D Special Features</link></title>
 <section id="svg_plot.2d_special.y_grid_lines">
- <title> Y Axis Grid Lines</title>
+ <title><link linkend="svg_plot.2d_special.y_grid_lines"> Y Axis Grid Lines</link></title>
 <para>
 If you would like grid lines that go across the graph, you can make the following
 call to <code><phrase role="identifier">svg_1d_plot</phrase></code>:
@@ -876,7 +915,8 @@
 </para>
 </section>
 <section id="svg_plot.2d_special.external_y_axis">
- <title> External Y Axis Style</title>
+ <title><link linkend="svg_plot.2d_special.external_y_axis"> External Y Axis
+ Style</link></title>
 <para>
 For an alternate way to display a regular axis, you can use an external style:
 </para>
@@ -886,16 +926,20 @@
</programlisting>
 <important>
 <para>
- If the axis is turned off, <code><phrase role="identifier">y_external_style_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">true</phrase><phrase role="special">)</phrase></code>
- will not turn the axis back on. To do that, you must call <code><phrase
- role="identifier">axis_on</phrase><phrase role="special">(</phrase><phrase
- role="keyword">true</phrase><phrase role="special">)</phrase></code>
+ <para>
+ If the axis is turned off, <code><phrase role="identifier">y_external_style_on</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">true</phrase><phrase
+ role="special">)</phrase></code> will not turn the axis back on. To do
+ that, you must call <code><phrase role="identifier">axis_on</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">true</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
 </para>
 </important>
 </section>
 <section id="svg_plot.2d_special.fill_axis_plot">
- <title> Fill the area between the plot and the axis</title>
+ <title><link linkend="svg_plot.2d_special.fill_axis_plot"> Fill the area between
+ the plot and the axis</link></title>
 <para>
 When there is a call to the plot() method, define <code><phrase role="identifier">_area_fill_color</phrase></code>
 </para>
@@ -918,7 +962,7 @@
 </para>
 </section>
 <section id="svg_plot.2d_special.curve_interpolation">
- <title> Curve Interpolation</title>
+ <title><link linkend="svg_plot.2d_special.curve_interpolation"> Curve Interpolation</link></title>
 <para>
 If you would like an interpolated curve shown over your data, simply use
 the following command:
@@ -939,926 +983,2148 @@
 </para>
 <warning>
 <para>
- The <code><phrase role="identifier">_bezier_curve</phrase></code> feature
- is still very much in its infancy. If you play nice with it, it will play
- nice with you, but it still displays undesired behavior in extreme circumstances.
- Do not use this feature with curves that have a limit (<code><phrase role="special">-</phrase><phrase
- role="identifier">NaN</phrase></code>, for example), or with data that
- has high irregularity in X-Axis spacing (a clump of points between (0,
- 1) on the X axis, with the next one at 100 on the X axis, for example)
+ <para>
+ The <code><phrase role="identifier">_bezier_curve</phrase></code> feature
+ is still very much in its infancy. If you play nice with it, it will
+ play nice with you, but it still displays undesired behavior in extreme
+ circumstances. Do not use this feature with curves that have a limit
+ (<code><phrase role="special">-</phrase><phrase role="identifier">NaN</phrase></code>,
+ for example), or with data that has high irregularity in X-Axis spacing
+ (a clump of points between (0, 1) on the X axis, with the next one at
+ 100 on the X axis, for example)
+ </para>
 </para>
 </warning>
 </section>
 </section>
+ <section id="svg_plot.behavior">
+ <title><link linkend="svg_plot.behavior"> Behavior</link></title>
+ <section id="svg_plot.behavior.behavior_limits">
+ <title><link linkend="svg_plot.behavior.behavior_limits"> Numerical Limits</link></title>
+ <para>
+ All limits that are dealt with are double precision floating point limits.
+ Limits are noticed upon the call to the <code><phrase role="identifier">plot</phrase><phrase
+ role="special">()</phrase></code> method. Currently, the line interpolation
+ algorithms do not take limits into account, so behavior may be incorrect
+ for such plots as <code><phrase role="number">1</phrase> <phrase role="special">/</phrase>
+ <phrase role="identifier">x</phrase></code>. Limits are drawn as a circle
+ with <code><phrase role="identifier">_stroke_color</phrase> <phrase role="special">=</phrase>
+ <phrase role="identifier">lightgray</phrase></code> and <code><phrase role="identifier">_fill_color</phrase>
+ <phrase role="special">=</phrase> <phrase role="identifier">whitesmoke</phrase></code>.
+ This will become customizable.
+ </para>
+ <section id="svg_plot.behavior.behavior_limits.behavior_NaN">
+ <title><link linkend="svg_plot.behavior.behavior_limits.behavior_NaN"> NaN</link></title>
+ <para>
+ Any double precision floating point numbers that return a nonzero value
+ for the function <code><phrase role="identifier">_isnan</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">double</phrase><phrase
+ role="special">)</phrase></code> is considered to be a NaN value. When
+ plotted, the number will appear in the user-defined coordinates as 0.
+ </para>
+ </section>
+ <section id="svg_plot.behavior.behavior_limits.behavior_infinity">
+ <title><link linkend="svg_plot.behavior.behavior_limits.behavior_infinity">
+ Infinity</link></title>
+ <para>
+ Any double precision floating point number that is equal to either of the
+ following is considered to be Infinity:
+ </para>
+
+<programlisting>
+<phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">numeric_limits</phrase><phrase role="special"><</phrase><phrase role="keyword">double</phrase><phrase role="special">>::</phrase><phrase role="identifier">max</phrase><phrase role="special">()</phrase>
+<phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">numeric_limits</phrase><phrase role="special"><</phrase><phrase role="keyword">double</phrase><phrase role="special">>::</phrase><phrase role="identifier">infinity</phrase><phrase role="special">()</phrase>
+</programlisting>
+ <para>
+ When plotted, these values will appear at the top of your plot window.
+ If the plot window is not turned on, these points will appear at the top
+ of the graph.
+ </para>
+ </section>
+ <section id="svg_plot.behavior.behavior_limits.behavior_neg_infinity">
+ <title><link linkend="svg_plot.behavior.behavior_limits.behavior_neg_infinity">
+ Negative Infinity</link></title>
+ <para>
+ Any double precision floating point number that is equal to either of the
+ following is considered to be Negative Infinity:
+ </para>
+
+<programlisting>
+<phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">numeric_limits</phrase><phrase role="special"><</phrase><phrase role="keyword">double</phrase><phrase role="special">>::</phrase><phrase role="identifier">min</phrase><phrase role="special">()</phrase>
+<phrase role="special">-</phrase><phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">numeric_limits</phrase><phrase role="special"><</phrase><phrase role="keyword">double</phrase><phrase role="special">>::</phrase><phrase role="identifier">infinity</phrase><phrase role="special">()</phrase>
+<phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase role="identifier">numeric_limits</phrase><phrase role="special"><</phrase><phrase role="keyword">double</phrase><phrase role="special">>::</phrase><phrase role="identifier">denorm_min</phrase><phrase role="special">()</phrase>
+</programlisting>
+ <para>
+ When plotted, these values will appear at the bottom of your plot window.
+ If the plot window is not turned on, these points will appear at the bottom
+ of the graph.
+ </para>
+ </section>
+ <para>
+ Here is an example of numeric limit handling in action:
+ </para>
+ <para>
+ <inlinemediaobject><imageobject><imagedata fileref="images/2d_limit.png"></imagedata></imageobject>
+ <textobject>
+ <phrase>2d_limit</phrase>
+ </textobject>
+ </inlinemediaobject>
+ </para>
+ </section>
+ </section>
 <section id="svg_plot.plot_defaults">
- <title> Defaults</title>
+ <title><link linkend="svg_plot.plot_defaults"> Defaults</link></title>
 <section id="svg_plot.plot_defaults.1d_defaults">
- <title> <code><phrase role="identifier">svg_1d_plot</phrase></code> Defaults</title>
+ <title><link linkend="svg_plot.plot_defaults.1d_defaults"> <code><phrase role="identifier">svg_1d_plot</phrase></code>
+ Defaults</link></title>
+ <para>
+ You may have noticed that there are certain defaults that are true at the
+ beginning of the plotting. Here is a table of the defaults:
+ </para>
+ <table frame="all"> <title>Default Values</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>
+ <para>
+ object
+ </para>
+ </entry><entry>
+ <para>
+ Default value
+ </para>
+ </entry><entry>
+ <para>
+ Rationale
+ </para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ All colors not defined in this table
+ </para>
+ </entry><entry>
+ <para>
+ black
+ </para>
+ </entry><entry>
+ <para>
+ K.I.S.S. Coloring will be highly dependent on user needs
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Axis
+ </para>
+ </entry><entry>
+ <para>
+ On, internal style
+ </para>
+ </entry><entry>
+ <para>
+ Most graphs include an axis of some kind. The internal axis style is
+ used because this seems to be the default behavior in many textbooks
+ I have owned.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Distance between major X ticks
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="number">3</phrase> <phrase role="identifier">units</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Reasonably fits into a plot window
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Font size of the legend title
+ </para>
+ </entry><entry>
+ <para>
+ 12
+ </para>
+ </entry><entry>
+ <para>
+ Reasonable when paired with the image size
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Font size of the X Label
+ </para>
+ </entry><entry>
+ <para>
+ 12
+ </para>
+ </entry><entry>
+ <para>
+ Reasonable when paired with the image size
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Font size of the title
+ </para>
+ </entry><entry>
+ <para>
+ 30
+ </para>
+ </entry><entry>
+ <para>
+ Makes the title stand out
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Grid lines
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">All</phrase> <phrase role="identifier">off</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Grid lines are a user's personal choice, so I default with the simpler
+ model
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Image background
+ </para>
+ </entry><entry>
+ <para>
+ white
+ </para>
+ </entry><entry>
+ <para>
+ K.I.S.S. Coloring will be highly dependent on user needs.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Image size
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="number">500</phrase> <phrase role="identifier">by</phrase>
+ <phrase role="number">350</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Details discernable. The image is easily viewable by those using 800x600
+ monitors
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Legend
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">Off</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ The goal of the defaults is to provide the cleanest possible plot as
+ a default. Excluding the legend meets this goal. If there is a public
+ outcry, I can change this.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Legend background
+ </para>
+ </entry><entry>
+ <para>
+ white
+ </para>
+ </entry><entry>
+ <para>
+ K.I.S.S. Coloring will be highly dependent on user needs
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Major tick length
+ </para>
+ </entry><entry>
+ <para>
+ 20 pixels
+ </para>
+ </entry><entry>
+ <para>
+ Tasteful default when paired with the window size. This also makes
+ the major ticks easily distinguishable from the minor ticks
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Major tick width
+ </para>
+ </entry><entry>
+ <para>
+ 2 pixels
+ </para>
+ </entry><entry>
+ <para>
+ Major ticks are more obvious than minor ticks
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Minor tick length
+ </para>
+ </entry><entry>
+ <para>
+ 10 pixels
+ </para>
+ </entry><entry>
+ <para>
+ Tasteful default when compared with the size of the grid. This makes
+ the minor ticks less obvious than the major ticks
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Minor tick width
+ </para>
+ </entry><entry>
+ <para>
+ 1 pixel
+ </para>
+ </entry><entry>
+ <para>
+ This makes the minor tick less obvious than the major ticks
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Number of minor X ticks between each major X tick
+ </para>
+ </entry><entry>
+ <para>
+ 2
+ </para>
+ </entry><entry>
+ <para>
+ This allows the minor ticks to appear on the integers
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Plot Window
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">Off</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Initially off because it is the simplest case. I will change this if
+ there is an outcry
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Plot window background
+ </para>
+ </entry><entry>
+ <para>
+ white
+ </para>
+ </entry><entry>
+ <para>
+ K.I.S.S. Coloring will be highly dependent on user needs
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Title
+ </para>
+ </entry><entry>
+ <para>
+ On, <code><phrase role="string">"Plot of data"</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ The title is on because this is one of the most basic elements of a
+ graph. The title is set to a default because when <code><phrase role="identifier">title_on</phrase>
+ <phrase role="special">==</phrase> <phrase role="keyword">true</phrase></code>,
+ something should display
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Title size
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="number">30</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This is clearly visible in a variety of image sizes
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ X Axis Label
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="string">"X Axis"</phrase></code>, Off
+ </para>
+ </entry><entry>
+ <para>
+ "X Axis" is the label because something should display were
+ the user to turn on the X axis label without setting text, and this
+ is the most informative
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ X Axis Label Size
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="number">12</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This is a reasonable size at the default image size
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ X Grid (Major and Minor)
+ </para>
+ </entry><entry>
+ <para>
+ Off
+ </para>
+ </entry><entry>
+ <para>
+ Turned off in the interest of providing simple, clean plots
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ X Range
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="special">(-</phrase><phrase role="number">10</phrase><phrase
+ role="special">,</phrase> <phrase role="number">10</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Traditional plot viewport
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section id="svg_plot.plot_defaults.2d_defaults">
+ <title><link linkend="svg_plot.plot_defaults.2d_defaults"> <code><phrase role="identifier">svg_2d_plot</phrase></code>
+ Defaults</link></title>
 <para>
 You may have noticed that there are certain defaults that are true at the
 beginning of the plotting. Here is a table of the defaults:
 </para>
+ <table frame="all"> <title>Default Values</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>
+ <para>
+ object
+ </para>
+ </entry><entry>
+ <para>
+ Default value
+ </para>
+ </entry><entry>
+ <para>
+ Rationale
+ </para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ All colors not defined in this table
+ </para>
+ </entry><entry>
+ <para>
+ black
+ </para>
+ </entry><entry>
+ <para>
+ K.I.S.S. Coloring will be highly dependent on user needs
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Axis
+ </para>
+ </entry><entry>
+ <para>
+ On, internal style
+ </para>
+ </entry><entry>
+ <para>
+ Most graphs include an axis of some kind. The internal axis style is
+ used because this seems to be the default behavior in many textbooks
+ I have owned.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Distance between major X ticks
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="number">3</phrase> <phrase role="identifier">units</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Reasonably fits into a plot window
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Font size of the legend title
+ </para>
+ </entry><entry>
+ <para>
+ 12
+ </para>
+ </entry><entry>
+ <para>
+ Reasonable when paired with the image size
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Font size of the X Label
+ </para>
+ </entry><entry>
+ <para>
+ 12
+ </para>
+ </entry><entry>
+ <para>
+ Reasonable when paired with the image size
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Font size of the title
+ </para>
+ </entry><entry>
+ <para>
+ 30
+ </para>
+ </entry><entry>
+ <para>
+ Makes the title stand out
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Grid lines
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">All</phrase> <phrase role="identifier">off</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Grid lines are a user's personal choice, so I default with the simpler
+ model
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Image background
+ </para>
+ </entry><entry>
+ <para>
+ white
+ </para>
+ </entry><entry>
+ <para>
+ K.I.S.S. Coloring will be highly dependent on user needs.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Image size
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="number">500</phrase> <phrase role="identifier">by</phrase>
+ <phrase role="number">350</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Details discernable. The image is easily viewable by those using 800x600
+ monitors
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Legend
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">Off</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ The goal of the defaults is to provide the cleanest possible plot as
+ a default. Excluding the legend meets this goal. If there is a public
+ outcry, I can change this.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Legend background
+ </para>
+ </entry><entry>
+ <para>
+ white
+ </para>
+ </entry><entry>
+ <para>
+ K.I.S.S. Coloring will be highly dependent on user needs
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Major tick length
+ </para>
+ </entry><entry>
+ <para>
+ 20 pixels
+ </para>
+ </entry><entry>
+ <para>
+ Tasteful default when paired with the window size. This also makes
+ the major ticks easily distinguishable from the minor ticks
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Major tick width
+ </para>
+ </entry><entry>
+ <para>
+ 2 pixels
+ </para>
+ </entry><entry>
+ <para>
+ Major ticks are more obvious than minor ticks
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Minor tick length
+ </para>
+ </entry><entry>
+ <para>
+ 10 pixels
+ </para>
+ </entry><entry>
+ <para>
+ Tasteful default when compared with the size of the grid. This makes
+ the minor ticks less obvious than the major ticks
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Minor tick width
+ </para>
+ </entry><entry>
+ <para>
+ 1 pixel
+ </para>
+ </entry><entry>
+ <para>
+ This makes the minor tick less obvious than the major ticks
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Number of minor X ticks between each major X tick
+ </para>
+ </entry><entry>
+ <para>
+ 2
+ </para>
+ </entry><entry>
+ <para>
+ This allows the minor ticks to appear on the integers
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Plot Window
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">Off</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Initially off because it is the simplest case. I will change this if
+ there is an outcry
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Plot window background
+ </para>
+ </entry><entry>
+ <para>
+ white
+ </para>
+ </entry><entry>
+ <para>
+ K.I.S.S. Coloring will be highly dependent on user needs
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Title
+ </para>
+ </entry><entry>
+ <para>
+ On, <code><phrase role="string">"Plot of data"</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ The title is on because this is one of the most basic elements of a
+ graph. The title is set to a default because when <code><phrase role="identifier">title_on</phrase>
+ <phrase role="special">==</phrase> <phrase role="keyword">true</phrase></code>,
+ something should display
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Title size
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="number">30</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This is clearly visible in a variety of image sizes
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ X Axis Label
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="string">"X Axis"</phrase></code>, Off
+ </para>
+ </entry><entry>
+ <para>
+ "X Axis" is the label because something should display were
+ the user to turn on the X axis label without setting text, and this
+ is the most informative
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ X Axis Label Size
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="number">12</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This is a reasonable size at the default image size
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ X Grid (Major and Minor)
+ </para>
+ </entry><entry>
+ <para>
+ Off
+ </para>
+ </entry><entry>
+ <para>
+ Turned off in the interest of providing simple, clean plots
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ X Range
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="special">(-</phrase><phrase role="number">10</phrase><phrase
+ role="special">,</phrase> <phrase role="number">10</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Traditional plot viewport
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Y Axis Label
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="string">"Y Axis"</phrase></code>, Off
+ </para>
+ </entry><entry>
+ <para>
+ "Y Axis" is the label because something should display were
+ the user to turn on the X axis label without setting text, and this
+ is the most informative
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Y Axis Label Size
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="number">12</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This is a reasonable size at the default image size
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Y Grid (Major and Minor)
+ </para>
+ </entry><entry>
+ <para>
+ Off
+ </para>
+ </entry><entry>
+ <para>
+ Turned off in the interest of providing simple, clean plots
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Y Range
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="special">(-</phrase><phrase role="number">10</phrase><phrase
+ role="special">,</phrase> <phrase role="number">10</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Traditional plot viewport
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ </section>
+ <section id="svg_plot.svg_interface">
+ <title><link linkend="svg_plot.svg_interface"> SVG Public Interface</link></title>
+ <table frame="all"> <title>class svg</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>
+ <para>
+ Signature
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry><entry>
+ <para>
+ Notes
+ </para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg</phrase><phrase role="special">()</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Constructor
+ </para>
+ </entry><entry>
+ <para>
+ The default image size is (400, 400)
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">g_element</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">add_g_element</phrase><phrase role="special">()</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Adds a g_element at the root of the document tree. Acts as a <code><phrase
+ role="identifier">push_back</phrase><phrase role="special">()</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Returns the <code><phrase role="identifier">g_element</phrase></code>
+ that is pushed back. This allows you to do something like the following:
+ <code><phrase role="identifier">image</phrase><phrase role="special">.</phrase><phrase
+ role="identifier">add_g_element</phrase><phrase role="special">().</phrase><phrase
+ role="identifier">line</phrase><phrase role="special">(/**/).</phrase><phrase
+ role="identifier">line</phrase><phrase role="special">(/**/).</phrase><phrase
+ role="identifier">rect</phrase><phrase role="special">(/**/);</phrase>
+ </code> Which adds two lines and a rectangle to the g_element that was
+ just created.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">circle</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">double</phrase> <phrase role="identifier">x</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
+ role="identifier">y</phrase><phrase role="special">,</phrase> <phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase>
+ <phrase role="identifier">radius</phrase> <phrase role="special">=</phrase>
+ <phrase role="number">5</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Adds a point at (x,y) in the root level of the document
+ </para>
+ </entry><entry>
+ <para>
+ If the user is calling the circle method, odds are they would prefer
+ a real circle instead of a degenerate circle (a point). 5 is as good
+ a default as any other, and the user does not likely want a point if
+ they are making this call.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">g_element</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">get_g_element</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Gets the g_element at the index specified
+ </para>
+ </entry><entry>
+ <para>
+ Gives a runtime error if you specify an index that does not contain a
+ <code><phrase role="identifier">g_element</phrase></code>. I am considering
+ providing an iterator interface to access these elements.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase>
+ <phrase role="identifier">get_x_size</phrase><phrase role="special">()</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Returns the width of the image
+ </para>
+ </entry><entry>
+ <para>
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase>
+ <phrase role="identifier">get_y_size</phrase><phrase role="special">()</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Returns the height of the image
+ </para>
+ </entry><entry>
+ <para>
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">image_size</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">unsigned</phrase> <phrase
+ role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the size of the image produced, in pixels
+ </para>
+ </entry><entry>
+ <para>
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">line</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">double</phrase> <phrase role="identifier">x1</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
+ role="identifier">y1</phrase><phrase role="special">,</phrase> <phrase
+ role="keyword">double</phrase> <phrase role="identifier">x2</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
+ role="identifier">y2</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Adds a line from (x1,y1) to (x2,y2) in the root level of the document
+ </para>
+ </entry><entry>
+ <para>
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">path_element</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">path</phrase><phrase role="special">()</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Pushes a <code><phrase role="identifier">path_element</phrase></code>
+ to the back of the tree and returns a reference to it. This allows you
+ to do the following:
+<programlisting>
+<phrase role="identifier">path_element</phrase><phrase role="special">&</phrase> <phrase role="identifier">my_path</phrase> <phrase role="special">=</phrase> <phrase role="identifier">image</phrase><phrase role="special">.</phrase><phrase role="identifier">path</phrase><phrase role="special">();</phrase>
+
+<phrase role="identifier">my_path</phrase><phrase role="special">.</phrase><phrase role="identifier">M</phrase><phrase role="special">(</phrase><phrase role="number">3</phrase><phrase role="special">,</phrase> <phrase role="number">3</phrase><phrase role="special">).</phrase><phrase role="identifier">l</phrase><phrase role="special">(</phrase><phrase role="number">150</phrase><phrase role="special">,</phrase> <phrase role="number">150</phrase><phrase role="special">);</phrase>
+</programlisting>
+ I'm open to suggestions for how to improve this process.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">rect</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">double</phrase> <phrase role="identifier">x1</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
+ role="identifier">y1</phrase><phrase role="special">,</phrase> <phrase
+ role="keyword">double</phrase> <phrase role="identifier">width</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
+ role="identifier">height</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Adds a rectangle at point (x1, y1) that has width <code><phrase role="identifier">width</phrase></code>
+ and height <code><phrase role="identifier">height</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">text</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">double</phrase> <phrase role="identifier">x</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
+ role="identifier">y</phrase><phrase role="special">,</phrase> <phrase
+ role="identifier">std</phrase><phrase role="special">::</phrase><phrase
+ role="identifier">string</phrase> <phrase role="identifier">text</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Adds text <code><phrase role="identifier">text</phrase></code> at (x,y)
+ in the root level of the document
+ </para>
+ </entry><entry>
+ <para>
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">write</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">std</phrase><phrase
+ role="special">::</phrase><phrase role="identifier">string</phrase><phrase
+ role="special">&)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Writes the document to the file represented by the argument
+ </para>
+ </entry><entry>
+ <para>
+ Opens the file stream itself and tries to call <code><phrase role="identifier">write</phrase><phrase
+ role="special">(</phrase><phrase role="identifier">std</phrase><phrase
+ role="special">::</phrase><phrase role="identifier">ostream</phrase><phrase
+ role="special">&)</phrase></code>. Throws <code><phrase role="identifier">std</phrase><phrase
+ role="special">::</phrase><phrase role="identifier">runtime_exception</phrase></code>
+ if it can not open the file.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">write</phrase><phrase role="special">(</phrase><phrase
+ role="identifier">std</phrase><phrase role="special">::</phrase><phrase
+ role="identifier">ostream</phrase><phrase role="special">&)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Writes the document to the stream represented by the argument
+ </para>
+ </entry><entry>
+ <para>
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section id="svg_plot.svg_1d_plot_interface">
+ <title><link linkend="svg_plot.svg_1d_plot_interface"> <code><phrase role="identifier">svg_1d_plot</phrase></code>
+ Public Interface</link></title>
+ <section id="svg_plot.svg_1d_plot_interface.svg_1d_inter_misc">
+ <title><link linkend="svg_plot.svg_1d_plot_interface.svg_1d_inter_misc"> Miscellaneous
+ Functions</link></title>
 <informaltable frame="all">
- <bridgehead renderas="sect4">
- <phrase role="table-title">Default Values</phrase>
- </bridgehead>
- <tgroup cols="3">
+ <tgroup cols="2">
 <thead>
 <row>
- <entry>object</entry><entry>Default value</entry><entry>Rationale</entry>
+ <entry>
+ <para>
+ Signature
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry>
 </row>
 </thead>
 <tbody>
 <row>
- <entry>All colors not defined in this table</entry><entry>black</entry><entry>K.I.S.S.
- Coloring will be highly dependent on user needs</entry>
- </row>
- <row>
- <entry>Axis</entry><entry>On, internal style</entry><entry>Most graphs
- include an axis of some kind. The internal axis style is used because
- this seems to be the default behavior in many textbooks I have owned.</entry>
- </row>
- <row>
- <entry>Distance between major X ticks</entry><entry><code><phrase role="number">3</phrase> <phrase
- role="identifier">units</phrase></code></entry><entry>Reasonably fits
- into a plot window</entry>
- </row>
- <row>
- <entry>Font size of the legend title</entry><entry>12</entry><entry>Reasonable
- when paired with the image size</entry>
- </row>
- <row>
- <entry>Font size of the X Label</entry><entry>12</entry><entry>Reasonable
- when paired with the image size</entry>
- </row>
- <row>
- <entry>Font size of the title</entry><entry>30</entry><entry>Makes
- the title stand out</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">()</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ See the defaults section for further details
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Grid lines</entry><entry><code><phrase role="identifier">All</phrase> <phrase
- role="identifier">off</phrase></code></entry><entry>Grid lines are
- a user's personal choice, so I default with the simpler model</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">image_size</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">unsigned</phrase>
+ <phrase role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the size of the image produced, in pixels
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Image background</entry><entry>white</entry><entry>K.I.S.S.
- Coloring will be highly dependent on user needs.</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">legend_title_font_size</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">unsigned</phrase>
+ <phrase role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the font size for the legend title
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Image size</entry><entry><code><phrase role="number">500</phrase> <phrase
- role="identifier">by</phrase> <phrase role="number">350</phrase></code></entry><entry>Details
- discernable. The image is easily viewable by those using 800x600 monitors</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">title</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">std</phrase><phrase
+ role="special">::</phrase><phrase role="identifier">string</phrase><phrase
+ role="special">&)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the string to be used for the title
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Legend</entry><entry><code><phrase role="identifier">Off</phrase></code></entry><entry>The
- goal of the defaults is to provide the cleanest possible plot as a
- default. Excluding the legend meets this goal. If there is a public
- outcry, I can change this.</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">title_font_size</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the font size for the title
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Legend background</entry><entry>white</entry><entry>K.I.S.S.
- Coloring will be highly dependent on user needs</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">write</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">std</phrase><phrase
+ role="special">::</phrase><phrase role="identifier">string</phrase><phrase
+ role="special">&)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Writes the plot to the file passed as a parameter
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Major tick length</entry><entry>20 pixels</entry><entry>Tasteful
- default when paired with the window size. This also makes the major
- ticks easily distinguishable from the minor ticks</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">write</phrase><phrase role="special">(</phrase><phrase
+ role="identifier">ostream</phrase><phrase role="special">&)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Writes the plot to a stream passed as a parameter
+ </para>
+ </entry>
 </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+ <section id="svg_plot.svg_1d_plot_interface.1d_inter_commands">
+ <title><link linkend="svg_plot.svg_1d_plot_interface.1d_inter_commands"> Commands</link></title>
+ <informaltable frame="all">
+ <tgroup cols="2">
+ <thead>
 <row>
- <entry>Major tick width</entry><entry>2 pixels</entry><entry>Major
- ticks are more obvious than minor ticks</entry>
+ <entry>
+ <para>
+ Signature
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry>
 </row>
+ </thead>
+ <tbody>
 <row>
- <entry>Minor tick length</entry><entry>10 pixels</entry><entry>Tasteful
- default when compared with the size of the grid. This makes the minor
- ticks less obvious than the major ticks</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">axis_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets whether the axis is on or off
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Minor tick width</entry><entry>1 pixel</entry><entry>This makes
- the minor tick less obvious than the major ticks</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">legend_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets whether the legend is on or off
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Number of minor X ticks between each major X tick</entry><entry>2</entry><entry>This
- allows the minor ticks to appear on the integers</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">plot_window_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets whether the plot will be displayed in its own window, or will
+ be "full screen" in the image
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Plot Window</entry><entry><code><phrase role="identifier">Off</phrase></code></entry><entry>Initially
- off because it is the simplest case. I will change this if there is
- an outcry</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">title_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Determines whether or not the image title is displayed
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Plot window background</entry><entry>white</entry><entry>K.I.S.S.
- Coloring will be highly dependent on user needs</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_axis_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Determines whether or not the X axis is displayed
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Title</entry><entry>On, <code><phrase role="string">"Plot
- of data"</phrase></code></entry><entry>The title is on because
- this is one of the most basic elements of a graph. The title is set
- to a default because when <code><phrase role="identifier">title_on</phrase> <phrase
- role="special">==</phrase> <phrase role="keyword">true</phrase></code>,
- something should display</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_external_style_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Determines whether or not the axis is inside or outside of the plot.
+ Defaults to <code><phrase role="keyword">false</phrase></code>
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Title size</entry><entry><code><phrase role="number">30</phrase></code></entry><entry>This
- is clearly visible in a variety of image sizes</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_label_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets whether or not the x axis label will show
+ </para>
+ </entry>
 </row>
 <row>
- <entry>X Axis Label</entry><entry><code><phrase role="string">"X
- Axis"</phrase></code>, Off</entry><entry>"X Axis" is
- the label because something should display were the user to turn on
- the X axis label without setting text, and this is the most informative</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_labels_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ sets whether or not the major ticks will be labelled on the x axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>X Axis Label Size</entry><entry><code><phrase role="number">12</phrase></code></entry><entry>This
- is a reasonable size at the default image size</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_grid_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Determines whether or not the major grid on the X axis will be displayed
+ </para>
+ </entry>
 </row>
 <row>
- <entry>X Grid (Major and Minor)</entry><entry>Off</entry><entry>Turned
- off in the interest of providing simple, clean plots</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_minor_grid_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Determines whether or not the minor grid on the X axis will be displayed
+ </para>
+ </entry>
 </row>
 <row>
- <entry>X Range</entry><entry><code><phrase role="special">(-</phrase><phrase
- role="number">10</phrase><phrase role="special">,</phrase> <phrase
- role="number">10</phrase><phrase role="special">)</phrase></code></entry><entry>Traditional
- plot viewport</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_axis_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Determines whether or not the Y axis is displayed
+ </para>
+ </entry>
 </row>
 </tbody>
 </tgroup>
 </informaltable>
 </section>
- <section id="svg_plot.plot_defaults.2d_defaults">
- <title> <code><phrase role="identifier">svg_2d_plot</phrase></code> Defaults</title>
- <para>
- You may have noticed that there are certain defaults that are true at the
- beginning of the plotting. Here is a table of the defaults:
- </para>
+ <section id="svg_plot.svg_1d_plot_interface.1d_inter_color">
+ <title><link linkend="svg_plot.svg_1d_plot_interface.1d_inter_color"> Color
+ Information</link></title>
 <informaltable frame="all">
- <bridgehead renderas="sect4">
- <phrase role="table-title">Default Values</phrase>
- </bridgehead>
- <tgroup cols="3">
+ <tgroup cols="2">
 <thead>
 <row>
- <entry>object</entry><entry>Default value</entry><entry>Rationale</entry>
+ <entry>
+ <para>
+ Signature
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry>
 </row>
 </thead>
 <tbody>
 <row>
- <entry>All colors not defined in this table</entry><entry>black</entry><entry>K.I.S.S.
- Coloring will be highly dependent on user needs</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">background_border_color</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
+ role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
+ role="identifier">col</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the background border color for the legend as <code><phrase role="identifier">col</phrase></code>,
+ an RGB color
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Axis</entry><entry>On, internal style</entry><entry>Most graphs
- include an axis of some kind. The internal axis style is used because
- this seems to be the default behavior in many textbooks I have owned.</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">background_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the background color for the whole image
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Distance between major X ticks</entry><entry><code><phrase role="number">3</phrase> <phrase
- role="identifier">units</phrase></code></entry><entry>Reasonably fits
- into a plot window</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">legend_background_color</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
+ role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
+ role="identifier">col</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the background color for the legend as <code><phrase role="identifier">col</phrase></code>,
+ an RGB color
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Font size of the legend title</entry><entry>12</entry><entry>Reasonable
- when paired with the image size</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">legend_border_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the border color for the legend as <code><phrase role="identifier">col</phrase></code>,
+ an RGB color
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Font size of the X Label</entry><entry>12</entry><entry>Reasonable
- when paired with the image size</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">plot_background_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the color of the plot area. Note: this only goes into effect
+ if plot_area(true) has been called
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Font size of the title</entry><entry>30</entry><entry>Makes
- the title stand out</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">title_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the title color
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Grid lines</entry><entry><code><phrase role="identifier">All</phrase> <phrase
- role="identifier">off</phrase></code></entry><entry>Grid lines are
- a user's personal choice, so I default with the simpler model</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_axis_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the lines that form the axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Image background</entry><entry>white</entry><entry>K.I.S.S.
- Coloring will be highly dependent on user needs.</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_label_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the labels that go along the X axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Image size</entry><entry><code><phrase role="number">500</phrase> <phrase
- role="identifier">by</phrase> <phrase role="number">350</phrase></code></entry><entry>Details
- discernable. The image is easily viewable by those using 800x600 monitors</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_grid_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the grid that runs perpindicular to the X axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Legend</entry><entry><code><phrase role="identifier">Off</phrase></code></entry><entry>The
- goal of the defaults is to provide the cleanest possible plot as a
- default. Excluding the legend meets this goal. If there is a public
- outcry, I can change this.</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_tick_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the major ticks of the x-axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Legend background</entry><entry>white</entry><entry>K.I.S.S.
- Coloring will be highly dependent on user needs</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_minor_grid_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the minor grid of the x-axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Major tick length</entry><entry>20 pixels</entry><entry>Tasteful
- default when paired with the window size. This also makes the major
- ticks easily distinguishable from the minor ticks</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_minor_tick_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the minor ticks of the x-axis
+ </para>
+ </entry>
 </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+ <section id="svg_plot.svg_1d_plot_interface.1d_inter_axis_information">
+ <title><link linkend="svg_plot.svg_1d_plot_interface.1d_inter_axis_information">
+ Axis Information</link></title>
+ <informaltable frame="all">
+ <tgroup cols="2">
+ <thead>
 <row>
- <entry>Major tick width</entry><entry>2 pixels</entry><entry>Major
- ticks are more obvious than minor ticks</entry>
+ <entry>
+ <para>
+ Signature
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry>
 </row>
+ </thead>
+ <tbody>
 <row>
- <entry>Minor tick length</entry><entry>10 pixels</entry><entry>Tasteful
- default when compared with the size of the grid. This makes the minor
- ticks less obvious than the major ticks</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_axis_width</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the stroke width of the x-axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Minor tick width</entry><entry>1 pixel</entry><entry>This makes
- the minor tick less obvious than the major ticks</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_label</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">std</phrase><phrase
+ role="special">::</phrase><phrase role="identifier">string</phrase><phrase
+ role="special">&)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the label of the x-axis. This does not guarantee that it will
+ be shown. You must run <code><phrase role="identifier">x_label_on</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">true</phrase><phrase
+ role="special">)</phrase></code> for that guarantee
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Number of minor X ticks between each major X tick</entry><entry>2</entry><entry>This
- allows the minor ticks to appear on the integers</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_interval</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">double</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the distance (in Cartesian units) between ticks on the x-axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Plot Window</entry><entry><code><phrase role="identifier">Off</phrase></code></entry><entry>Initially
- off because it is the simplest case. I will change this if there is
- an outcry</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_tick_length</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the length (in pixels) of the x-axis major ticks
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Plot window background</entry><entry>white</entry><entry>K.I.S.S.
- Coloring will be highly dependent on user needs</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_tick_width</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the width (in pixels) of the major ticks on the x-axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Title</entry><entry>On, <code><phrase role="string">"Plot
- of data"</phrase></code></entry><entry>The title is on because
- this is one of the most basic elements of a graph. The title is set
- to a default because when <code><phrase role="identifier">title_on</phrase> <phrase
- role="special">==</phrase> <phrase role="keyword">true</phrase></code>,
- something should display</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_minor_tick_length</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the length (in pixels) of the x-axis minor tick lengths
+ </para>
+ </entry>
 </row>
 <row>
- <entry>Title size</entry><entry><code><phrase role="number">30</phrase></code></entry><entry>This
- is clearly visible in a variety of image sizes</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_minor_tick_width</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the width (in pixels) of the minor ticks on the x-axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>X Axis Label</entry><entry><code><phrase role="string">"X
- Axis"</phrase></code>, Off</entry><entry>"X Axis" is
- the label because something should display were the user to turn on
- the X axis label without setting text, and this is the most informative</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_num_minor_ticks</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the number of minor ticks between each major tick
+ </para>
+ </entry>
 </row>
 <row>
- <entry>X Axis Label Size</entry><entry><code><phrase role="number">12</phrase></code></entry><entry>This
- is a reasonable size at the default image size</entry>
- </row>
- <row>
- <entry>X Grid (Major and Minor)</entry><entry>Off</entry><entry>Turned
- off in the interest of providing simple, clean plots</entry>
- </row>
- <row>
- <entry>X Range</entry><entry><code><phrase role="special">(-</phrase><phrase
- role="number">10</phrase><phrase role="special">,</phrase> <phrase
- role="number">10</phrase><phrase role="special">)</phrase></code></entry><entry>Traditional
- plot viewport</entry>
- </row>
- <row>
- <entry>Y Axis Label</entry><entry><code><phrase role="string">"Y
- Axis"</phrase></code>, Off</entry><entry>"Y Axis" is
- the label because something should display were the user to turn on
- the X axis label without setting text, and this is the most informative</entry>
- </row>
- <row>
- <entry>Y Axis Label Size</entry><entry><code><phrase role="number">12</phrase></code></entry><entry>This
- is a reasonable size at the default image size</entry>
- </row>
- <row>
- <entry>Y Grid (Major and Minor)</entry><entry>Off</entry><entry>Turned
- off in the interest of providing simple, clean plots</entry>
- </row>
- <row>
- <entry>Y Range</entry><entry><code><phrase role="special">(-</phrase><phrase
- role="number">10</phrase><phrase role="special">,</phrase> <phrase
- role="number">10</phrase><phrase role="special">)</phrase></code></entry><entry>Traditional
- plot viewport</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_1d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_range</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">double</phrase> <phrase role="identifier">x1</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">double</phrase>
+ <phrase role="identifier">x2</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the scale of the x axis from x1 to x2. Throws an exception if
+ x2<=x1
+ </para>
+ </entry>
 </row>
 </tbody>
 </tgroup>
 </informaltable>
 </section>
- </section>
- <section id="svg_plot.svg_interface">
- <title> SVG Public Interface</title>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- <phrase role="table-title">class svg</phrase>
- </bridgehead>
+ <section id="svg_plot.svg_1d_plot_interface.1d_plot_function">
+ <title><link linkend="svg_plot.svg_1d_plot_interface.1d_plot_function"> The
+ <code><phrase role="identifier">plot</phrase><phrase role="special">()</phrase></code>
+ Method</link></title>
+ <para>
+ The <code><phrase role="identifier">plot</phrase><phrase role="special">()</phrase></code>
+ method is defined using Boost.Parameter. As such, it supports a few extra
+ named parameters, as well as a deduced parameter.
+ </para>
+ <table frame="all"> <title>Required parameter</title>
 <tgroup cols="3">
 <thead>
 <row>
- <entry>Signature</entry><entry>Description</entry><entry>Notes</entry>
+ <entry>
+ <para>
+ ID
+ </para>
+ </entry><entry>
+ <para>
+ Type (* is a wildcard)
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry>
 </row>
 </thead>
 <tbody>
 <row>
- <entry><code><phrase role="identifier">svg</phrase><phrase role="special">()</phrase></code></entry><entry>Constructor</entry><entry>The
- default image size is (400, 400)</entry>
+ <entry>
+ <para>
+ _container
+ </para>
+ </entry><entry>
+ <para>
+ *
+ </para>
+ </entry><entry>
+ <para>
+ Any object that can return an iterator with begin() and end()
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">g_element</phrase><phrase role="special">&</phrase> <phrase
- role="identifier">add_g_element</phrase><phrase role="special">()</phrase></code></entry><entry>Adds
- a g_element at the root of the document tree. Acts as a <code><phrase
- role="identifier">push_back</phrase><phrase role="special">()</phrase></code></entry><entry>Returns
- the <code><phrase role="identifier">g_element</phrase></code> that is
- pushed back. This allows you to do something like the following: <code><phrase
- role="identifier">image</phrase><phrase role="special">.</phrase><phrase
- role="identifier">add_g_element</phrase><phrase role="special">().</phrase><phrase
- role="identifier">line</phrase><phrase role="special">(/**/).</phrase><phrase
- role="identifier">line</phrase><phrase role="special">(/**/).</phrase><phrase
- role="identifier">rect</phrase><phrase role="special">(/**/);</phrase> </code>
- Which adds two lines and a rectangle to the g_element that was just created.</entry>
+ <entry>
+ <para>
+ _title
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase
+ role="identifier">string</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ The name of this series
+ </para>
+ </entry>
 </row>
+ </tbody>
+ </tgroup>
+ </table> <table frame="all"> <title>Deduced parameter</title>
+ <tgroup cols="4">
+ <thead>
 <row>
- <entry><code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase> <phrase
- role="identifier">circle</phrase><phrase role="special">(</phrase><phrase
- role="keyword">double</phrase> <phrase role="identifier">x</phrase><phrase
- role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
- role="identifier">y</phrase><phrase role="special">,</phrase> <phrase
- role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase> <phrase
- role="identifier">radius</phrase> <phrase role="special">=</phrase> <phrase
- role="number">5</phrase><phrase role="special">)</phrase></code></entry><entry>Adds
- a point at (x,y) in the root level of the document</entry><entry>If the
- user is calling the circle method, odds are they would prefer a real
- circle instead of a degenerate circle (a point). 5 is as good a default
- as any other, and the user does not likely want a point if they are making
- this call.</entry>
+ <entry>
+ <para>
+ ID
+ </para>
+ </entry><entry>
+ <para>
+ Type
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry><entry>
+ <para>
+ Default
+ </para>
+ </entry>
 </row>
+ </thead>
+ <tbody>
 <row>
- <entry><code><phrase role="identifier">g_element</phrase><phrase role="special">&</phrase> <phrase
- role="identifier">get_g_element</phrase><phrase role="special">(</phrase><phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Gets
- the g_element at the index specified</entry><entry>Gives a runtime error
- if you specify an index that does not contain a <code><phrase role="identifier">g_element</phrase></code>.
- I am considering providing an iterator interface to access these elements.</entry>
+ <entry>
+ <para>
+ _fill_color
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">svg_color</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This is the color that shows up inside of the circle that is being
+ drawn
+ </para>
+ </entry><entry>
+ <para>
+ white
+ </para>
+ </entry>
 </row>
+ </tbody>
+ </tgroup>
+ </table> <table frame="all"> <title>Optional Parameters</title>
+ <tgroup cols="4">
+ <thead>
 <row>
- <entry><code><phrase role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase> <phrase
- role="identifier">get_x_size</phrase><phrase role="special">()</phrase></code></entry><entry>Returns
- the width of the image</entry><entry></entry>
+ <entry>
+ <para>
+ ID
+ </para>
+ </entry><entry>
+ <para>
+ Type
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry><entry>
+ <para>
+ Default
+ </para>
+ </entry>
 </row>
+ </thead>
+ <tbody>
 <row>
- <entry><code><phrase role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase> <phrase
- role="identifier">get_y_size</phrase><phrase role="special">()</phrase></code></entry><entry>Returns
- the height of the image</entry><entry></entry>
+ <entry>
+ <para>
+ _stroke_color
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">svg_color</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ The outline of the circle that is being drawn
+ </para>
+ </entry><entry>
+ <para>
+ black
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase> <phrase
- role="identifier">image_size</phrase><phrase role="special">(</phrase><phrase
- role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
- role="special">,</phrase> <phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the size of the image produced, in pixels</entry><entry></entry>
+ <entry>
+ <para>
+ _point_style
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">point_shape</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This is the shape of the point. Options currently are between <literal>none</literal>,
+ <literal>circle</literal>, and <literal>square</literal>.
+ </para>
+ </entry><entry>
+ <para>
+ circle
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase> <phrase
- role="identifier">line</phrase><phrase role="special">(</phrase><phrase
- role="keyword">double</phrase> <phrase role="identifier">x1</phrase><phrase
- role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
- role="identifier">y1</phrase><phrase role="special">,</phrase> <phrase
- role="keyword">double</phrase> <phrase role="identifier">x2</phrase><phrase
- role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
- role="identifier">y2</phrase><phrase role="special">)</phrase></code></entry><entry>Adds
- a line from (x1,y1) to (x2,y2) in the root level of the document</entry><entry></entry>
+ <entry>
+ <para>
+ _size
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This is the height/width of the circle and square.
+ </para>
+ </entry><entry>
+ <para>
+ 10
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">path_element</phrase><phrase role="special">&</phrase> <phrase
- role="identifier">path</phrase><phrase role="special">()</phrase></code></entry><entry>Pushes
- a <code><phrase role="identifier">path_element</phrase></code> to the
- back of the tree and returns a reference to it. This allows you to do
- the following:
+ <entry>
+ <para>
+ _x_functor
+ </para>
+ </entry><entry>
+ <para>
+ *
+ </para>
+ </entry><entry>
+ <para>
+ A class or that contains a conversion function. You will not have to
+ worry about this, unless you are trying to accomplish stuff like plotting
+ a vector of humans. For example:
<programlisting>
-<phrase role="identifier">path_element</phrase><phrase role="special">&</phrase> <phrase role="identifier">my_path</phrase> <phrase role="special">=</phrase> <phrase role="identifier">image</phrase><phrase role="special">.</phrase><phrase role="identifier">path</phrase><phrase role="special">();</phrase>
-
-<phrase role="identifier">my_path</phrase><phrase role="special">.</phrase><phrase role="identifier">M</phrase><phrase role="special">(</phrase><phrase role="number">3</phrase><phrase role="special">,</phrase> <phrase role="number">3</phrase><phrase role="special">).</phrase><phrase role="identifier">l</phrase><phrase role="special">(</phrase><phrase role="number">150</phrase><phrase role="special">,</phrase> <phrase role="number">150</phrase><phrase role="special">);</phrase>
-</programlisting>
- I'm open to suggestions for how to improve this process. </entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase> <phrase
- role="identifier">rect</phrase><phrase role="special">(</phrase><phrase
- role="keyword">double</phrase> <phrase role="identifier">x1</phrase><phrase
- role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
- role="identifier">y1</phrase><phrase role="special">,</phrase> <phrase
- role="keyword">double</phrase> <phrase role="identifier">width</phrase><phrase
- role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
- role="identifier">height</phrase><phrase role="special">)</phrase></code></entry><entry>Adds
- a rectangle at point (x1, y1) that has width <code><phrase role="identifier">width</phrase></code>
- and height <code><phrase role="identifier">height</phrase></code></entry><entry></entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase> <phrase
- role="identifier">text</phrase><phrase role="special">(</phrase><phrase
- role="keyword">double</phrase> <phrase role="identifier">x</phrase><phrase
- role="special">,</phrase> <phrase role="keyword">double</phrase> <phrase
- role="identifier">y</phrase><phrase role="special">,</phrase> <phrase
- role="identifier">std</phrase><phrase role="special">::</phrase><phrase
- role="identifier">string</phrase> <phrase role="identifier">text</phrase><phrase
- role="special">)</phrase></code></entry><entry>Adds text <code><phrase
- role="identifier">text</phrase></code> at (x,y) in the root level of
- the document</entry><entry></entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase> <phrase
- role="identifier">write</phrase><phrase role="special">(</phrase><phrase
- role="keyword">const</phrase> <phrase role="identifier">std</phrase><phrase
- role="special">::</phrase><phrase role="identifier">string</phrase><phrase
- role="special">&)</phrase></code></entry><entry>Writes the document
- to the file represented by the argument</entry><entry>Opens the file
- stream itself and tries to call <code><phrase role="identifier">write</phrase><phrase
- role="special">(</phrase><phrase role="identifier">std</phrase><phrase
- role="special">::</phrase><phrase role="identifier">ostream</phrase><phrase
- role="special">&)</phrase></code>. Throws <code><phrase role="identifier">std</phrase><phrase
- role="special">::</phrase><phrase role="identifier">runtime_exception</phrase></code>
- if it can not open the file.</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg</phrase><phrase role="special">&</phrase> <phrase
- role="identifier">write</phrase><phrase role="special">(</phrase><phrase
- role="identifier">std</phrase><phrase role="special">::</phrase><phrase
- role="identifier">ostream</phrase><phrase role="special">&)</phrase></code></entry><entry>Writes
- the document to the stream represented by the argument</entry><entry></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section id="svg_plot.svg_1d_plot_interface">
- <title> <code><phrase role="identifier">svg_1d_plot</phrase></code> Public Interface</title>
- <section id="svg_plot.svg_1d_plot_interface.svg_1d_inter_misc">
- <title> Miscellaneous Functions</title>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- </bridgehead>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Signature</entry><entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">()</phrase></code></entry><entry>See the defaults section
- for further details</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">image_size</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">,</phrase> <phrase
- role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the size of the
- image produced, in pixels</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">legend_title_font_size</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the font size for the legend title</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">title</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">std</phrase><phrase role="special">::</phrase><phrase
- role="identifier">string</phrase><phrase role="special">&)</phrase></code></entry><entry>Sets
- the string to be used for the title</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">title_font_size</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the font size for the title</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">write</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">std</phrase><phrase role="special">::</phrase><phrase
- role="identifier">string</phrase><phrase role="special">&)</phrase></code></entry><entry>Writes
- the plot to the file passed as a parameter</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">write</phrase><phrase
- role="special">(</phrase><phrase role="identifier">ostream</phrase><phrase
- role="special">&)</phrase></code></entry><entry>Writes the plot
- to a stream passed as a parameter</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section id="svg_plot.svg_1d_plot_interface.1d_inter_commands">
- <title> Commands</title>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- </bridgehead>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Signature</entry><entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">axis_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets whether the axis
- is on or off</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">legend_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets whether the legend
- is on or off</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">plot_window_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets whether the plot
- will be displayed in its own window, or will be "full screen"
- in the image</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">title_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Determines whether or
- not the image title is displayed</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_axis_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Determines whether or
- not the X axis is displayed</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_external_style_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Determines whether or
- not the axis is inside or outside of the plot. Defaults to <code><phrase
- role="keyword">false</phrase></code></entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_label_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets whether or not
- the x axis label will show</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_labels_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>sets whether or not
- the major ticks will be labelled on the x axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_grid_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Determines whether or
- not the major grid on the X axis will be displayed</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_minor_grid_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Determines whether or
- not the minor grid on the X axis will be displayed</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_axis_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Determines whether or
- not the Y axis is displayed</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section id="svg_plot.svg_1d_plot_interface.1d_inter_color">
- <title> Color Information</title>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- </bridgehead>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Signature</entry><entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">background_border_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the background border color for the legend as <code><phrase role="identifier">col</phrase></code>,
- an RGB color</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">background_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the background color for the whole image</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">legend_background_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the background color for the legend as <code><phrase role="identifier">col</phrase></code>,
- an RGB color</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">legend_border_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the border color for the legend as <code><phrase role="identifier">col</phrase></code>,
- an RGB color</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">plot_background_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the color of the plot area. Note: this only goes into effect if plot_area(true)
- has been called</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">title_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the title color</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_axis_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the lines that form the axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_label_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the labels that go along the X axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_grid_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the grid that runs perpindicular to the X axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_tick_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the major ticks of the x-axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_minor_grid_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the minor grid of the x-axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_minor_tick_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the minor ticks of the x-axis</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section id="svg_plot.svg_1d_plot_interface.1d_inter_axis_information">
- <title> Axis Information</title>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- </bridgehead>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Signature</entry><entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_axis_width</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the stroke width of the x-axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_label</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">std</phrase><phrase role="special">::</phrase><phrase
- role="identifier">string</phrase><phrase role="special">&)</phrase></code></entry><entry>Sets
- the label of the x-axis. This does not guarantee that it will be shown.
- You must run <code><phrase role="identifier">x_label_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">true</phrase><phrase
- role="special">)</phrase></code> for that guarantee</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_interval</phrase><phrase
- role="special">(</phrase><phrase role="keyword">double</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the distance (in
- Cartesian units) between ticks on the x-axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_tick_length</phrase><phrase
- role="special">(</phrase><phrase role="keyword">int</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the length (in
- pixels) of the x-axis major ticks</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_tick_width</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the width (in pixels) of the major ticks on the x-axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_minor_tick_length</phrase><phrase
- role="special">(</phrase><phrase role="keyword">int</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the length (in
- pixels) of the x-axis minor tick lengths</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_minor_tick_width</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the width (in pixels) of the minor ticks on the x-axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_num_minor_ticks</phrase><phrase
- role="special">(</phrase><phrase role="keyword">int</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the number of minor
- ticks between each major tick</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_1d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_range</phrase><phrase
- role="special">(</phrase><phrase role="keyword">double</phrase> <phrase
- role="identifier">x1</phrase><phrase role="special">,</phrase> <phrase
- role="keyword">double</phrase> <phrase role="identifier">x2</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the scale of the
- x axis from x1 to x2. Throws an exception if x2<=x1 </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section id="svg_plot.svg_1d_plot_interface.1d_plot_function">
- <title> The <code><phrase role="identifier">plot</phrase><phrase role="special">()</phrase></code>
- Method</title>
- <para>
- The <code><phrase role="identifier">plot</phrase><phrase role="special">()</phrase></code>
- method is defined using Boost.Parameter. As such, it supports a few extra
- named parameters, as well as a deduced parameter.
- </para>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- <phrase role="table-title">Required parameter</phrase>
- </bridgehead>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>ID</entry><entry>Type (* is a wildcard)</entry><entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>_container</entry><entry>*</entry><entry>Any object that can
- return an iterator with begin() and end()</entry>
- </row>
- <row>
- <entry>_title</entry><entry><code><phrase role="identifier">std</phrase><phrase
- role="special">::</phrase><phrase role="identifier">string</phrase></code></entry><entry>The
- name of this series</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- <phrase role="table-title">Deduced parameter</phrase>
- </bridgehead>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>ID</entry><entry>Type</entry><entry>Description</entry><entry>Default</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>_fill_color</entry><entry><code><phrase role="identifier">svg_color</phrase></code></entry><entry>This
- is the color that shows up inside of the circle that is being drawn</entry><entry>white</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- <phrase role="table-title">Optional Parameters</phrase>
- </bridgehead>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>ID</entry><entry>Type</entry><entry>Description</entry><entry>Default</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>_stroke_color</entry><entry><code><phrase role="identifier">svg_color</phrase></code></entry><entry>The
- outline of the circle that is being drawn</entry><entry>black</entry>
- </row>
- <row>
- <entry>_point_style</entry><entry><code><phrase role="identifier">point_shape</phrase></code></entry><entry>This
- is the shape of the point. Options currently are between <literal>none</literal>,
- <literal>circle</literal>, and <literal>square</literal>.</entry><entry>circle</entry>
- </row>
- <row>
- <entry>_size</entry><entry><code><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase></code></entry><entry>This is the height/width
- of the circle and square.</entry><entry>10</entry>
- </row>
- <row>
- <entry>_x_functor</entry><entry>*</entry><entry>A class or that contains
- a conversion function. You will not have to worry about this, unless
- you are trying to accomplish stuff like plotting a vector of humans.
- For example:
-<programlisting>
-<phrase role="keyword">class</phrase> <phrase role="identifier">my_functor</phrase>
+<phrase role="keyword">class</phrase> <phrase role="identifier">my_functor</phrase>
<phrase role="special">{</phrase>
- <phrase role="identifier">typdef</phrase> <phrase role="keyword">double</phrase> <phrase role="identifier">result_type</phrase><phrase role="special">;</phrase>
+ <phrase role="identifier">typdef</phrase> <phrase role="keyword">double</phrase> <phrase role="identifier">result_type</phrase><phrase role="special">;</phrase>

- <phrase role="keyword">double</phrase> <phrase role="keyword">operator</phrase><phrase role="special">()(</phrase><phrase role="keyword">const</phrase> <phrase role="identifier">human</phrase><phrase role="special">&</phrase> <phrase role="identifier">_hum</phrase><phrase role="special">)</phrase>
+ <phrase role="keyword">double</phrase> <phrase role="keyword">operator</phrase><phrase role="special">()(</phrase><phrase role="keyword">const</phrase> <phrase role="identifier">human</phrase><phrase role="special">&</phrase> <phrase role="identifier">_hum</phrase><phrase role="special">)</phrase>
 <phrase role="special">{</phrase>
- <phrase role="keyword">return</phrase> <phrase role="special">(</phrase><phrase role="keyword">double</phrase><phrase role="special">)(</phrase><phrase role="identifier">_hum</phrase><phrase role="special">.</phrase><phrase role="identifier">age</phrase><phrase role="special">());</phrase>
+ <phrase role="keyword">return</phrase> <phrase role="special">(</phrase><phrase role="keyword">double</phrase><phrase role="special">)(</phrase><phrase role="identifier">_hum</phrase><phrase role="special">.</phrase><phrase role="identifier">age</phrase><phrase role="special">());</phrase>
 <phrase role="special">}</phrase>
<phrase role="special">}</phrase>

<phrase role="comment">// snip
</phrase>
-<phrase role="identifier">plot</phrase><phrase role="special">(</phrase><phrase role="identifier">my_plot</phrase><phrase role="special">,</phrase> <phrase role="identifier">my_data</phrase><phrase role="special">,</phrase> <phrase role="string">"Lions"</phrase><phrase role="special">,</phrase> <phrase role="identifier">_x_functor</phrase> <phrase role="special">=</phrase> <phrase role="identifier">my_functor</phrase><phrase role="special">());</phrase>
+<phrase role="identifier">plot</phrase><phrase role="special">(</phrase><phrase role="identifier">my_plot</phrase><phrase role="special">,</phrase> <phrase role="identifier">my_data</phrase><phrase role="special">,</phrase> <phrase role="string">"Lions"</phrase><phrase role="special">,</phrase> <phrase role="identifier">_x_functor</phrase> <phrase role="special">=</phrase> <phrase role="identifier">my_functor</phrase><phrase role="special">());</phrase>
</programlisting>
- </entry><entry> <code><phrase role="identifier">boost_default_convert</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">boost_default_convert</phrase></code>
 is sufficient in all cases where the data stored in the container can
- be directly casted to a double</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ be directly casted to a double
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
 <para>
 Here are some examples of correct uses:
 </para>
- <anchor id="svg_plot.svg_1d_plot_interface.1d_plot_function.using_fill_and_stroke_colors"
- />
+ <anchor id="svg_plot.svg_1d_plot_interface.1d_plot_function.using_fill_and_stroke_colors"/>
 <bridgehead renderas="sect3">
- Using fill and stroke colors
+ <link linkend="svg_plot.svg_1d_plot_interface.1d_plot_function.using_fill_and_stroke_colors">Using
+ fill and stroke colors</link>
 </bridgehead>

<programlisting>
@@ -1890,611 +3156,1165 @@
 </section>
 </section>
 <section id="svg_plot.svg_2d_plot_interface">
- <title> <code><phrase role="identifier">svg_2d_plot</phrase></code> Public Interface</title>
+ <title><link linkend="svg_plot.svg_2d_plot_interface"> <code><phrase role="identifier">svg_2d_plot</phrase></code>
+ Public Interface</link></title>
 <section id="svg_plot.svg_2d_plot_interface.2d_inter_misc">
- <title> Miscellaneous</title>
+ <title><link linkend="svg_plot.svg_2d_plot_interface.2d_inter_misc"> Miscellaneous</link></title>
 <informaltable frame="all">
- <bridgehead renderas="sect4">
- </bridgehead>
 <tgroup cols="2">
 <thead>
 <row>
- <entry>Signature</entry><entry>Description</entry>
+ <entry>
+ <para>
+ Signature
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry>
 </row>
 </thead>
 <tbody>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">()</phrase></code></entry><entry>See the defaults section
- for further details</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">image_size</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">,</phrase> <phrase
- role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the size of the
- image produced, in pixels</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">title</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">std</phrase><phrase role="special">::</phrase><phrase
- role="identifier">string</phrase><phrase role="special">&)</phrase></code></entry><entry>Sets
- the string to be used for the title</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">title_font_size</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the font size for the title</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">legend_title_font_size</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the font size for the legend title</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">()</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ See the defaults section for further details
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">image_size</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">unsigned</phrase>
+ <phrase role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the size of the image produced, in pixels
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">title</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">std</phrase><phrase
+ role="special">::</phrase><phrase role="identifier">string</phrase><phrase
+ role="special">&)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the string to be used for the title
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">title_font_size</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the font size for the title
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">legend_title_font_size</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">unsigned</phrase>
+ <phrase role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the font size for the legend title
+ </para>
+ </entry>
 </row>
 </tbody>
 </tgroup>
 </informaltable>
 </section>
 <section id="svg_plot.svg_2d_plot_interface.2d_inter_commands">
- <title> Commands</title>
+ <title><link linkend="svg_plot.svg_2d_plot_interface.2d_inter_commands"> Commands</link></title>
 <informaltable frame="all">
- <bridgehead renderas="sect4">
- </bridgehead>
 <tgroup cols="2">
 <thead>
 <row>
- <entry>Signature</entry><entry>Description</entry>
+ <entry>
+ <para>
+ Signature
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry>
 </row>
 </thead>
 <tbody>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">axis_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets whether the axis
- is on or off</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">axis_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets whether the axis is on or off
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">legend_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets whether the legend
- is on or off</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">legend_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets whether the legend is on or off
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">plot_window_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets whether the plot
- will be displayed in its own window, or will be "full screen"
- in the image</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">plot_window_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets whether the plot will be displayed in its own window, or will
+ be "full screen" in the image
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">title_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Determines whether or
- not the image title is displayed</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">title_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Determines whether or not the image title is displayed
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_label_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets whether or not
- the X axis label will show</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_label_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets whether or not the X axis label will show
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_grid_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Determines whether or
- not the major grid on the X axis will be displayed</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_grid_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Determines whether or not the major grid on the X axis will be displayed
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_labels_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>sets whether or not
- the major ticks will be labelled on the x axis</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_labels_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ sets whether or not the major ticks will be labelled on the x axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_minor_grid_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Determines whether or
- not the minor grid on the X axis will be displayed</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_minor_grid_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Determines whether or not the minor grid on the X axis will be displayed
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_label_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets whether or not
- the Y axis label will show</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_label_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets whether or not the Y axis label will show
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_major_grid_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Determines whether or
- not the major grid on the Y axis will be displayed</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_major_grid_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Determines whether or not the major grid on the Y axis will be displayed
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_major_labels_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>sets whether or not
- the major ticks will be labelled on the Y axis</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_major_labels_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ sets whether or not the major ticks will be labelled on the Y axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_minor_grid_on</phrase><phrase
- role="special">(</phrase><phrase role="keyword">bool</phrase><phrase
- role="special">)</phrase></code></entry><entry>Determines whether or
- not the minor grid on the Y axis will be displayed</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_minor_grid_on</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">bool</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Determines whether or not the minor grid on the Y axis will be displayed
+ </para>
+ </entry>
 </row>
 </tbody>
 </tgroup>
 </informaltable>
 </section>
 <section id="svg_plot.svg_2d_plot_interface.2d_inter_color">
- <title></title>
+ <title><link linkend="svg_plot.svg_2d_plot_interface.2d_inter_color"> Color</link></title>
 <informaltable frame="all">
- <bridgehead renderas="sect4">
- </bridgehead>
 <tgroup cols="2">
 <thead>
 <row>
- <entry>Signature</entry><entry>Description</entry>
+ <entry>
+ <para>
+ Signature
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry>
 </row>
 </thead>
 <tbody>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">title_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the title color</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">background_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the background color for the whole image</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">legend_background_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the background color for the legend as <code><phrase role="identifier">col</phrase></code>,
- an RGB color</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">legend_border_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the border color for the legend as <code><phrase role="identifier">col</phrase></code>,
- an RGB color</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">background_border_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the background border color for the legend as <code><phrase role="identifier">col</phrase></code>,
- an RGB color</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">plot_background_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Set
- the color of the plot area. Note: this only goes into effect if plot_area(true)
- has been called</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_axis_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the lines that form the axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_label_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the labels that go along the X axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_tick_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the major ticks of the x-axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_grid_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the grid that runs perpindicular to the X axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_minor_tick_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the minor ticks of the x-axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_axis_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the lines that form the Y axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_label_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the labels that go along the X axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_major_tick_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the major ticks of the Y-axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_major_grid_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the grid that runs perpindicular to the Y axis</entry>
- </row>
- <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_minor_tick_color</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
- role="identifier">col</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the color of the minor ticks of the Y-axis</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">title_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the title color
+ </para>
+ </entry>
 </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section id="svg_plot.svg_2d_plot_interface.2d_inter_axis">
- <title> Axis Information</title>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- </bridgehead>
- <tgroup cols="2">
- <thead>
 <row>
- <entry>Signature</entry><entry>Description</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">background_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the background color for the whole image
+ </para>
+ </entry>
 </row>
- </thead>
- <tbody>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_axis_width</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the stroke width of the x-axis</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">legend_background_color</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
+ role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
+ role="identifier">col</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the background color for the legend as <code><phrase role="identifier">col</phrase></code>,
+ an RGB color
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_label</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">std</phrase><phrase role="special">::</phrase><phrase
- role="identifier">string</phrase><phrase role="special">&)</phrase></code></entry><entry>Sets
- the label of the x-axis. This does not guarantee that it will be shown.
- You must run <code><phrase role="identifier">x_label</phrase><phrase
- role="special">(</phrase><phrase role="keyword">true</phrase><phrase
- role="special">)</phrase></code> for that guarantee</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">legend_border_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the border color for the legend as <code><phrase role="identifier">col</phrase></code>,
+ an RGB color
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_interval</phrase><phrase
- role="special">(</phrase><phrase role="keyword">double</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the distance (in
- Cartesian units) between ticks on the x-axis</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">background_border_color</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
+ role="identifier">svg_color</phrase> <phrase role="special">&</phrase><phrase
+ role="identifier">col</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the background border color for the legend as <code><phrase role="identifier">col</phrase></code>,
+ an RGB color
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_tick_length</phrase><phrase
- role="special">(</phrase><phrase role="keyword">int</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the length (in
- pixels) of the x-axis major ticks</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">plot_background_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Set the color of the plot area. Note: this only goes into effect
+ if plot_area(true) has been called
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_major_tick_width</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the width (in pixels) of the major ticks on the x-axis</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_axis_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the lines that form the axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_minor_tick</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the length (in pixels) of the x-axis minor ticks</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_label_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the labels that go along the X axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_minor_tick_length</phrase><phrase
- role="special">(</phrase><phrase role="keyword">int</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the length (in
- pixels) of the x-axis minor tick lengths</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_tick_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the major ticks of the x-axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_minor_tick_width</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the width (in pixels) of the minor ticks on the x-axis</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_grid_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the grid that runs perpindicular to the X axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_num_minor_ticks</phrase><phrase
- role="special">(</phrase><phrase role="keyword">int</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the number of minor
- ticks between each major tick</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_minor_tick_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the minor ticks of the x-axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">x_range</phrase><phrase
- role="special">(</phrase><phrase role="keyword">double</phrase> <phrase
- role="identifier">x1</phrase><phrase role="special">,</phrase> <phrase
- role="keyword">double</phrase> <phrase role="identifier">x2</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the scale of the
- x axis from x1 to x2. Throws an exception if x2<=x1 </entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_axis_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the lines that form the Y axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_axis_width</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the stroke width of the x-axis</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_label_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the labels that go along the X axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_label</phrase><phrase
- role="special">(</phrase><phrase role="keyword">const</phrase> <phrase
- role="identifier">std</phrase><phrase role="special">::</phrase><phrase
- role="identifier">string</phrase><phrase role="special">&)</phrase></code></entry><entry>Sets
- the label of the x-axis. This does not guarantee that it will be shown.
- You must run <code><phrase role="identifier">x_label</phrase><phrase
- role="special">(</phrase><phrase role="keyword">true</phrase><phrase
- role="special">)</phrase></code> for that guarantee</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_major_tick_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the major ticks of the Y-axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_major_tick</phrase><phrase
- role="special">(</phrase><phrase role="keyword">double</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the distance (in
- Cartesian units) between ticks on the Y axis</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_major_grid_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the grid that runs perpindicular to the Y axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_major_tick_length</phrase><phrase
- role="special">(</phrase><phrase role="keyword">int</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the length (in
- pixels) of the Y axis major ticks</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_minor_tick_color</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">svg_color</phrase>
+ <phrase role="special">&</phrase><phrase role="identifier">col</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the color of the minor ticks of the Y-axis
+ </para>
+ </entry>
 </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+ <section id="svg_plot.svg_2d_plot_interface.2d_inter_axis">
+ <title><link linkend="svg_plot.svg_2d_plot_interface.2d_inter_axis"> Axis Information</link></title>
+ <informaltable frame="all">
+ <tgroup cols="2">
+ <thead>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_major_tick_width</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the width (in pixels) of the major ticks on the Y axis</entry>
+ <entry>
+ <para>
+ Signature
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry>
 </row>
+ </thead>
+ <tbody>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_minor_tick</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the length (in pixels) of the Y axis minor ticks</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_axis_width</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the stroke width of the x-axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_major_tick_length</phrase><phrase
- role="special">(</phrase><phrase role="keyword">int</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the length (in
- pixels) of the Y axis minor tick lengths</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_label</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">std</phrase><phrase
+ role="special">::</phrase><phrase role="identifier">string</phrase><phrase
+ role="special">&)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the label of the x-axis. This does not guarantee that it will
+ be shown. You must run <code><phrase role="identifier">x_label</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">true</phrase><phrase
+ role="special">)</phrase></code> for that guarantee
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_minor_tick_width</phrase><phrase
- role="special">(</phrase><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase><phrase role="special">)</phrase></code></entry><entry>Sets
- the width (in pixels) of the minor ticks on the Y axis</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_interval</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">double</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the distance (in Cartesian units) between ticks on the x-axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_num_minor_ticks</phrase><phrase
- role="special">(</phrase><phrase role="keyword">int</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the number of minor
- ticks between each major tick</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_tick_length</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the length (in pixels) of the x-axis major ticks
+ </para>
+ </entry>
 </row>
 <row>
- <entry><code><phrase role="identifier">svg_2d_plot</phrase><phrase
- role="special">&</phrase> <phrase role="identifier">y_scale</phrase><phrase
- role="special">(</phrase><phrase role="keyword">double</phrase> <phrase
- role="identifier">y1</phrase><phrase role="special">,</phrase> <phrase
- role="keyword">double</phrase> <phrase role="identifier">y2</phrase><phrase
- role="special">)</phrase></code></entry><entry>Sets the scale of the
- Y axis from y1 to y2. Throws an exception if y2<=y1 </entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_major_tick_width</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the width (in pixels) of the major ticks on the x-axis
+ </para>
+ </entry>
 </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <para>
- (Note: Getters omitted for now)
- </para>
- <section id="svg_plot.svg_2d_plot_interface.plot_function">
- <title> The <code><phrase role="identifier">plot</phrase><phrase role="special">()</phrase></code>
- Method</title>
- <para>
- The <code><phrase role="identifier">plot</phrase><phrase role="special">()</phrase></code>
- method is defined using Boost.Parameter. As such, it supports a few extra
- named parameters, as well as a deduced parameter.
- </para>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- <phrase role="table-title">Required parameter</phrase>
- </bridgehead>
- <tgroup cols="3">
- <thead>
 <row>
- <entry>ID</entry><entry>Type (* is a wildcard)</entry><entry>Description</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_minor_tick</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the length (in pixels) of the x-axis minor ticks
+ </para>
+ </entry>
 </row>
- </thead>
- <tbody>
 <row>
- <entry>_container</entry><entry>*</entry><entry>Any object that can
- return an iterator with begin() and end()</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_minor_tick_length</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the length (in pixels) of the x-axis minor tick lengths
+ </para>
+ </entry>
 </row>
 <row>
- <entry>_title</entry><entry><code><phrase role="identifier">std</phrase><phrase
- role="special">::</phrase><phrase role="identifier">string</phrase></code></entry><entry>The
- name of this series</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_minor_tick_width</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the width (in pixels) of the minor ticks on the x-axis
+ </para>
+ </entry>
 </row>
- </tbody>
- </tgroup>
- </informaltable>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- <phrase role="table-title">Deduced parameter</phrase>
- </bridgehead>
- <tgroup cols="4">
- <thead>
 <row>
- <entry>ID</entry><entry>Type</entry><entry>Description</entry><entry>Default</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_num_minor_ticks</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the number of minor ticks between each major tick
+ </para>
+ </entry>
 </row>
- </thead>
- <tbody>
 <row>
- <entry>_fill_color</entry><entry><code><phrase role="identifier">svg_color</phrase></code></entry><entry>This
- is the color that shows up inside of the circle that is being drawn</entry><entry>white</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">x_range</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">double</phrase> <phrase role="identifier">x1</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">double</phrase>
+ <phrase role="identifier">x2</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the scale of the x axis from x1 to x2. Throws an exception if
+ x2<=x1
+ </para>
+ </entry>
 </row>
- </tbody>
- </tgroup>
- </informaltable>
- <informaltable frame="all">
- <bridgehead renderas="sect4">
- <phrase role="table-title">Optional Parameters</phrase>
- </bridgehead>
- <tgroup cols="4">
- <thead>
 <row>
- <entry>ID</entry><entry>Type</entry><entry>Description</entry><entry>Default</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_axis_width</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the stroke width of the x-axis
+ </para>
+ </entry>
 </row>
- </thead>
- <tbody>
 <row>
- <entry>_bezier_on</entry><entry><code><phrase role="keyword">bool</phrase></code></entry><entry>
- This determines whether or not BÃ©zier curve interpolation will be
- applied to the plot lines. It is important to note that the curve interpolation
- is still in its infancy, and should only be used with reasonably nice
- data sets</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_label</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">const</phrase> <phrase role="identifier">std</phrase><phrase
+ role="special">::</phrase><phrase role="identifier">string</phrase><phrase
+ role="special">&)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the label of the x-axis. This does not guarantee that it will
+ be shown. You must run <code><phrase role="identifier">x_label</phrase><phrase
+ role="special">(</phrase><phrase role="keyword">true</phrase><phrase
+ role="special">)</phrase></code> for that guarantee
+ </para>
+ </entry>
 </row>
 <row>
- <entry>_line_on</entry><entry><code><phrase role="keyword">bool</phrase></code></entry><entry>
- This determines whether or not there are lines drawn between data points.</entry><entry>false</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_major_tick</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">double</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the distance (in Cartesian units) between ticks on the Y axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>_line_color</entry><entry><code><phrase role="keyword">bool</phrase></code></entry><entry>
- This determines the color of the lines between data points </entry><entry>black
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_major_tick_length</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the length (in pixels) of the Y axis major ticks
+ </para>
 </entry>
 </row>
 <row>
- <entry>_area_fill_color</entry><entry><code><phrase role="identifier">svg_color</phrase></code></entry><entry>Defining
- this enables the "Fill Area Under Axis" feature. the color
- you define will be the fill color between a line and the area under
- the axis. This only takes effect if <code><phrase role="identifier">_line_on</phrase> <phrase
- role="special">=</phrase> <phrase role="keyword">true</phrase></code>
- is called.</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_major_tick_width</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the width (in pixels) of the major ticks on the Y axis
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_minor_tick</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the length (in pixels) of the Y axis minor ticks
+ </para>
+ </entry>
 </row>
 <row>
- <entry>_stroke_color</entry><entry><code><phrase role="identifier">svg_color</phrase></code></entry><entry>The
- outline of the circle that is being drawn</entry><entry>black</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_major_tick_length</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the length (in pixels) of the Y axis minor tick lengths
+ </para>
+ </entry>
 </row>
 <row>
- <entry>_point_style</entry><entry><code><phrase role="identifier">point_shape</phrase></code></entry><entry>This
- is the shape of the point. Options currently are between <literal>none</literal>,
- <literal>circle</literal>, and <literal>square</literal>.</entry><entry>circle</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_minor_tick_width</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase><phrase
+ role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the width (in pixels) of the minor ticks on the Y axis
+ </para>
+ </entry>
 </row>
 <row>
- <entry>_size</entry><entry><code><phrase role="keyword">unsigned</phrase> <phrase
- role="keyword">int</phrase></code></entry><entry>This is the height/width
- of the circle and square.</entry><entry>10</entry>
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_num_minor_ticks</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">int</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the number of minor ticks between each major tick
+ </para>
+ </entry>
 </row>
 <row>
- <entry>_x_functor</entry><entry>*</entry><entry>A class or that contains
- a conversion function. You will not have to worry about this, unless
- you are trying to accomplish stuff like plotting a vector of humans.
- For example:
+ <entry>
+ <para>
+ <code><phrase role="identifier">svg_2d_plot</phrase><phrase role="special">&</phrase>
+ <phrase role="identifier">y_scale</phrase><phrase role="special">(</phrase><phrase
+ role="keyword">double</phrase> <phrase role="identifier">y1</phrase><phrase
+ role="special">,</phrase> <phrase role="keyword">double</phrase>
+ <phrase role="identifier">y2</phrase><phrase role="special">)</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Sets the scale of the Y axis from y1 to y2. Throws an exception if
+ y2<=y1
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+ <para>
+ (Note: Getters omitted for now)
+ </para>
+ <section id="svg_plot.svg_2d_plot_interface.plot_function">
+ <title><link linkend="svg_plot.svg_2d_plot_interface.plot_function"> The <code><phrase
+ role="identifier">plot</phrase><phrase role="special">()</phrase></code> Method</link></title>
+ <para>
+ The <code><phrase role="identifier">plot</phrase><phrase role="special">()</phrase></code>
+ method is defined using Boost.Parameter. As such, it supports a few extra
+ named parameters, as well as a deduced parameter.
+ </para>
+ <table frame="all"> <title>Required parameter</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>
+ <para>
+ ID
+ </para>
+ </entry><entry>
+ <para>
+ Type (* is a wildcard)
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ _container
+ </para>
+ </entry><entry>
+ <para>
+ *
+ </para>
+ </entry><entry>
+ <para>
+ Any object that can return an iterator with begin() and end()
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ _title
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">std</phrase><phrase role="special">::</phrase><phrase
+ role="identifier">string</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ The name of this series
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table> <table frame="all"> <title>Deduced parameter</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>
+ <para>
+ ID
+ </para>
+ </entry><entry>
+ <para>
+ Type
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry><entry>
+ <para>
+ Default
+ </para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ _fill_color
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">svg_color</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This is the color that shows up inside of the circle that is being
+ drawn
+ </para>
+ </entry><entry>
+ <para>
+ white
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table> <table frame="all"> <title>Optional Parameters</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>
+ <para>
+ ID
+ </para>
+ </entry><entry>
+ <para>
+ Type
+ </para>
+ </entry><entry>
+ <para>
+ Description
+ </para>
+ </entry><entry>
+ <para>
+ Default
+ </para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ _bezier_on
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="keyword">bool</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This determines whether or not BÃ©zier curve interpolation will be
+ applied to the plot lines. It is important to note that the curve interpolation
+ is still in its infancy, and should only be used with reasonably nice
+ data sets
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ _line_on
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="keyword">bool</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This determines whether or not there are lines drawn between data points.
+ </para>
+ </entry><entry>
+ <para>
+ false
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ _line_color
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="keyword">bool</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This determines the color of the lines between data points
+ </para>
+ </entry><entry>
+ <para>
+ black
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ _area_fill_color
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">svg_color</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ Defining this enables the "Fill Area Under Axis" feature.
+ the color you define will be the fill color between a line and the
+ area under the axis. This only takes effect if <code><phrase role="identifier">_line_on</phrase>
+ <phrase role="special">=</phrase> <phrase role="keyword">true</phrase></code>
+ is called.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ _stroke_color
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">svg_color</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ The outline of the circle that is being drawn
+ </para>
+ </entry><entry>
+ <para>
+ black
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ _point_style
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">point_shape</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This is the shape of the point. Options currently are between <literal>none</literal>,
+ <literal>circle</literal>, and <literal>square</literal>.
+ </para>
+ </entry><entry>
+ <para>
+ circle
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ _size
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="keyword">unsigned</phrase> <phrase role="keyword">int</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ This is the height/width of the circle and square.
+ </para>
+ </entry><entry>
+ <para>
+ 10
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ _x_functor
+ </para>
+ </entry><entry>
+ <para>
+ *
+ </para>
+ </entry><entry>
+ <para>
+ A class or that contains a conversion function. You will not have to
+ worry about this, unless you are trying to accomplish stuff like plotting
+ a vector of humans. For example:
<programlisting>
-<phrase role="keyword">class</phrase> <phrase role="identifier">my_functor</phrase>
+<phrase role="keyword">class</phrase> <phrase role="identifier">my_functor</phrase>
<phrase role="special">{</phrase>
- <phrase role="identifier">typdef</phrase> <phrase role="identifier">pair</phrase><phrase role="special"><</phrase><phrase role="keyword">double</phrase><phrase role="special">,</phrase> <phrase role="keyword">double</phrase><phrase role="special">></phrase> <phrase role="identifier">result_type</phrase><phrase role="special">;</phrase>
+ <phrase role="identifier">typdef</phrase> <phrase role="identifier">pair</phrase><phrase role="special"><</phrase><phrase role="keyword">double</phrase><phrase role="special">,</phrase> <phrase role="keyword">double</phrase><phrase role="special">></phrase> <phrase role="identifier">result_type</phrase><phrase role="special">;</phrase>

- <phrase role="identifier">pair</phrase><phrase role="special"><</phrase><phrase role="keyword">double</phrase><phrase role="special">,</phrase> <phrase role="keyword">double</phrase><phrase role="special">></phrase> <phrase role="keyword">operator</phrase><phrase role="special">()(</phrase><phrase role="keyword">const</phrase> <phrase role="identifier">human</phrase><phrase role="special">&</phrase> <phrase role="identifier">_hum</phrase><phrase role="special">)</phrase> <phrase role="keyword">const</phrase>
+ <phrase role="identifier">pair</phrase><phrase role="special"><</phrase><phrase role="keyword">double</phrase><phrase role="special">,</phrase> <phrase role="keyword">double</phrase><phrase role="special">></phrase> <phrase role="keyword">operator</phrase><phrase role="special">()(</phrase><phrase role="keyword">const</phrase> <phrase role="identifier">human</phrase><phrase role="special">&</phrase> <phrase role="identifier">_hum</phrase><phrase role="special">)</phrase> <phrase role="keyword">const</phrase>
 <phrase role="special">{</phrase>
- <phrase role="keyword">return</phrase> <phrase role="identifier">pair</phrase><phrase role="special"><</phrase><phrase role="keyword">double</phrase><phrase role="special">,</phrase> <phrase role="keyword">double</phrase><phrase role="special">>(</phrase><phrase role="identifier">i</phrase><phrase role="special">,</phrase> <phrase role="identifier">_hum</phrase><phrase role="special">.</phrase><phrase role="identifier">age</phrase><phrase role="special">());</phrase>
+ <phrase role="keyword">return</phrase> <phrase role="identifier">pair</phrase><phrase role="special"><</phrase><phrase role="keyword">double</phrase><phrase role="special">,</phrase> <phrase role="keyword">double</phrase><phrase role="special">>(</phrase><phrase role="identifier">i</phrase><phrase role="special">,</phrase> <phrase role="identifier">_hum</phrase><phrase role="special">.</phrase><phrase role="identifier">age</phrase><phrase role="special">());</phrase>
 <phrase role="special">}</phrase>
<phrase role="special">}</phrase>

<phrase role="comment">// snip
</phrase>
-<phrase role="identifier">plot</phrase><phrase role="special">(</phrase><phrase role="identifier">my_plot</phrase><phrase role="special">,</phrase> <phrase role="identifier">my_data</phrase><phrase role="special">,</phrase> <phrase role="string">"Lions"</phrase><phrase role="special">,</phrase> <phrase role="identifier">_x_functor</phrase> <phrase role="special">=</phrase> <phrase role="identifier">my_functor</phrase><phrase role="special">());</phrase>
+<phrase role="identifier">plot</phrase><phrase role="special">(</phrase><phrase role="identifier">my_plot</phrase><phrase role="special">,</phrase> <phrase role="identifier">my_data</phrase><phrase role="special">,</phrase> <phrase role="string">"Lions"</phrase><phrase role="special">,</phrase> <phrase role="identifier">_x_functor</phrase> <phrase role="special">=</phrase> <phrase role="identifier">my_functor</phrase><phrase role="special">());</phrase>
</programlisting>
- </entry><entry> <code><phrase role="identifier">boost_default_2d_convert</phrase></code>
+ </para>
+ </entry><entry>
+ <para>
+ <code><phrase role="identifier">boost_default_2d_convert</phrase></code>
 (the default) is sufficient in all cases where the data stored in the
- container can be directly casted to a double</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ container can be directly casted to a double
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
 <para>
 Here are some examples of correct uses:
 </para>
- <anchor id="svg_plot.svg_2d_plot_interface.plot_function.using_fill_and_stroke_colors"
- />
+ <anchor id="svg_plot.svg_2d_plot_interface.plot_function.using_fill_and_stroke_colors"/>
 <bridgehead renderas="sect3">
- Using fill and stroke colors
+ <link linkend="svg_plot.svg_2d_plot_interface.plot_function.using_fill_and_stroke_colors">Using
+ fill and stroke colors</link>
 </bridgehead>

<programlisting>
@@ -2526,7 +4346,7 @@
 </section>
 </section>
 <section id="svg_plot.acknowledgements">
- <title> Acknowledgements</title>
+ <title><link linkend="svg_plot.acknowledgements"> Acknowledgements</link></title>
 <para>
 I would like to thank the following people:
 </para>

Next message: eric_at_[hidden]: "[Boost-commit] svn:boost r38538 - branches/proto"
Previous message: ghost_at_[hidden]: "[Boost-commit] svn:boost r38536 - in trunk/tools: bcp inspect/build"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk