Boost-Commit :

Date view	Thread view	Subject view	Author view

From: JakeVoytko_at_[hidden]
Date: 2007-07-28 14:12:19

Next message: JakeVoytko_at_[hidden]: "[Boost-commit] svn:boost r7576 - sandbox/SOC/2007/visualization/libs/svg_plot/example"
Previous message: JakeVoytko_at_[hidden]: "[Boost-commit] svn:boost r7574 - sandbox/SOC/2007/visualization/libs/svg_plot/doc"

Author: jakevoytko
Date: 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
New Revision: 7575
URL: http://svn.boost.org/trac/boost/changeset/7575

Log:
Trying, again, to add documentation now with correct MIME types

Added:
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/images/
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/images/1d_complex.png (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/images/plot_window.png (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/images/simple.png (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/1d_defaults.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/1d_special.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/2d_defaults.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/2d_special.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/acknowledgements.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_1d_layout.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_2d_layout.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_layout.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_function.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_window.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/preface.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/todo.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple.html (contents, props changed)
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_simple.html (contents, props changed)
Text files modified:
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/HTML.manifest | 11
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html | 202 ++++++++++++++-
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html | 159 ++++++++---
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/intro.html | 17
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_1d_plot_interface.html | 362 ++++++++++++++++++----------
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_2d_plot_interface.html | 421 ++++++++++++++++++++------------
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_interface.html | 117 ++++----
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial.html | 503 ++++++++++++++++++---------------------
   8 files changed, 1093 insertions(+), 699 deletions(-)

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-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -1,7 +1,14 @@
index.html
-svg_plot/intro.html
+svg_plot/todo.html
svg_plot/color.html
-svg_plot/tutorial.html
+svg_plot/tutorial_code_1d_simple.html
+svg_plot/full_1d_layout.html
+svg_plot/1d_special.html
+svg_plot/tutorial_2d_code_simple.html
+svg_plot/full_2d_layout.html
+svg_plot/2d_special.html
+svg_plot/plot_defaults.html
svg_plot/svg_interface.html
svg_plot/svg_1d_plot_interface.html
svg_plot/svg_2d_plot_interface.html
+svg_plot/acknowledgements.html

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/images/1d_complex.png
==============================================================================
Binary file. No diff available.

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/images/plot_window.png
==============================================================================
Binary file. No diff available.

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/images/simple.png
==============================================================================
Binary file. No diff available.

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-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -5,7 +5,7 @@
<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="next" href="svg_plot/intro.html" title=" Introduction">
+<link rel="next" href="svg_plot/todo.html" title=" To Do List">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
@@ -17,7 +17,7 @@
<td align="center">More</td>
</table>
<hr>
-<div class="spirit-nav"><a accesskey="n" href="svg_plot/intro.html"><img src="images/next.png" alt="Next"></a></div>
+<div class="spirit-nav"><a accesskey="n" href="svg_plot/todo.html"><img src="images/next.png" alt="Next"></a></div>
<div class="article" lang="en">
<div class="titlepage">
<div>
@@ -39,47 +39,201 @@
<div class="toc">
Table of Contents
<dl>
-<dt> Preface</dt>
-<dt> Introduction</dt>
+<dt> How To Use This Documentation</dt>
+<dd><dl>
+<dt> Admonishments</dt>
+<dt> Preface</dt>
+</dl></dd>
+<dt> To Do List</dt>
<dt> Colors</dt>
<dd><dl>
-<dt> Introduction</dt>
+<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> Internals and Rationale</dt>
-<dt> Usage</dt>
</dl></dd>
-<dt> Tutorial</dt>
+<dt> Tutorial: 1D Simple Program</dt>
+<dd><dl>
+<dt> Code Example</dt>
+<dt> Image</dt>
+<dt> A note on syntax</dt>
+<dt> Basic Example Breakdown</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>
+</dl></dd>
+<dt> Tutorial: Simple 2D Program</dt>
+<dd><dl>
+<dt> Simple Code Example</dt>
+<dt> Simple Image</dt>
+<dt> Basic Example Breakdown</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>
+</dl></dd>
+<dt> Defaults</dt>
<dd><dl>
-<dt> Basic Example</dt>
-<dt> Using a Plot Window</dt>
-<dt> Full Layout Example</dt>
-<dt> Color Customization</dt>
-<dt> svg_1d_plot Defaults</dt>
-<dt> Getting More Out Of The plot() Function</dt>
+<dt> svg_1d_plot Defaults</dt>
+<dt> svg_2d_plot Defaults</dt>
</dl></dd>
<dt> SVG Public Interface</dt>
<dt> svg_1d_plot Public Interface</dt>
+<dd><dl><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>
+<dd><dl><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></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.preface"></a> Preface</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>
+</dl></div>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Tutorial pages are intended for those who do not know how to use the program.
+ <div class="itemizedlist"><ul type="circle">
+<li>
+ The pages that begin with the tag "Tutorial: Simple" are for
+ absolute beginners.
+ </li>
+<li>
+ "Tutorial: Full" should give the intermediate user a good reference,
+ as well as show how the program can be used
+ </li>
+<li>
+ "Tutorial: Special" shows other features/options that the headers
+ provide to the user.
+ </li>
+</ul></div>
+</li>
+<li>
+ The pages labelled "__ Public
+ Interface" give reference information for their respective subjects.
+ You can find all public methods (and data members, when structs are concerned)
+ in these sections.
+ </li>
+<li>
+ If you have a feature request, or if it appears that my implementation is
+ in error, please check the To Do
+ page first, as well as the area's respective rationale section, if it exists.
+ If I you do not find your idea/complaint, please reach me either through
+ the Boost dev list, or email me at jakevoytko (at) gmail (dot) com
+ </li>
+</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>
+<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>
+</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>
+</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 result in confusion. Read all of these
+ you find.
+ </td></tr>
+</table></div>
+
+ And the first admonishment I will use is as follows:
+ 
+<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">
+ 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>

- Normally, 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
- oganized in one, two, or three dimensions allows us to see relations not otherwise
- visible in a list of numbers. Computers, however, deal with information numerically,
- and C++ and the STL do not offer a way to bridge that gap. This library allows
- the user to easily plot data stored in STL containers with (hopefully!) minimal
- intervention.
- 
+ 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
+ organized in one, two, or three dimensions allows us to see relations not
+ otherwise visible in a list of numbers. Computers, however, deal with information
+ numerically, and C++ and the STL do not currently offer a way to bridge the
+ gap. This library allows the user to easily plot data stored in STL containers
+ with (hopefully!) minimal intervention.
+ 
+
+ This project is focused on using STL containers in order to graph data on
+ a one-dimensional and two-dimensional (and if time allows, 3D!) plot. The
+ plot will currently be written in an SVG image, compliant with the standard. The goals of the project
+ are as follows:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ To let users produce a simple plot with minimal intervention by using sane
+ defaults
+ </li>
+<li>
+ To allow users to easily customize plots to their heart's content
+ </li>
+<li>
+ To allow the user to talk to the plot classes using coordinate units rather
+ than pixels or other arbitrary measures
+ </li>
+<li>
+ To create the backbone of a <code class="computeroutput">svg</code>
+ class that can be extended to fully support the standard
+ </li>
+</ul></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">
+ 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 23, 2007 at 03:06:57 GMT</td>
+<td align="left">Last revised: July 28, 2007 at 16:55:59 GMT</td>
<td align="right"></td>
</tr></table>
<hr>
-<div class="spirit-nav"><a accesskey="n" href="svg_plot/intro.html"><img src="images/next.png" alt="Next"></a></div>
+<div class="spirit-nav"><a accesskey="n" href="svg_plot/todo.html"><img src="images/next.png" alt="Next"></a></div>
</body>
</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/1d_defaults.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/1d_defaults.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,219 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> svg_1d_plot Defaults</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="1d_special.html" title=" Tutorial: 1D Special Features">
+<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%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="1d_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="tutorial_2d_code_simple.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.1d_defaults"></a> <code class="computeroutput">svg_1d_plot</code> Defaults</h2></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="id333926"></a>
+ Default Values
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<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>
+</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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</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>
+</tr>
+<tr>
+<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>
+</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>
+</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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="1d_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="tutorial_2d_code_simple.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/1d_special.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/1d_special.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,94 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Tutorial: 1D Special Features</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="full_1d_layout.html" title=" Tutorial: 1D Full Layout Example">
+<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%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="full_1d_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="tutorial_2d_code_simple.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.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>
+</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>
+
+ 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>:
+ 
+<pre class="programlisting">
+my_plot.x_major_grid_on(true)
+ .x_minor_grid_on(true);
+</pre>
+
+ To style it, you would use the following calls:
+ 
+<pre class="programlisting">
+my_plot.x_major_grid_color(lightgray)
+ .x_minor_grid_color(whitesmoke);
+</pre>
+
+ This will produce something like the following image:
+ 
+
+ (Insert image)
+ 
+</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>
+
+ For an alternate way to display a regular axis, you can use an external style:
+ 
+<pre class="programlisting">
+my_plot.x_external_style_on(true);
+</pre>
+
+ The axis is still styled using the normal methods. The following is an example
+ of the style that you can produce with this.
+ 
+
+ (insert image here)
+ 
+<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">
+ 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>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="full_1d_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="tutorial_2d_code_simple.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/2d_defaults.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/2d_defaults.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,246 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> svg_2d_plot Defaults</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="2d_special.html" title=" Tutorial: 2D Special Features">
+<link rel="next" href="svg_interface.html" title=" SVG Public Interface">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</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>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="svg_plot.2d_defaults"></a> <code class="computeroutput">svg_2d_plot</code> Defaults</h2></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="id337791"></a>
+ Default Values
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<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>
+</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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</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>
+</tr>
+<tr>
+<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>
+</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>
+</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>
+</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>
+</tr>
+<tr>
+<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>
+</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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</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>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/2d_special.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/2d_special.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,114 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Tutorial: 2D Special Features</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="full_2d_layout.html" title=" Tutorial: Full Layout Example">
+<link rel="next" href="plot_defaults.html" title=" Defaults">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</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>
+</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>
+<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>
+</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>
+
+ 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>:
+ 
+<pre class="programlisting">
+my_plot.y_major_grid_on(true)
+ .y_minor_grid_on(true);
+</pre>
+
+ To style it, you would use the following calls:
+ 
+<pre class="programlisting">
+my_plot.y_major_grid_color(lightgray)
+ .y_minor_grid_color(whitesmoke);
+</pre>
+
+ This will produce something like the following image:
+ 
+
+ (Insert image)
+ 
+</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>
+
+ For an alternate way to display a regular axis, you can use an external style:
+ 
+<pre class="programlisting">
+my_plot.y_external_style_on(true);
+</pre>
+
+ The axis is still styled using the normal methods. The following is an example
+ of the style that you can produce with this.
+ 
+
+ (insert image here)
+ 
+<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">
+ 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>
+
+ When there is a call to the plot() method, define <code class="computeroutput">_area_fill_color</code>
+ 
+<pre class="programlisting">
+multimap<double, double> my_data;
+svg_2d_plot my_plot;
+
+my_plot.plot(my_data, "Data", _area_fill_color(red));
+</pre>
+
+ This produces the following image:
+ 
+
+ (Insert image here!)
+ 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</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>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/acknowledgements.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/acknowledgements.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,68 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Acknowledgements</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_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%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="svg_2d_plot_interface.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>
+</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>
+
+ I would like to thank the following people:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+Google: For offering Summer of Code, and
+ giving me the opportunity to do something I never would have done otherwise.
+ </li>
+<li>
+Joaquín Mª López Muñoz: My GSoC mentor.
+ His proofreading and advice helped shape the project into what it is today,
+ and prevented small problems from becoming major problems.
+ </li>
+<li>
+Paul Bristow: For showing an active interest,
+ offering literally dozens of minor and major features he'd like to see, and
+ for helping with Boost.Build.
+ </li>
+<li>
+Matias Capeletto: For showing an active
+ interest, and offering feature suggestions.
+ </li>
+<li>
+Sarah Braun: For helping me pick colors
+ for examples.
+ </li>
+<li>
+Boost Community: For all of the encouragement,
+ suggestions, disagreements, and patience.
+ </li>
+</ul></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="svg_2d_plot_interface.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>
+</div>
+</body>
+</html>

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-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -6,8 +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="intro.html" title=" Introduction">
-<link rel="next" href="tutorial.html" title=" Tutorial">
+<link rel="prev" href="todo.html" title=" To Do List">
+<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%">
@@ -20,74 +20,141 @@
</table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="intro.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="tutorial.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="todo.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="tutorial_code_1d_simple.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.color"></a> Colors</h2></div></div></div>
<div class="toc"><dl>
-<dt> Introduction</dt>
+<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> Internals and Rationale</dt>
-<dt> Usage</dt>
</dl></div>
+
+ The project supports any RGB color, as well as a number of constants that are
+ <a href="http://www.w3.org/TR/SVG/types.html#ColorKeywords" target="_top">named by the
+ SVG standard</a>.
+ 
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.color.color_intro"></a> Introduction</h3></div></div></div>
-
- The project supports any color definable by the RGB interface, as well as
- a number of constants that are named by the SVG standard.
- 
+<a name="svg_plot.color.color_interface"></a> <code class="computeroutput">svg_color_constant</code>
+ Interface</h3></div></div></div>

- Here
- is a link to the SVG color constants that my program supports
+ <code class="computeroutput">svg_color_constant</code> is simply
+ an enumerated list. The colors are defined here.
+ The list contains all of your expected colors, such as black and red. The
+ list contains one extra color element, <code class="computeroutput">blank</code>,
+ used when you need to pass a color, but would not like it to show up. This
+ comes in handy for defining defaults for functions, for example.
 
</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>
-
- All color information is stored in RGB format in a svg_struct. The rationale
- for storing information in RGB format is because it is precise and is always
- representable the exact same way. Storing as a floating point percentage
- introduces the possibility of rounding error, which I would like to avoid
- at all costs. The same image file will always display the same way on any
- system that correctly implements the SVG format.
- 
-
- It is important to note that 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.
- 
+<a name="svg_plot.color.svg_color_constant_example"></a> Example of using <code class="computeroutput">svg_color_constant</code>
+</h3></div></div></div>
+<pre class="programlisting">
+using namespace boost::svg;
+
+svg_2d_plot my_plot;
+
+svg_color_constant my_const = red;
+
+my_plot.background_border_color(my_const);
+my_plot.background_color(lightgray);
+</pre>
+<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">
+
+ <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;
+</pre>

- Constants are defined in an enum, <code class="computeroutput">svg_color_constant</code>,
- in alphabetical order. This facilitates quick lookup of their RGB values
- quickly in an array.
- 
+ 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.color_usage"></a> Usage</h3></div></div></div>
+<a name="svg_plot.color.rgb_interface"></a> <code class="computeroutput">svg_color</code> interface</h3></div></div></div>

- To use an example, set_title_color(), here are the two different ways we
- could set the line color, one using RGB values, and the other using the constant.
+ You can define a <code class="computeroutput">svg_color</code>
+ using two different constructors
 
-
-
-
<pre class="programlisting">
-// Using a new RGB value
-my_plot.set_title_color(svg_color(139, 69, 19));
+// The parameters are red, green, and blue respectively.
+svg_color(int, int, int);

-// Using an existing RGB value
-my_plot.set_title_color(my_color);
+// Use a pre-existing color constant.
+svg_color(svg_color_constant);
+</pre>
+<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">
+ 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>
+</h3></div></div></div>
+<pre class="programlisting">
+using namespace boost::svg;

-// Using a color constant
-my_plot.set_title_color(saddlebrown);
+svg_color my_white(255, 255, 255);
+svg_color const_white(white);

-// Defining an RGB value from color constant. This is not required anywhere but in the plot() function
-my_plot.set_title_color(svg_color(saddle_brown));
-onstructor] </pre>
+BOOST_ASSERT(my_white == const_white);
+</pre>
+<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">
+ <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>
+
+ Constants are defined in an enum, <code class="computeroutput">svg_color_constant</code>,
+ in alphabetical order. This facilitates quick lookup of their RGB values
+ from an array. Anywhere that a <code class="computeroutput">svg_color</code>
+ can be used, a <code class="computeroutput">svg_color_constant</code>
+ can be used, as the conversion is implicit.
+ 

+ All color information is stored in RGB format in a <code class="computeroutput">svg_color</code>
+ struct. The rationale for storing information in RGB format is because it
+ is precise, and is always representable the exact same way. Storing a floating
+ point percentage introduces the possibility of rounding error, which I would
+ like to avoid at all costs.
 
</div>
</div>
@@ -97,7 +164,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="intro.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="tutorial.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="todo.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="tutorial_code_1d_simple.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_1d_layout.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_1d_layout.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,131 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Tutorial: 1D Full Layout Example</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="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">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial_code_1d_simple.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="1d_special.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.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>
+#include <deque>
+#include <cmath>
+#include <boost/array.hpp>
+
+using std::vector;
+using std::deque;
+using namespace boost::svg;
+
+double f(double x)
+{
+ return sqrt(x);
+}
+
+double g(double x)
+{
+ return -2 + x*x;
+}
+
+double h(double x)
+{
+ return -1 + 2*x;
+}
+
+int main()
+{
+ vector<double> data1;
+ deque<double> data2;
+ boost::array<double, 10> data3;
+
+ int j=0;
+ for(double i=0; i<9.5; i+=1.)
+ {
+ data1.push_back(f(i));
+ data2.push_front(g(i));
+ data3[j++] = h(i);
+ }
+
+ svg_1d_plot my_plot;
+
+ // Size/scale settings.
+ my_plot.image_size(500, 350)
+ .x_range(-3, 10);
+
+ // Text settings.
+ my_plot.title("Oh My!")
+ .title_font_size(29)
+ .x_label("Time in Months");
+
+ // Commands.
+ my_plot.legend_on(true)
+ .plot_window_on(true)
+ .x_label_on(true)
+ .x_major_labels_on(true);
+
+ // color settings
+ my_plot.background_color(svg_color(67, 111, 69))
+ .legend_background_color(svg_color(207, 202,167))
+ .legend_border_color(svg_color(102, 102, 84))
+ .plot_background_color(svg_color(136, 188, 126))
+ .title_color(white);
+
+ //axis settings
+ my_plot.x_major_tick(2)
+ .x_major_tick_length(14)
+ .x_major_tick_width(1)
+ .x_minor_tick_length(7)
+ .x_minor_tick_width(1)
+ .x_num_minor_ticks(3);
+
+ //legend settings
+ my_plot.legend_title_font_size(15);
+
+ my_plot.plot(data1, "Lions", blue);
+ my_plot.plot(data2, "Tigers", orange);
+ my_plot.plot(data3, "Bears", red);
+
+ my_plot.write("1d_complex.svg");
+
+ return 0;
+}
+</pre>
+
+ This produces the following output:
+ 
+
+ <img src="../images/1d_complex.png" alt="1d_complex">
+ 
+
+ A little bit of color customization goes a long way!
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial_code_1d_simple.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="1d_special.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_2d_layout.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_2d_layout.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,136 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Tutorial: Full Layout Example</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="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">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial_2d_code_simple.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="2d_special.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.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>
+#include <cmath>
+
+using std::multimap;
+using namespace boost::svg;
+
+double f(double x)
+{
+ return sqrt(x);
+}
+
+double g(double x)
+{
+ return -2 + x*x;
+}
+
+double h(double x)
+{
+ return -1 + 2*x;
+}
+
+int main()
+{
+ multimap<double, double> data1, data2, data3;
+
+ for(double i=0; i<=10.; i+=1.)
+ {
+ data1[i] = f(i);
+ data2[i] = g(i);
+ data3[i] = h(i);
+ }
+
+ svg_2d_plot my_plot;
+
+ // Size/scale settings.
+ my_plot.image_size(700, 500)
+ .x_range(-1, 10)
+ .y_range(-5, 100)
+
+ // Text settings.
+ my_plot.title("Plot of Mathematical Functions")
+ .title_font_size(29)
+ .x_label("Time in Months");
+
+ // Commands.
+ my_plot.legend_on(true)
+ .plot_window_on(true)
+ .x_label_on(true)
+ .x_major_labels_on(true);
+
+ // Color settings.
+ my_plot.background_color(svg_color(67, 111, 69))
+ .legend_background_color(svg_color(207, 202,167))
+ .legend_border_color(svg_color(102, 102, 84))
+ .plot_background_color(svg_color(136, 188, 126))
+ .title_color(white);
+
+ //X axis settings.
+ my_plot.x_major_tick(2)
+ .x_major_tick_length(14)
+ .x_major_tick_width(1)
+ .x_minor_tick_length(7)
+ .x_minor_tick_width(1)
+ .x_num_minor_ticks(3)
+
+ //Y axis settings.
+ .y_major_tick(10)
+ .y_num_minor_ticks(2);
+
+ //legend settings
+ my_plot.legend_title_font_size(15);
+
+ my_plot.plot(data1, "Sqrt(x)", blue,
+ _point_style = none,
+ _show_line = true);
+
+ my_plot.plot(data2, "-2 + x^2", orange,
+ _show_line = true);
+
+ my_plot.plot(data3, "-1 + 2x", red,
+ _point_style = square);
+
+ my_plot.write("1d_complex.svg");
+
+ return 0;
+}
+</pre>
+
+ This produces the following output:
+ 
+
+ <img src="../images/2d_complex.png" alt="2d_complex">
+ 
+
+ A little bit of color customization goes a long way!
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial_2d_code_simple.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="2d_special.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_layout.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/full_layout.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,136 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Full Layout Example</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="tutorial_code_simple.html" title=" Tutorial: Simple program">
+<link rel="next" href="1d_defaults.html" title=" svg_1d_plot Defaults">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial_code_simple.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="1d_defaults.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.full_layout"></a> Full Layout Example</h2></div></div></div>
+<div class="toc"><dl><dt> Example Code</dt></dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="svg_plot.full_layout.full_layout_code"></a> Example Code</h3></div></div></div>
+<pre class="programlisting">
+#include <boost/svg_plot/svg_1d_plot.hpp>
+#include <vector>
+#include <deque>
+#include <cmath>
+#include <boost/array.hpp>
+
+using std::vector;
+using std::deque;
+using namespace boost::svg;
+
+double f(double x)
+{
+ return sqrt(x);
+}
+
+double g(double x)
+{
+ return -2 + x*x;
+}
+
+double h(double x)
+{
+ return -1 + 2*x;
+}
+
+int main()
+{
+ vector<double> data1;
+ deque<double> data2;
+ boost::array<double, 10> data3;
+
+ int j=0;
+ for(double i=0; i<9.5; i+=1.)
+ {
+ data1.push_back(f(i));
+ data2.push_front(g(i));
+ data3[j++] = h(i);
+ }
+
+ svg_1d_plot my_plot;
+
+ // Size/scale settings.
+ my_plot.image_size(500, 350)
+ .x_range(-3, 10);
+
+ // Text settings.
+ my_plot.title("Oh My!")
+ .title_font_size(29)
+ .x_label("Time in Months");
+
+ // Commands.
+ my_plot.legend_on(true)
+ .plot_window_on(true)
+ .x_label_on(true)
+ .x_major_labels_on(true);
+
+ // color settings
+ my_plot.background_color(svg_color(67, 111, 69))
+ .legend_background_color(svg_color(207, 202,167))
+ .legend_border_color(svg_color(102, 102, 84))
+ .plot_background_color(svg_color(136, 188, 126))
+ .title_color(white);
+
+ //axis settings
+ my_plot.x_major_tick(2)
+ .x_major_tick_length(14)
+ .x_major_tick_width(1)
+ .x_minor_tick_length(7)
+ .x_minor_tick_width(1)
+ .x_num_minor_ticks(3);
+
+ //legend settings
+ my_plot.legend_title_font_size(15);
+
+ my_plot.plot(data1, "Lions", blue);
+ my_plot.plot(data2, "Tigers", orange);
+ my_plot.plot(data3, "Bears", red);
+
+ my_plot.write("1d_complex.svg");
+
+ return 0;
+}
+</pre>
+
+ This produces the following output:
+ 
+
+ <img src="../images/1d_complex.png" alt="1d_complex">
+ 
+
+ A little bit of color customization goes a long way!
+ 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial_code_simple.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="1d_defaults.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/intro.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/intro.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/intro.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -33,31 +33,30 @@
 
<div class="itemizedlist"><ul type="disc">
<li>
- To provide an easy syntax for graphing data
+ To provide an easy syntax for plotting data
 </li>
<li>
 To let users produce a simple plot with minimal intervention by using sane
 defaults
 </li>
<li>
- To demonstrate how to incorporate SVG images into Boost documentation
+ To push for SVG images to be fully supported by Boost documentation
 </li>
<li>
- To allow users to easily customize graphs to their heart's content
+ To allow users to easily customize plots to their heart's content
 </li>
<li>
- To allow the user to talk with the svg_graph class using coordinate units
- instead of pixels or other arbitrary measures
+ To allow the user to talk to the <code class="computeroutput">svg_graph</code>
+ class with coordinate units rather than pixels or other arbitrary measures
 </li>
<li>
- To create the backbone of a svg class that will be extended to fully support
- storing the standard
+ To create the backbone of a <code class="computeroutput">svg</code>
+ class that can be extended to fully support the standard
 </li>
</ul></div>

 I have only a student's grasp of C++, so if you have a suggestion to help me
- with design or implementation, either leave them here or email me at jakevoytko
- (at) gmail (dot) com
+ with design or implementation, email me at jakevoytko (at) gmail (dot) com
 
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,439 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Defaults</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="2d_special.html" title=" Tutorial: 2D Special Features">
+<link rel="next" href="svg_interface.html" title=" SVG Public Interface">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</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>
+</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>
+<div class="toc"><dl>
+<dt> svg_1d_plot Defaults</dt>
+<dt> svg_2d_plot Defaults</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>
+
+ 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="id337334"></a>
+ Default Values
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<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>
+</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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</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>
+</tr>
+<tr>
+<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>
+</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>
+</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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+</tbody>
+</table>
+</div>
+</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>
+
+ 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="id337820"></a>
+ Default Values
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<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>
+</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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<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>
+</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>
+</tr>
+<tr>
+<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>
+</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>
+</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>
+</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>
+</tr>
+<tr>
+<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>
+</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>
+</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>
+</tr>
+<tr>
+<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>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</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>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_function.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_function.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,191 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Getting More Out Of The plot() Function</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="1d_defaults.html" title=" svg_1d_plot Defaults">
+<link rel="next" href="svg_interface.html" title=" SVG Public Interface">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="1d_defaults.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_function"></a> Getting More Out Of The <code class="computeroutput">plot()</code> Function</h2></div></div></div>
+
+ The <code class="computeroutput">plot()</code>
+ function 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="id334128"></a>
+ Deduced parameter
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>ID</th>
+<th>Description</th>
+<th>Default</th>
+</tr></thead>
+<tbody><tr>
+<td>_fill_color</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="id334180"></a>
+ Optional Parameters
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>ID</th>
+<th>Description</th>
+<th>Default</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>_stroke_color</td>
+<td>The outline of the circle that is
+ being drawn</td>
+<td>black</td>
+</tr>
+<tr>
+<td>_point_style</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>This is the height/width of the circle and
+ square.</td>
+<td>10</td>
+</tr>
+<tr>
+<td>_x_functor</td>
+<td>A pointer to a class 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">
+[c++]
+class my_functor
+{
+ typdef double result_type;
+
+ double convert(const human& _hum)
+ {
+ return _hum.get_age();
+ }
+}
+
+// snip
+
+plot(my_plot, my_data, "Lions", _x_functor = my_functor());
+</pre>
+ </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>
+</tr>
+</tbody>
+</table>
+</div>
+
+ Here are some examples of correct uses:
+ 
+<a name="svg_plot.plot_function.using_fill_and_stroke_colors"></a><h3>
+<a name="id334512"></a>
+ Using fill and stroke colors
+ </h3>
+
+
+
+<pre class="programlisting">
+[c++]
+plot(my_plot, my_data, "Lions", _fill_color = svg_color(red), _stroke_color = svg_color(black));
+</pre>
+
+ 
+
+ This has the same effect as the following:
+ 
+
+
+
+<pre class="programlisting">
+[c++]
+plot(my_plot, my_data, "Lions", svg_color(red), svg_color(black));
+</pre>
+
+ 
+
+ and also the same effect as:
+
+<pre class="programlisting">
+[c++]
+plot(my_plot, my_data, "Lions", _stroke_color = svg_color(black), _fill_color = svg_color(red));
+</pre>
+
+ 
+
+ Since _fill_color is a deduced parameter, when two svg_colors are used in the
+ same function call, they are always inferred in the following order: (fill,
+ stroke).
+ 
+<a name="svg_plot.plot_function.using_all_parameters"></a><h3>
+<a name="id334885"></a>
+ Using all parameters
+ </h3>
+
+
+
+<pre class="programlisting">
+[c++]
+plot(my_plot, my_data, "Lions",
+ _fill_color = svg_color(red),
+ _stroke_color = svg_color(black),
+ _x_functor = my_functor());
+</pre>
+
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="1d_defaults.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>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_window.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_window.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,60 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Tutorial: Plot Windows</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="tutorial_code_simple.html" title=" Tutorial: Simple program">
+<link rel="next" href="full_layout.html" title=" Full Layout Example">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial_code_simple.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="full_layout.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_window"></a> Tutorial: Plot Windows</h2></div></div></div>
+
+ If the legend or the title is obscuring data, or you would merely like a different
+ choice for layout, you can opt to use a <code class="literal">plot window</code>. To
+ add it to a simple example:
+ 
+<pre class="programlisting">
+// Snip!
+svg_1d_plot my_plot;
+
+my_plot.title("My Graph")
+ .legend_on(true)
+ .x_range(-1, 11)
+ .plot_window_on(true);
+
+// Snip!
+</pre>
+
+ This produces the following image:
+ 
+
+ <img src="../images/plot_window.png" alt="plot_window">
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial_code_simple.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="full_layout.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/preface.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/preface.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,81 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Preface</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="../index.html" title="SVG_Plot">
+<link rel="next" href="todo.html" title=" To Do List">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.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="todo.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.preface"></a> Preface</h2></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 organized
+ in one, two, or three dimensions allows us to see relations not otherwise visible
+ in a list of numbers. Computers, however, deal with information numerically,
+ and C++ and the STL do not currently offer a way to bridge the gap. This library
+ allows the user to easily plot data stored in STL containers with (hopefully!)
+ minimal intervention.
+ 
+
+ This project is focused on using STL containers in order to graph data on a
+ one-dimensional and two-dimensional (and if time allows, 3D!) plot. The plot
+ will currently be written in an SVG image, compliant with the standard.
+ The goals of the project are as follows:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ To let users produce a simple plot with minimal intervention by using sane
+ defaults
+ </li>
+<li>
+ To allow users to easily customize plots to their heart's content
+ </li>
+<li>
+ To allow the user to talk to the plot classes using coordinate units rather
+ than pixels or other arbitrary measures
+ </li>
+<li>
+ To create the backbone of a <code class="computeroutput">svg</code>
+ class that can be extended to fully support the standard
+ </li>
+</ul></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">
+ 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>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.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="todo.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-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -25,9 +25,11 @@
<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>
+<div class="toc"><dl><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="informaltable">
<h4>
-<a name="id335921"></a>
+<a name="id339471"></a>
 Misc
 </h4>
<table class="table">
@@ -41,46 +43,31 @@
</tr></thead>
<tbody>
<tr>
-<td> <code class="computeroutput">void plot_range(std::vector<double>::const_iterator begin, std::vector<double>::const_iterator end, std::string text);</code>
-</td>
-<td>Plots a vector<double>
- from begin() to end(). It adds the text <code class="computeroutput">text</code>
- to the legend. If you are looking for the generic version, you can find
- it below.</td>
-</tr>
-<tr>
-<td><code class="computeroutput">void plot(const std::vector<double>& _ctr, const std::string&, const plot_point_style&)</code></td>
-<td>Plots
- a vector<double> from begin() to end(). It adds the text <code class="computeroutput">text</code> to the legend. The point color
- for this series is going to be <code class="computeroutput">col</code>.
- If you are looking for the generic version, you can find it below.</td>
-</tr>
-<tr>
<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& set_image_size(unsigned int, unsigned int)</code></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& set_title(const std::string&)</code></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>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_title_font_size(unsigned int)</code></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& set_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& write(const std::string&)</code></td>
<td>Writes the plot to
 the file passed as a parameter</td>
@@ -95,7 +82,7 @@
</div>
<div class="informaltable">
<h4>
-<a name="id336567"></a>
+<a name="id339833"></a>
 Commands
 </h4>
<table class="table">
@@ -109,52 +96,62 @@
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_axis_on(bool)</code></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& set_legend_on(bool)</code></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& set_plot_window_on(bool)</code></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& set_x_label_on(bool)</code></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>
+</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>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_x_major_labels_on(bool)</code></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& set_title_on(bool)</code></td>
+<td><code class="computeroutput">svg_1d_plot& x_major_grid_on(bool)</code></td>
<td>Determines
- whether or not the image title is displayed</td>
+ whether or not the major grid on the X axis will be displayed</td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_x_major_grid_on(bool)</code></td>
+<td><code class="computeroutput">svg_1d_plot& x_minor_grid_on(bool)</code></td>
<td>Determines
- whether or not the major grid on the X axis will be displayed</td>
+ whether or not the minor grid on the X axis will be displayed</td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_x_minor_grid_on(bool)</code></td>
+<td><code class="computeroutput">svg_1d_plot& y_axis_on(bool)</code></td>
<td>Determines
- whether or not the minor grid on the X axis will be displayed</td>
+ whether or not the Y axis is displayed</td>
</tr>
</tbody>
</table>
</div>
<div class="informaltable">
<h4>
-<a name="id336927"></a>
+<a name="id340274"></a>
 Color Information
 </h4>
<table class="table">
@@ -168,118 +165,64 @@
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_title_color(svg_color_constant col)</code></td>
-<td>Set the title color</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_1d_plot& set_title_color(const svg_color &col)</code></td>
-<td>Set the title color</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_1d_plot& set_background_color(svg_color_constant col)</code></td>
-<td>Set the background color
- for the whole image</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& set_background_color(const svg_color &col)</code></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& set_legend_background_color(svg_color_constant col)</code></td>
-<td>Set the background color
- for the legend as <code class="computeroutput">col</code>,
- a SVG Color Constant</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_1d_plot& set_legend_background_color(const svg_color &col)</code></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& set_legend_border_color(svg_color_constant col)</code></td>
-<td>Set the border color for
- the legend as <code class="computeroutput">col</code>, a
- SVG Color Constant</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_1d_plot& set_legend_border_color(const svg_color &col)</code></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& set_background_border_color(svg_color_constant col)</code></td>
-<td>Set the background border
- color for the legend as <code class="computeroutput">col</code>,
- a SVG Color Constant</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_1d_plot& set_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& set_plot_background_color(svg_color_constant col)</code></td>
-<td>Set the color of the plot
- area. Note: this only goes into effect if set_plot_area(true) has been
- called</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_1d_plot& set_plot_background_color(const svg_color &col)</code></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 set_plot_area(true) has been
- called</td>
+ area. Note: this only goes into effect if plot_area(true) has been called</td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_x_axis_color(svg_color_constant col)</code></td>
-<td>Sets the color of the
- lines that form the axis</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& set_x_axis_color(const svg_color &col)</code></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& set_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& set_x_label_color(svg_color_constant col)</code></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& set_x_major_tick_color(svg_color_constant 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& set_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& set_x_major_grid_color(svg_color_constant col)</code></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& set_x_major_grid_color(const svg_color &col)</code></td>
+<td><code class="computeroutput">svg_1d_plot& x_major_tick_color(const svg_color &col)</code></td>
<td>Sets the color of the
- grid that runs perpindicular to the X axis</td>
+ major ticks of the x-axis</td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_x_minor_tick_color(svg_color_constant col)</code></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 ticks of the x-axis</td>
+ minor grid of the x-axis</td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_x_minor_tick_color(const svg_color &col)</code></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>
@@ -288,7 +231,7 @@
</div>
<div class="informaltable">
<h4>
-<a name="id338149"></a>
+<a name="id341018"></a>
 Axis Information
 </h4>
<table class="table">
@@ -302,54 +245,49 @@
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_x_axis_width(unsigned int)</code></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& set_x_label(const std::string&)</code></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">set_x_label(true)</code>
+ <code class="computeroutput">x_label_on(true)</code>
 for that guarantee</td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_x_major_tick(double)</code></td>
+<td><code class="computeroutput">svg_1d_plot& x_major_tick(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& set_x_major_tick_length(int)</code></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& set_x_major_tick_width(unsigned int)</code></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& set_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_1d_plot& set_x_major_tick_length(int)</code></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 minor tick lengths</td>
</tr>
<tr>
-<td><code class="computeroutput">svg_1d_plot& set_x_minor_tick_width(unsigned int)</code></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& set_x_num_minor_ticks(int)</code></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& set_x_scale(double x1, double x2)</code></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>
@@ -357,9 +295,177 @@
</tbody>
</table>
</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>

- (Note: Getters omitted for now)
- 
+ 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="id341537"></a>
+ Required parameter
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<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>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="informaltable">
+<h4>
+<a name="id341615"></a>
+ Deduced parameter
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<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>
+</tr></tbody>
+</table>
+</div>
+<div class="informaltable">
+<h4>
+<a name="id341678"></a>
+ Optional Parameters
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<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>_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
+{
+ typdef double result_type;
+
+ double operator()(const human& _hum)
+ {
+ return (double)(_hum.age());
+ }
+}
+
+// snip
+
+plot(my_plot, my_data, "Lions", _functor = my_functor());
+</pre>
+ </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>
+</tr>
+</tbody>
+</table>
+</div>
+
+ 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="id342048"></a>
+ Using fill and stroke colors
+ </h3>
+<pre class="programlisting">
+my_plot.plot(my_data, "Lions",
+_fill_color = red,
+_stroke_color = black);
+</pre>
+
+ This has the same effect as the following:
+ 
+<pre class="programlisting">
+my_plot.plot(my_data, "Lions", red, black);
+</pre>
+
+ and also the same effect as:
+ 
+<pre class="programlisting">
+my_plot.plot(my_data, "Lions",
+_stroke_color = black,
+_fill_color = red);
+</pre>
+
+ Since _fill_color is a deduced parameter, when two svg_colors are used in
+ the same function call, they are always inferred in the following order:
+ (fill, stroke).
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>

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-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -7,6 +7,7 @@
<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="next" href="acknowledgements.html" title=" Acknowledgements">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
@@ -19,14 +20,16 @@
</table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="svg_1d_plot_interface.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="p" href="svg_1d_plot_interface.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="acknowledgements.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.svg_2d_plot_interface"></a> <code class="computeroutput">svg_2d_plot</code> Public Interface</h2></div></div></div>
+<div class="toc"><dl><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></dl></div>
<div class="informaltable">
<h4>
-<a name="id338696"></a>
+<a name="id342327"></a>
 Misc
 </h4>
<table class="table">
@@ -40,41 +43,27 @@
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput"> void plot_range(std::vector<double>::const_iterator begin, std::vector<double>::const_iterator end, std::string text)</code></td>
-<td>Plots a vector<double>
- from begin() to end(). It adds the text <code class="computeroutput">text</code>
- to the legend. If you are looking for the generic version, you can find
- it below.</td>
-</tr>
-<tr>
-<td><code class="computeroutput"> void plot_range(std::vector<double>::const_iterator begin, std::vector<double>::const_iterator end, std::string text, svg_color_constant col)</code></td>
-<td>Plots
- a vector<double> from begin() to end(). It adds the text <code class="computeroutput">text</code> to the legend. The point color
- for this series is going to be <code class="computeroutput">col</code>.
- If you are looking for the generic version, you can find it below.</td>
-</tr>
-<tr>
<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& set_image_size(unsigned int, unsigned int)</code></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& set_title(const std::string&)</code></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& set_title_font_size(unsigned int)</code></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& set_legend_title_font_size(unsigned int)</code></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>
@@ -83,7 +72,7 @@
</div>
<div class="informaltable">
<h4>
-<a name="id339288"></a>
+<a name="id342593"></a>
 Commands
 </h4>
<table class="table">
@@ -97,63 +86,63 @@
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_2d_plot& set_axis_on(bool)</code></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& set_legend_on(bool)</code></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& set_plot_window_on(bool)</code></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& set_title_on(bool)</code></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& set_x_label_on(bool)</code></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& set_x_major_grid_on(bool)</code></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& set_x_major_labels_on(bool)</code></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& set_x_minor_grid_on(bool)</code></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& set_y_label_on(bool)</code></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& set_y_major_grid_on(bool)</code></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& set_y_major_labels_on(bool)</code></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& set_y_minor_grid_on(bool)</code></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>
@@ -162,7 +151,7 @@
</div>
<div class="informaltable">
<h4>
-<a name="id339809"></a>
+<a name="id343114"></a>
 Color Information
 </h4>
<table class="table">
@@ -176,168 +165,84 @@
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_2d_plot& set_title_color(svg_color_constant col)</code></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& set_title_color(const svg_color &col)</code></td>
-<td>Set the title color</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_2d_plot& set_background_color(svg_color_constant col)</code></td>
-<td>Set the background color
- for the whole image</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_2d_plot& set_background_color(const svg_color &col)</code></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& set_legend_background_color(svg_color_constant col)</code></td>
-<td>Set the background color
- for the legend as <code class="computeroutput">col</code>,
- a SVG Color Constant</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_2d_plot& set_legend_background_color(const svg_color &col)</code></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& set_legend_border_color(svg_color_constant col)</code></td>
-<td>Set the border color for
- the legend as <code class="computeroutput">col</code>, a
- SVG Color Constant</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_2d_plot& set_legend_border_color(const svg_color &col)</code></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& set_background_border_color(svg_color_constant col)</code></td>
-<td>Set the background border
- color for the legend as <code class="computeroutput">col</code>,
- a SVG Color Constant</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_2d_plot& set_background_border_color(const svg_color &col)</code></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& set_plot_background_color(svg_color_constant col)</code></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 set_plot_area(true) has been
- called</td>
+ area. Note: this only goes into effect if plot_area(true) has been called</td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& set_plot_background_color(const svg_color &col)</code></td>
-<td>Set the color of the plot
- area. Note: this only goes into effect if set_plot_area(true) has been
- called</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_2d_plot& set_x_axis_color(svg_color_constant col)</code></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& set_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& set_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& set_x_label_color(svg_color_constant col)</code></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& set_x_major_tick_color(svg_color_constant 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& set_x_major_tick_color(const svg_color &col)</code></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& set_x_major_grid_color(svg_color_constant 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& set_x_major_grid_color(const svg_color &col)</code></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& set_x_minor_tick_color(svg_color_constant 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& set_x_minor_tick_color(const svg_color &col)</code></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& set_y_axis_color(svg_color_constant col)</code></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& set_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& set_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& set_y_label_color(svg_color_constant col)</code></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& set_y_major_tick_color(svg_color_constant col)</code></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& set_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& set_y_major_grid_color(svg_color_constant col)</code></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& set_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& set_y_minor_tick_color(svg_color_constant col)</code></td>
-<td>Sets the color of the
- minor ticks of the Y-axis</td>
-</tr>
-<tr>
-<td><code class="computeroutput">svg_2d_plot& set_y_minor_tick_color(const svg_color &col)</code></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>
@@ -346,7 +251,7 @@
</div>
<div class="informaltable">
<h4>
-<a name="id341545"></a>
+<a name="id344086"></a>
 Axis Information
 </h4>
<table class="table">
@@ -360,107 +265,107 @@
</tr></thead>
<tbody>
<tr>
-<td><code class="computeroutput">svg_2d_plot& set_x_axis_width(unsigned int)</code></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& set_x_label(const std::string&)</code></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">set_x_label(true)</code>
+ <code class="computeroutput">x_label(true)</code>
 for that guarantee</td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& set_x_major_tick(double)</code></td>
+<td><code class="computeroutput">svg_2d_plot& x_major_tick(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& set_x_major_tick_length(int)</code></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& set_x_major_tick_width(unsigned int)</code></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& set_x_minor_tick(unsigned int)</code></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& set_x_major_tick_length(int)</code></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 minor tick lengths</td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& set_x_minor_tick_width(unsigned int)</code></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& set_x_num_minor_ticks(int)</code></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& set_x_scale(double x1, double x2)</code></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& set_y_axis_width(unsigned int)</code></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& set_y_label(const std::string&)</code></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">set_x_label(true)</code>
+ <code class="computeroutput">x_label(true)</code>
 for that guarantee</td>
</tr>
<tr>
-<td><code class="computeroutput">svg_2d_plot& set_y_major_tick(double)</code></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& set_y_major_tick_length(int)</code></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& set_y_major_tick_width(unsigned int)</code></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& set_y_minor_tick(unsigned int)</code></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& set_y_major_tick_length(int)</code></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& set_y_minor_tick_width(unsigned int)</code></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& set_y_num_minor_ticks(int)</code></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& set_y_scale(double y1, double y2)</code></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>
@@ -471,6 +376,204 @@

 (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>
+
+ 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="id345141"></a>
+ Required parameter
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<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>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="informaltable">
+<h4>
+<a name="id345219"></a>
+ Deduced parameter
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<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>
+</tr></tbody>
+</table>
+</div>
+<div class="informaltable">
+<h4>
+<a name="id345282"></a>
+ Optional Parameters
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>ID</th>
+<th>Type</th>
+<th>Description</th>
+<th>Default</th>
+</tr></thead>
+<tbody>
+<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>
+</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>
+</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 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>_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
+{
+ typdef pair<double, double> result_type;
+ static double i = 0;
+
+ pair<double, double> operator()(const human& _hum)
+ {
+ i+=1.;
+ return pair<double, double>(i, _hum.age());
+ }
+}
+
+// snip
+
+plot(my_plot, my_data, "Lions", _x_functor = my_functor());
+</pre>
+ </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>
+</tr>
+</tbody>
+</table>
+</div>
+
+ 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="id345861"></a>
+ Using fill and stroke colors
+ </h3>
+<pre class="programlisting">
+my_plot.(my_data, "Lions",
+_fill_color = red,
+_stroke_color = black);
+</pre>
+
+ This has the same effect as the following:
+ 
+<pre class="programlisting">
+my_plot.plot(my_data, "Lions", red, black);
+</pre>
+
+ and also the same effect as:
+ 
+<pre class="programlisting">
+my_plot.plot(my_data, "Lions",
+_stroke_color = black,
+_fill_color = red);
+</pre>
+
+ Since _fill_color is a deduced parameter, when two svg_colors are used in
+ the same function call, they are always inferred in the following order:
+ (fill, stroke).
+ 
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -478,7 +581,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="svg_1d_plot_interface.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="p" href="svg_1d_plot_interface.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="acknowledgements.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_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-07-28 14:12:16 EDT (Sat, 28 Jul 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="tutorial.html" title=" Tutorial">
+<link rel="prev" href="plot_defaults.html" title=" Defaults">
<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">
@@ -20,14 +20,14 @@
</table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="tutorial.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_1d_plot_interface.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="plot_defaults.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_1d_plot_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.svg_interface"></a> SVG Public Interface</h2></div></div></div>
<div class="informaltable">
<h4>
-<a name="id334891"></a>
+<a name="id338379"></a>
 class svg
 </h4>
<table class="table">
@@ -49,60 +49,73 @@
 default image size is (400, 400)</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>
+<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">svg& get_x_size()</code></td>
+<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">svg& get_y_size()</code></td>
+<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& 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><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& 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 defaul
- as any other.</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">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>
+<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();
+
+my_path.M(3, 3).l(150, 150);
+</pre>
+ 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><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>
@@ -110,30 +123,24 @@
<td> </td>
</tr>
<tr>
-<td><code class="computeroutput">svg& clip_path(const rect_element&, g_element&, const std::string& id)</code></td>
-<td>Prevents
- the g_element in the argument from drawing outside of the rectangle in
- the argument. The string is provided to identify the clip.</td>
-<td>Currently
- unsupported</td>
+<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">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>
+<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">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>.
- This will be addressed</td>
+<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>
@@ -145,7 +152,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="tutorial.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_1d_plot_interface.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="plot_defaults.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_1d_plot_interface.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/todo.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/todo.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,86 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> To Do List</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="../index.html" title="SVG_Plot">
+<link rel="next" href="color.html" title=" Colors">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.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="color.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.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
+ before you email me with requests.
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Allow an external stylesheet to be loaded
+ to style the graph. External stylesheets will allow a standard and easy way
+ to style the document so that users don't have to come up with their own
+ home-grown solutions.
+ </li>
+<li>
+ Allow function pointers to specify functions
+ as input. A use case where the user wants to just see what <code class="literal">sin(x)</code>
+ looks like is easily imaginable.
+ </li>
+<li>
+Radian coordinate system.
+ </li>
+<li>
+ Implementation of SVG's DOM. This will make
+ the SVG class useful.
+ </li>
+<li>
+ Allow other image formats. This is certainly
+ an after-GSoC project, as there are many inherent difficulties with this
+ part. The solution that I am currently playing with is allowing the user
+ to pass a functor that traverses the document tree. Generalizing images to
+ an <code class="computeroutput">image</code> class is fraught
+ with difficulties, as SVG is a tree-based format, which it does not share
+ with many other formats. When I come up with what I feel is a minimal-intervention
+ method of doing this, I will begin a discussion on the Boost dev list.
+ </li>
+<li>
+Avoid redrawing the entire plot each time.
+ This is the easiest way to write the program initially, but it would be more
+ efficient if the program could keep track of what has been changed and what
+ hasn't, so that it may be more efficient if lots of images are being produced.
+ </li>
+<li>Logarithmic Axis</li>
+<li>
+Clipping of the plot window, so that graph
+ lines do not get drawn outside of the plot.
+ </li>
+<li>Histogram</li>
+<li>Box-and-whisker</li>
+</ul></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.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="color.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -26,179 +26,139 @@
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="svg_plot.tutorial"></a> Tutorial</h2></div></div></div>
<div class="toc"><dl>
-<dt> Basic Example</dt>
+<dt> Simple program</dt>
+<dt> A note on syntax</dt>
+<dt> Basic Example Breakdown</dt>
<dt> Using a Plot Window</dt>
<dt> Full Layout Example</dt>
-<dt> Color Customization</dt>
-<dt> svg_1d_plot Defaults</dt>
+<dt> svg_1d_plot Defaults</dt>
<dt> Getting More Out Of The plot() Function</dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.tutorial.tutorial_basic"></a> Basic Example</h3></div></div></div>
-<div class="toc"><dl>
-<dt> Simple program</dt>
-<dt> Basic Example Breakdown</dt>
-</dl></div>
-
- The minimal requirements for creating any image are as follows.
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- You need a one or two dimensional svg_plot
- </li>
-<li>
- You need to call the write() command
- </li>
-</ul></div>
-
- That's it! However, just doing this won't give you anything useful. The following
- can be considered a minimal example:
- 
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="svg_plot.tutorial.tutorial_basic.tutorial_code_simple"></a> Simple program</h4></div></div></div>
-
-
-
+<a name="svg_plot.tutorial.tutorial_code_simple"></a> Simple program</h3></div></div></div>
<pre class="programlisting">
-#include <boost/svg_plot/svg_1d_plot.hpp>
-#include <vector>
+#include <boost/svg_plot/svg_1d_plot.hpp>
+#include <vector>

-using std::vector;
-using namespace boost::svg_plot;
+using std::vector;
+using namespace boost::svg;

-int main()
+int main()
{
- // Snip
-
- vector<double> my_data;
+ vector<double> dan_times;
+ vector<double> elaine_times;

- // initialize my_data here
-
- svg_1d_plot my_plot;
+ dan_times.push_back(3.1);
+ dan_times.push_back(4.2);
+ elaine_times.push_back(2.1);
+ elaine_times.push_back(7.8);

- my_plot.set_title("My Graph")
- .set_legend_on(true)
- .set_x_range(-1, 11);
-
- plot(my_plot, my_data, "Race times");
+ svg_1d_plot my_plot;
+
+ my_plot.title("Race Times")
+ .legend_on(true)
+ .x_range(-1, 11);
+
+ my_plot.plot(dan_times, "Dan", blue);
+ my_plot.plot(elaine_times, "Elaine", orange);

- my_plot.write("my_file.svg");
- return 0;
+ my_plot.write("simple.svg");
+ return 0;
}
-umber#>69</phrase><phrase </pre>
+</pre>

- 
-
- <img src="../my_file.svg" alt="my_file">
- 
+ <img src="../images/simple.png" alt="simple">
+ 
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="svg_plot.tutorial.tutorial_basic.tutorial_simple_exam"></a> Basic Example Breakdown</h4></div></div></div>
-
- Let's examine what this does.
- 
-
-
-
-<pre class="programlisting">
-svg_1d_plot my_plot;
-s </pre>
-
- initializes a new 1D plot. This also sets many of the values that the class
- keeps track of with reasonable defaults.
- 
-
-
-
-<pre class="programlisting">
-my_plot.set_title("My Graph")
- .set_legend_on(true)
- .set_x_range(-1, 11);
-####</pre>
-
- 
-
- All of the set methods are fairly self explanatory. The title, which will
- appear at the top of the graph, will say "My Graph". <code class="computeroutput">set_legend_on(true)</code> means
- that the legend will show up. <code class="computeroutput">set_x_range(-1, 11)</code> means
- that the range of values that will be printed is between -1 and 11, as
- you can see in the above images.
- 
+<div class="titlepage"><div><div><h3 class="title">
+<a name="svg_plot.tutorial.tutorial_syntax_explanation"></a> A note on syntax</h3></div></div></div>

- This syntax may be unfamiliar. However, it works on the same principle
- that the following code works:
-
+ 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
+ operator, addition operator, and output operator in the following code works:
+ 
<pre class="programlisting">
-a = b = c = d = 3;
-#*</pre>
-
- 
+a = b = c = d = 3;
+
+//prints 12
+std::cout << a + b + c + d << std::endl;
+</pre>

- You have also seen it used to print to the console:
-
+ Within all of the plot classes, "chaining" works the same way.
+ The equivalent code for the example is as follows:
+ 
<pre class="programlisting">
-std::cout << "Hello" << name << std::endl;
-##</pre>
-
- 
+my_plot.title("Race Times");
+my_plot.legend_on(true);
+my_plot.x_range(-1, 11);
+</pre>

- Within all of the plot classes, chaining works the same way. The equivalent
- code for the above is as follows:
- 
+ In the long run, I think you will find that my choice helps organize the
+ code a little better!
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="svg_plot.tutorial.tutorial_simple_exam"></a> Basic Example Breakdown</h3></div></div></div>

-
-
+ Let's examine what this does.
+ 
<pre class="programlisting">
-my_plot.set_title("My Graph");
-my_plot.set_legend_on(true);
-my_plot.set_x_range(-1, 11);
-bove</pre>
-
- 
-
- In the long run, I think you will find that my choice helps organize the
- code a little better!
- 
+svg_1d_plot my_plot;
+</pre>

-
-
+ This initializes a new 1D plot. This also sets many of the default values.
+ 
<pre class="programlisting">
-plot(my_plot, my_data, "Race times");
-dP</pre>
-
- 
+my_plot.title("Race Times")
+ .legend_on(true)
+ .x_range(-1, 11);
+</pre>

- This draws <code class="computeroutput">my_data</code> to
- <code class="computeroutput">my_plot</code>. As many containers
- as you want can be drawn to my_plot. The name of the series is "Race
- times", and that text will show up in the legend. These are the three
- required parameters for this function call. There are optional parameters,
- as seen in the section Getting More Out Of The <code class="computeroutput">plot()</code> Function, but most immediately beneficial
- would be the ability to specify a color for your data point:
-
+ All of the setter methods are fairly self-explanatory. To walk through it
+ once,
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ the title, which will appear at the top of the graph, will say "Race
+ Times".
+ </li>
+<li>
+<code class="computeroutput">legend_on(true)</code> means
+ that the legend will show up.
+ </li>
+<li>
+<code class="computeroutput">x_scale(-1, 11)</code> means
+ that the axis displayed will be between -1 and 11, as you can see in the
+ above images.
+ </li>
+</ul></div>
<pre class="programlisting">
-plot(my_plot, my_data, "Race Times", blue);
-##</pre>
+my_plot.plot(my_data, "Race times");
+</pre>

- 
+ This draws <code class="computeroutput">my_data</code> to <code class="computeroutput">my_plot</code>. As many containers as you want
+ can be drawn to <code class="computeroutput">my_plot</code>.
+ The name of the series is "Race times", and that text will show
+ up in the legend. These are the two required parameters for this function
+ call. There are optional parameters, as seen in the section
+ 

- is how you could accomplish this
- 
+ Getting More Out of the plot() Function
+ 

-
+

<pre class="programlisting">
-my_plot.write("my_file.svg");
-s#</pre>
+my_plot.write("simple.svg");
+</pre>

- 
+ 

- This writes our plot to the file "my_file.svg".
- 
-</div>
+ This writes our plot to the file "simple.svg".
+ 
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
@@ -208,170 +168,156 @@
 different choice for layout, you can opt to use a <code class="literal">plot window</code>.
 To add it to a simple example:
 
-
-
-
<pre class="programlisting">
-#include <boost/svg_plot/svg_1d_plot.hpp>
-#include <vector>
+#include <boost/svg_plot/svg_1d_plot.hpp>
+#include <vector>

-using std::vector;
-using namespace boost::svg_plot;
+using std::vector;
+using namespace boost::svg;

-// Snip
-
-vector<double> my_data;
+int main()
+{
+ vector<double> dan_times;
+ vector<double> elaine_times;
+
+ dan_times.push_back(3.1);
+ dan_times.push_back(4.2);
+ elaine_times.push_back(2.1);
+ elaine_times.push_back(7.8);

-// initialize my_data here
+ // initialize my_data here

-svg_1d_plot my_plot;
+ svg_1d_plot my_plot;

-my_plot.set_title("My Graph")
- .set_legend_on(true)
- .set_plot_window_on(true)
- .set_x_range(-1, 11);
+ my_plot.title("My Graph")
+ .legend_on(true)
+ .x_range(-1, 11)
+ .plot_window_on(true);

-plot(my_plot, my_data, "Race times");
+ my_plot.plot(dan_times, "Dan", blue);
+ my_plot.plot(elaine_times, "Elaine", orange);

-my_plot.write("my_file.svg");
-####)(l#*###)(l#*######</pre>
+ my_plot.write("plot_window.svg");
+ return 0;
+}
+</pre>

+ This produces the following image:
 

- This produces the following image: (insert image)
+ <img src="../images/plot_window.png" alt="plot_window">
 
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="svg_plot.tutorial.full_layout"></a> Full Layout Example</h3></div></div></div>

- Boost.SVG_Plot is designed to avoid having to do much customization. However,
- it is by no means a "one size fits all" solution. As such, there
- is much that can be changed in the way of layout and design. An example follows:
+ Here is an example using full customization:
 
-
-
-
<pre class="programlisting">
-svg_1d_plot my_plot;
+#include <boost/svg_plot/svg_1d_plot.hpp>
+#include <vector>
+#include <deque>
+#include <cmath>
+#include <boost/array.hpp>

-// misc data
-my_plot.set_image_size(500, 350)
- .set_title("Race Results")
- .set_title_font_size(20);
-
-// display commands
-my_plot.set_x_label_on(true)
- .set_x_major_labels_on(true)
- .set_x_major_grid_on(true)
- .set_x_minor_grid_on(true)
- .set_axis_on(true)
- .set_legend_on(true)
- .set_plot_window_on(true)
- .set_title_on(true);
-
-// axis information
-my_plot.set_x_axis_width(2)
- .set_x_label("Time in minutes")
- .set_x_major_tick(5)
- .set_x_num_minor_ticks(1)
- .set_x_scale(-5, 130);
-
-// plot the information
-plot(my_plot, ron_result, "Ron", orange);
-plot(my_plot, sally_result, "Sally", red);
-plot(my_plot, tim_result, "Tim", blue);
+using std::vector;
+using std::deque;
+using namespace boost::svg;

-my_plot.write("race_results.svg");
-> <phrase role="identifier">my_</pre>
-
- 
-
- This produces the following image: (insert image)
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.tutorial.color"></a> Color Customization</h3></div></div></div>
-
- The <code class="literal">svg_plot</code> classes support two major ways to define
- colors. One is the use of colors in the RGB format. To specify a color in
- the RGB format, you can use the following: <code class="computeroutput">svg_color(123, 73, 255)</code>, to pick a random example.
- 
+double f(double x)
+{
+ return sqrt(x);
+}
+
+double g(double x)
+{
+ return -2 + x*x;
+}
+
+double h(double x)
+{
+ return -1 + 2*x;
+}
+
+int main()
+{
+ vector<double> data1;
+ deque<double> data2;
+ boost::array<double, 10> data3;
+
+ int j=0;
+ for(double i=0; i<9.5; i+=1.)
+ {
+ data1.push_back(f(i));
+ data2.push_front(g(i));
+ data3[j++] = h(i);
+ }
+
+ svg_1d_plot my_plot;
+
+ // Size/scale settings.
+ my_plot.image_size(500, 350)
+ .x_range(-3, 10);
+
+ // Text settings.
+ my_plot.title("Oh My!")
+ .title_font_size(29)
+ .x_label("Time in Months");
+
+ // Commands.
+ my_plot.legend_on(true)
+ .plot_window_on(true)
+ .x_label_on(true)
+ .x_major_labels_on(true);
+
+ // color settings
+ my_plot.background_color(svg_color(67, 111, 69))
+ .legend_background_color(svg_color(207, 202,167))
+ .legend_border_color(svg_color(102, 102, 84))
+ .plot_background_color(svg_color(136, 188, 126))
+ .title_color(white);
+
+ //axis settings
+ my_plot.x_major_tick(2)
+ .x_major_tick_length(14)
+ .x_major_tick_width(1)
+ .x_minor_tick_length(7)
+ .x_minor_tick_width(1)
+ .x_num_minor_ticks(3);
+
+ //legend settings
+ my_plot.legend_title_font_size(15);
+
+ my_plot.plot(data1, "Lions", blue);
+ my_plot.plot(data2, "Tigers", orange);
+ my_plot.plot(data3, "Bears", red);
+
+ my_plot.write("1d_complex.svg");
+
+ return 0;
+}
+</pre>

- The other way to define a color is to use the SVG standard's custom color
- definitions, as defined here
+ This produces the following output:
 

- Here is an example using color customization:
+ <img src="../images/1d_complex.png" alt="1d_complex">
 

-
-
-<pre class="programlisting">
-vector<double> data1;
-deque<double> data2;
-boost::array<double, 10> data3;
-
-svg_1d_plot my_plot;
-
-// size/scale settings
-my_plot.set_image_size(500, 350)
- .set_x_scale(-3, 10);
-
-// Text settings
-my_plot.set_title("Oh My!")
- .set_title_font_size(29)
- .set_x_label_text("Time in Months");
-
-// command settings
-my_plot.set_axis(true)
- .set_legend(true)
- .set_plot_window(true)
- .set_x_label(true)
- .set_x_major_labels(true);
-
-// color settings
-my_plot.set_background_color(svg_color(67, 111, 69))
- .set_legend_background_color(svg_color(207, 202,167))
- .set_plot_background_color(svg_color(136, 188, 126))
- .set_title_color(white)
- .set_x_axis_color(black)
- .set_x_major_tick_color(black)
- .set_legend_border_color(svg_color(102, 102, 84))
- .set_x_minor_tick_color(black);
-
-//axis settings
-my_plot.set_x_major_tick(2)
- .set_x_num_minor_ticks(3)
- .set_x_major_tick_length(14)
- .set_x_minor_tick_length(7)
- .set_x_major_tick_width(1)
- .set_x_minor_tick_width(1);
-
-//legend settings
-my_plot.set_legend_title_font_size(15);
-
-plot_range(my_plot, data2.begin(), data2.end(), "Lions", blue);
-plot_range(my_plot, data1.begin(), data1.end(), "Tigers", purple);
-plot_range(my_plot, data3.begin(), data3.end(), "Bears", red);
-
-my_plot.write("D:/1d_complex.svg");
-ntifier">set_title</phrase><phrase role="spec</pre>
-
- This produces the following output: (Insert image)
+ A little bit of color customization goes a long way!
 
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="svg_plot.tutorial.defaults"></a> <code class="computeroutput">svg_1d_plot</code> Defaults</h3></div></div></div>
+<a name="svg_plot.tutorial.1d_defaults"></a> <code class="computeroutput">svg_1d_plot</code> Defaults</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="id333537"></a>
+<a name="id334025"></a>
 Default Values]
 </h4>
<table class="table">
@@ -390,7 +336,7 @@
<td>Axis</td>
<td>On</td>
<td>Most graphs include an axis
- of some kindl</td>
+ of some kind</td>
</tr>
<tr>
<td>Distance between major X ticks</td>
@@ -536,7 +482,7 @@
 
<div class="informaltable">
<h4>
-<a name="id333992"></a>
+<a name="id334479"></a>
 Deduced parameter
 </h4>
<table class="table">
@@ -560,7 +506,7 @@
</div>
<div class="informaltable">
<h4>
-<a name="id334043"></a>
+<a name="id334530"></a>
 Optional Parameters
 </h4>
<table class="table">
@@ -601,6 +547,7 @@
 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">
+[c++]
class my_functor
{
 typdef double result_type;
@@ -614,7 +561,7 @@
// snip

plot(my_plot, my_data, "Lions", _x_functor = my_functor());
-ow><entry>Imag</pre>
+</pre>
 </td>
<td> <code class="computeroutput">boost_default_convert</code>
 is sufficient in all cases where the data stored in the container can
@@ -627,15 +574,16 @@
 Here are some examples of correct uses:
 
<a name="svg_plot.tutorial.plot_function.using_fill_and_stroke_colors"></a><h3>
-<a name="id334385"></a>
+<a name="id334863"></a>
 Using fill and stroke colors
 </h3>



<pre class="programlisting">
+[c++]
plot(my_plot, my_data, "Lions", _fill_color = svg_color(red), _stroke_color = svg_color(black));
-ip</pre>
+</pre>

 

@@ -645,16 +593,18 @@


<pre class="programlisting">
+[c++]
plot(my_plot, my_data, "Lions", svg_color(red), svg_color(black));
-#*</pre>
+</pre>

 

 and also the same effect as:

<pre class="programlisting">
+[c++]
plot(my_plot, my_data, "Lions", _stroke_color = svg_color(black), _fill_color = svg_color(red));
-l#</pre>
+</pre>

 

@@ -663,18 +613,19 @@
 (fill, stroke).
 
<a name="svg_plot.tutorial.plot_function.using_all_parameters"></a><h3>
-<a name="id334729"></a>
+<a name="id335236"></a>
 Using all parameters
 </h3>



<pre class="programlisting">
+[c++]
plot(my_plot, my_data, "Lions",
 _fill_color = svg_color(red),
 _stroke_color = svg_color(black),
 _x_functor = my_functor());
-(fill</pre>
+</pre>

 
</div>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,149 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<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">
+<link rel="up" href="../index.html" title="SVG_Plot">
+<link rel="prev" href="1d_special.html" title=" Tutorial: 1D Special Features">
+<link rel="next" href="full_2d_layout.html" title=" Tutorial: Full Layout Example">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="1d_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="full_2d_layout.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.tutorial_2d_code_simple"></a> Tutorial: Simple 2D Program</h2></div></div></div>
+<div class="toc"><dl>
+<dt> Simple Code Example</dt>
+<dt> Simple Image</dt>
+<dt> Basic Example Breakdown</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>
+<pre class="programlisting">
+#include <boost/svg_plot/svg_2d_plot.hpp>
+#include <vector>
+
+using std::multimap;
+using namespace boost::svg;
+
+int main()
+{
+ multimap<double, double> map1;
+ multimap<double, double> map2;
+
+ // This is random data used purely for example purposes.
+ map1[1.] = 3.2;
+ map1[1.] = 5.4;
+ map1[7.3] = 9.1;
+
+ map2[3.1] = 6.1;
+ map2[5.4] = 7.;
+
+ svg_1d_plot my_plot;
+
+ my_plot.title("Race Times")
+ .legend_on(true)
+ .x_range(-1, 11)
+ .background_border_color(black);
+
+ my_plot.plot(map1, "Series 1", blue);
+ my_plot.plot(map2, "Series 2", orange);
+
+ my_plot.write("simple_2d.svg");
+ return 0;
+}
+</pre>
+</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>
+
+ <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>
+
+ Let's examine what this does.
+ 
+<pre class="programlisting">
+svg_2d_plot my_plot;
+</pre>
+
+ This initializes a new 2D plot. This also sets many of the default values.
+ 
+<pre class="programlisting">
+my_plot.title("Race Times")
+ .legend_on(true)
+ .x_range(-1, 11)
+ .background_border_color(black);
+</pre>
+
+ All of the setter methods are fairly self-explanatory. To walk through it
+ once,
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ the title, which will appear at the top of the graph, will say "Race
+ Times".
+ </li>
+<li>
+<code class="computeroutput">legend_on(true)</code> means
+ 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.
+ </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
+ color of the background.
+ </li>
+</ul></div>
+<pre class="programlisting">
+my_plot.plot(map1, "Series 1", blue);
+my_plot.plot(map2, "Series 2", orange);
+</pre>
+
+ This draws <code class="computeroutput">map1</code> and <code class="computeroutput">map2</code> to <code class="computeroutput">my_plot</code>.
+ As many containers as you want can be drawn to <code class="computeroutput">my_plot</code>.
+ After a certain point, however, I recommend just creating another plot! The
+ name of the series is <code class="computeroutput">"Race times"</code>,
+ and that text will show up in the legend. These are the two required parameters
+ for this function call. There are optional parameters, as seen in the section
+ Getting More Out of the plot() Function
+ 
+<pre class="programlisting">
+my_plot.write("simple_2d.svg");
+</pre>
+
+ This writes our plot to the file "simple_2d.svg".
+ 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="1d_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="full_2d_layout.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,171 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<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">
+<link rel="up" href="../index.html" title="SVG_Plot">
+<link rel="prev" href="color.html" title=" Colors">
+<link rel="next" href="full_1d_layout.html" title=" Tutorial: 1D Full Layout Example">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="color.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="full_1d_layout.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.tutorial_code_1d_simple"></a> Tutorial: 1D Simple Program</h2></div></div></div>
+<div class="toc"><dl>
+<dt> Code Example</dt>
+<dt> Image</dt>
+<dt> A note on syntax</dt>
+<dt> Basic Example Breakdown</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>
+<pre class="programlisting">
+#include <boost/svg_plot/svg_1d_plot.hpp>
+#include <vector>
+
+using std::vector;
+using namespace boost::svg;
+
+int main()
+{
+ vector<double> dan_times;
+ vector<double> elaine_times;
+
+ dan_times.push_back(3.1);
+ dan_times.push_back(4.2);
+ elaine_times.push_back(2.1);
+ elaine_times.push_back(7.8);
+
+ svg_1d_plot my_plot;
+
+ my_plot.title("Race Times")
+ .legend_on(true)
+ .x_range(-1, 11);
+
+ my_plot.plot(dan_times, "Dan", blue);
+ my_plot.plot(elaine_times, "Elaine", orange);
+
+ my_plot.write("simple.svg");
+ return 0;
+}
+</pre>
+</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>
+
+ <img src="../images/simple.png" alt="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>
+
+ 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
+ operator, addition operator, and output operator in the following code works:
+ 
+<pre class="programlisting">
+a = b = c = d = 3;
+
+//prints 12
+std::cout << a + b + c + d << std::endl;
+</pre>
+
+ Within all of the plot classes, "chaining" works the same way.
+ The equivalent code for the example is as follows:
+ 
+<pre class="programlisting">
+my_plot.title("Race Times");
+my_plot.legend_on(true);
+my_plot.x_range(-1, 11);
+</pre>
+
+ In the long run, I think you will find that my choice helps organize the
+ code a little better!
+ 
+</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>
+
+ Let's examine what this does.
+ 
+<pre class="programlisting">
+svg_1d_plot my_plot;
+</pre>
+
+ This initializes a new 1D plot. This also sets many of the default values.
+ 
+<pre class="programlisting">
+my_plot.title("Race Times")
+ .legend_on(true)
+ .x_range(-1, 11);
+</pre>
+
+ All of the setter methods are fairly self-explanatory. To walk through it
+ once,
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ the title, which will appear at the top of the graph, will say "Race
+ Times".
+ </li>
+<li>
+<code class="computeroutput">legend_on(true)</code> means
+ 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.
+ </li>
+</ul></div>
+<pre class="programlisting">
+my_plot.plot(my_data, "Race times");
+</pre>
+
+ This draws <code class="computeroutput">my_data</code> to <code class="computeroutput">my_plot</code>. As many containers as you want
+ can be drawn to <code class="computeroutput">my_plot</code>.
+ The name of the series is "Race times", and that text will show
+ up in the legend. These are the two required parameters for this function
+ call. There are optional parameters, as seen in the section svg_plot/svg_1d_plot_interface.html
+ 
+
+
+
+<pre class="programlisting">
+my_plot.write("simple.svg");
+</pre>
+
+ 
+
+ This writes our plot to the file "simple.svg".
+ 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="color.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="full_1d_layout.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_simple.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_simple.html 2007-07-28 14:12:16 EDT (Sat, 28 Jul 2007)
@@ -0,0 +1,163 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Tutorial: 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">
+<link rel="up" href="../index.html" title="SVG_Plot">
+<link rel="prev" href="color.html" title=" Colors">
+<link rel="next" href="full_1d_layout.html" title=" Tutorial: Full Layout Example">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="color.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="full_1d_layout.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.tutorial_code_simple"></a> Tutorial: Simple program</h2></div></div></div>
+<div class="toc"><dl>
+<dt> A note on syntax</dt>
+<dt> Basic Example Breakdown</dt>
+</dl></div>
+<pre class="programlisting">
+#include <boost/svg_plot/svg_1d_plot.hpp>
+#include <vector>
+
+using std::vector;
+using namespace boost::svg;
+
+int main()
+{
+ vector<double> dan_times;
+ vector<double> elaine_times;
+
+ dan_times.push_back(3.1);
+ dan_times.push_back(4.2);
+ elaine_times.push_back(2.1);
+ elaine_times.push_back(7.8);
+
+ svg_1d_plot my_plot;
+
+ my_plot.title("Race Times")
+ .legend_on(true)
+ .x_range(-1, 11);
+
+ my_plot.plot(dan_times, "Dan", blue);
+ my_plot.plot(elaine_times, "Elaine", orange);
+
+ my_plot.write("simple.svg");
+ return 0;
+}
+</pre>
+
+ <img src="../images/simple.png" alt="simple">
+ 
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="svg_plot.tutorial_code_simple.tutorial_syntax_explanation"></a> A note on syntax</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
+ operator, addition operator, and output operator in the following code works:
+ 
+<pre class="programlisting">
+a = b = c = d = 3;
+
+//prints 12
+std::cout << a + b + c + d << std::endl;
+</pre>
+
+ Within all of the plot classes, "chaining" works the same way.
+ The equivalent code for the example is as follows:
+ 
+<pre class="programlisting">
+my_plot.title("Race Times");
+my_plot.legend_on(true);
+my_plot.x_range(-1, 11);
+</pre>
+
+ In the long run, I think you will find that my choice helps organize the
+ code a little better!
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="svg_plot.tutorial_code_simple.tutorial_simple_exam"></a> Basic Example Breakdown</h3></div></div></div>
+
+ Let's examine what this does.
+ 
+<pre class="programlisting">
+svg_1d_plot my_plot;
+</pre>
+
+ This initializes a new 1D plot. This also sets many of the default values.
+ 
+<pre class="programlisting">
+my_plot.title("Race Times")
+ .legend_on(true)
+ .x_range(-1, 11);
+</pre>
+
+ All of the setter methods are fairly self-explanatory. To walk through it
+ once,
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ the title, which will appear at the top of the graph, will say "Race
+ Times".
+ </li>
+<li>
+<code class="computeroutput">legend_on(true)</code> means
+ 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.
+ </li>
+</ul></div>
+<pre class="programlisting">
+my_plot.plot(my_data, "Race times");
+</pre>
+
+ This draws <code class="computeroutput">my_data</code> to <code class="computeroutput">my_plot</code>. As many containers as you want
+ can be drawn to <code class="computeroutput">my_plot</code>.
+ The name of the series is "Race times", and that text will show
+ up in the legend. These are the two required parameters for this function
+ call. There are optional parameters, as seen in the section <a href="../plot_function" target="_top">Getting
+ More Out of the <code class="computeroutput">plot()</code>
+ Function</a>
+ 
+
+
+
+<pre class="programlisting">
+my_plot.write("simple.svg");
+</pre>
+
+ 
+
+ This writes our plot to the file "simple.svg".
+ 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right">Copyright © 2007 Jake Voytko</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="color.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="full_1d_layout.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Next message: JakeVoytko_at_[hidden]: "[Boost-commit] svn:boost r7576 - sandbox/SOC/2007/visualization/libs/svg_plot/example"
Previous message: JakeVoytko_at_[hidden]: "[Boost-commit] svn:boost r7574 - sandbox/SOC/2007/visualization/libs/svg_plot/doc"

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