Boost-Commit :

Date view	Thread view	Subject view	Author view

From: jakevoytko_at_[hidden]
Date: 2007-07-22 23:13:46

Next message: asutton_at_[hidden]: "[Boost-commit] svn:boost r7512"
Previous message: huseyinakcan_at_[hidden]: "[Boost-commit] svn:boost r7510"

Author: jakevoytko
Date: 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
New Revision: 7511
URL: http://svn.boost.org/trac/boost/changeset/7511

Log:
Added docs. Code fields have gibberish, and I will investigate why.

Added:
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/HTML.manifest
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/boostbook.css
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/intro.html
   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_2d_plot_interface.html
   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/tutorial.html
Text files modified:
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/Jamfile.v2 | 1
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.qbk | 58 +++++++++++----------------------------
   2 files changed, 17 insertions(+), 42 deletions(-)

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/Jamfile.v2
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/Jamfile.v2 (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/Jamfile.v2 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
@@ -3,6 +3,7 @@
# Distributed under the Boost Software License, Version 1.0.
# (See accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt)
+
project boost/doc ;
import boostbook : boostbook ;

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/HTML.manifest
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/HTML.manifest 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
@@ -0,0 +1,7 @@
+index.html
+svg_plot/intro.html
+svg_plot/color.html
+svg_plot/tutorial.html
+svg_plot/svg_interface.html
+svg_plot/svg_1d_plot_interface.html
+svg_plot/svg_2d_plot_interface.html

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/boostbook.css
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/boostbook.css 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
@@ -0,0 +1,519 @@
+/*=============================================================================
+ Copyright (c) 2004 Joel de Guzman
+ http://spirit.sourceforge.net/
+
+ Distributed under the Boost Software License, Version 1.0. (See accompany-
+ ing file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+=============================================================================*/
+
+/*=============================================================================
+ Body defaults
+=============================================================================*/
+
+ body
+ {
+ margin: 1em;
+ font-family: sans-serif;
+ }
+
+/*=============================================================================
+ Paragraphs
+=============================================================================*/
+
+ p
+ {
+ text-align: left;
+ font-size: 10pt;
+ line-height: 1.15;
+ }
+
+/*=============================================================================
+ Program listings
+=============================================================================*/
+
+ /* Code on paragraphs */
+ p tt.computeroutput
+ {
+ font-size: 9pt;
+ }
+
+ pre.synopsis
+ {
+ font-size: 90%;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ .programlisting,
+ .screen
+ {
+ font-size: 9pt;
+ display: block;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ /* Program listings in tables don't get borders */
+ td .programlisting,
+ td .screen
+ {
+ margin: 0pc 0pc 0pc 0pc;
+ padding: 0pc 0pc 0pc 0pc;
+ }
+
+/*=============================================================================
+ Headings
+=============================================================================*/
+
+ h1, h2, h3, h4, h5, h6
+ {
+ text-align: left;
+ margin: 1em 0em 0.5em 0em;
+ font-weight: bold;
+ }
+
+ h1 { font: 140% }
+ h2 { font: bold 140% }
+ h3 { font: bold 130% }
+ h4 { font: bold 120% }
+ h5 { font: italic 110% }
+ h6 { font: italic 100% }
+
+ /* Top page titles */
+ title,
+ h1.title,
+ h2.title
+ h3.title,
+ h4.title,
+ h5.title,
+ h6.title,
+ .refentrytitle
+ {
+ font-weight: bold;
+ margin-bottom: 1pc;
+ }
+
+ h1.title { font-size: 140% }
+ h2.title { font-size: 140% }
+ h3.title { font-size: 130% }
+ h4.title { font-size: 120% }
+ h5.title { font-size: 110% }
+ h6.title { font-size: 100% }
+
+ .section h1
+ {
+ margin: 0em 0em 0.5em 0em;
+ font-size: 140%;
+ }
+
+ .section h2 { font-size: 140% }
+ .section h3 { font-size: 130% }
+ .section h4 { font-size: 120% }
+ .section h5 { font-size: 110% }
+ .section h6 { font-size: 100% }
+
+ /* Code on titles */
+ h1 tt.computeroutput { font-size: 140% }
+ h2 tt.computeroutput { font-size: 140% }
+ h3 tt.computeroutput { font-size: 130% }
+ h4 tt.computeroutput { font-size: 120% }
+ h5 tt.computeroutput { font-size: 110% }
+ h6 tt.computeroutput { font-size: 100% }
+
+/*=============================================================================
+ Author
+=============================================================================*/
+
+ h3.author
+ {
+ font-size: 100%
+ }
+
+/*=============================================================================
+ Lists
+=============================================================================*/
+
+ li
+ {
+ font-size: 10pt;
+ line-height: 1.3;
+ }
+
+ /* Unordered lists */
+ ul
+ {
+ text-align: left;
+ }
+
+ /* Ordered lists */
+ ol
+ {
+ text-align: left;
+ }
+
+/*=============================================================================
+ Links
+=============================================================================*/
+
+ a
+ {
+ text-decoration: none; /* no underline */
+ }
+
+ a:hover
+ {
+ text-decoration: underline;
+ }
+
+/*=============================================================================
+ Spirit style navigation
+=============================================================================*/
+
+ .spirit-nav
+ {
+ text-align: right;
+ }
+
+ .spirit-nav a
+ {
+ color: white;
+ padding-left: 0.5em;
+ }
+
+ .spirit-nav img
+ {
+ border-width: 0px;
+ }
+
+/*=============================================================================
+ Table of contents
+=============================================================================*/
+
+ .toc
+ {
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.1pc 1pc 0.1pc 1pc;
+ font-size: 80%;
+ line-height: 1.15;
+ }
+
+ .boost-toc
+ {
+ float: right;
+ padding: 0.5pc;
+ }
+
+/*=============================================================================
+ Tables
+=============================================================================*/
+
+ .table-title,
+ div.table p.title
+ {
+ margin-left: 4%;
+ padding-right: 0.5em;
+ padding-left: 0.5em;
+ }
+
+ .informaltable table,
+ .table table
+ {
+ width: 92%;
+ margin-left: 4%;
+ margin-right: 4%;
+ }
+
+ div.informaltable table,
+ div.table table
+ {
+ padding: 4px;
+ }
+
+ /* Table Cells */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ padding: 0.5em;
+ text-align: left;
+ font-size: 9pt;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ padding: 0.5em 0.5em 0.5em 0.5em;
+ border: 1pt solid white;
+ font-size: 80%;
+ }
+
+/*=============================================================================
+ Blurbs
+=============================================================================*/
+
+ div.note,
+ div.tip,
+ div.important,
+ div.caution,
+ div.warning,
+ p.blurb
+ {
+ font-size: 9pt; /* A little bit smaller than the main text */
+ line-height: 1.2;
+ display: block;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ p.blurb img
+ {
+ padding: 1pt;
+ }
+
+/*=============================================================================
+ Variable Lists
+=============================================================================*/
+
+ /* Make the terms in definition lists bold */
+ div.variablelist dl dt,
+ span.term
+ {
+ font-weight: bold;
+ font-size: 10pt;
+ }
+
+ div.variablelist table tbody tr td
+ {
+ text-align: left;
+ vertical-align: top;
+ padding: 0em 2em 0em 0em;
+ font-size: 10pt;
+ margin: 0em 0em 0.5em 0em;
+ line-height: 1;
+ }
+
+ div.variablelist dl dt
+ {
+ margin-bottom: 0.2em;
+ }
+
+ div.variablelist dl dd
+ {
+ margin: 0em 0em 0.5em 2em;
+ font-size: 10pt;
+ }
+
+ div.variablelist table tbody tr td p,
+ div.variablelist dl dd p
+ {
+ margin: 0em 0em 0.5em 0em;
+ line-height: 1;
+ }
+
+/*=============================================================================
+ Misc
+=============================================================================*/
+
+ /* Title of books and articles in bibliographies */
+ span.title
+ {
+ font-style: italic;
+ }
+
+ span.underline
+ {
+ text-decoration: underline;
+ }
+
+ span.strikethrough
+ {
+ text-decoration: line-through;
+ }
+
+ /* Copyright, Legal Notice */
+ div div.legalnotice p
+ {
+ text-align: left
+ }
+
+/*=============================================================================
+ Colors
+=============================================================================*/
+
+ @media screen
+ {
+ /* Links */
+ a
+ {
+ color: #005a9c;
+ }
+
+ a:visited
+ {
+ color: #9c5a9c;
+ }
+
+ h1 a, h2 a, h3 a, h4 a, h5 a, h6 a,
+ h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6 a:hover,
+ h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited
+ {
+ text-decoration: none; /* no underline */
+ color: #000000;
+ }
+
+ /* Syntax Highlighting */
+ .keyword { color: #0000AA; }
+ .identifier { color: #000000; }
+ .special { color: #707070; }
+ .preprocessor { color: #402080; }
+ .char { color: teal; }
+ .comment { color: #800000; }
+ .string { color: teal; }
+ .number { color: teal; }
+ .white_bkd { background-color: #FFFFFF; }
+ .dk_grey_bkd { background-color: #999999; }
+
+ /* Copyright, Legal Notice */
+ .copyright
+ {
+ color: #666666;
+ font-size: small;
+ }
+
+ div div.legalnotice p
+ {
+ color: #666666;
+ }
+
+ /* Program listing */
+ pre.synopsis
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ .programlisting,
+ .screen
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ td .programlisting,
+ td .screen
+ {
+ border: 0px solid #DCDCDC;
+ }
+
+ /* Blurbs */
+ div.note,
+ div.tip,
+ div.important,
+ div.caution,
+ div.warning,
+ p.blurb
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ /* Table of contents */
+ .toc
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ /* Tables */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ background-color: #F0F0F0;
+ border: 1px solid #DCDCDC;
+ }
+
+ /* Misc */
+ span.highlight
+ {
+ color: #00A000;
+ }
+ }
+
+ @media print
+ {
+ /* Links */
+ a
+ {
+ color: black;
+ }
+
+ a:visited
+ {
+ color: black;
+ }
+
+ .spirit-nav
+ {
+ display: none;
+ }
+
+ /* Program listing */
+ pre.synopsis
+ {
+ border: 1px solid gray;
+ }
+
+ .programlisting,
+ .screen
+ {
+ border: 1px solid gray;
+ }
+
+ td .programlisting,
+ td .screen
+ {
+ border: 0px solid #DCDCDC;
+ }
+
+ /* Table of contents */
+ .toc
+ {
+ border: 1px solid gray;
+ }
+
+ .informaltable table,
+ .table table
+ {
+ border: 1px solid gray;
+ border-collapse: collapse;
+ }
+
+ /* Tables */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ border: 1px solid gray;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ border: 1px solid gray;
+ }
+
+ /* Misc */
+ span.highlight
+ {
+ font-weight: bold;
+ }
+ }
+
+/*=============================================================================
+ Images
+=============================================================================*/
+
+ span.inlinemediaobject img
+ {
+ vertical-align: middle;
+ }
\ No newline at end of file

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
@@ -0,0 +1,85 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>SVG_Plot</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="next" href="svg_plot/intro.html" title=" Introduction">
+</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="n" href="svg_plot/intro.html"><img src="images/next.png" alt="Next"></a></div>
+<div class="article" lang="en">
+<div class="titlepage">
+<div>
+<div><h2 class="title">
+<a name="svg_plot"></a>SVG_Plot</h2></div>
+<div><div class="author"><h3 class="author">
+Jake Voytko
+</h3></div></div>
+<div>Copyright © 2007 Jake Voytko</div>
+<div><div class="legalnotice">
+<a name="id290286"></a>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></div>
+</div>
+<hr>
+</div>
+<div class="toc">
+Table of Contents
+<dl>
+<dt> Preface</dt>
+<dt> Introduction</dt>
+<dt> Colors</dt>
+<dd><dl>
+<dt> Introduction</dt>
+<dt> Internals and Rationale</dt>
+<dt> Usage</dt>
+</dl></dd>
+<dt> Tutorial</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>
+</dl></dd>
+<dt> SVG Public Interface</dt>
+<dt> svg_1d_plot Public Interface</dt>
+<dt> svg_2d_plot Public Interface</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>
+
+ 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.
+ 
+</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="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>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
@@ -0,0 +1,103 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Colors</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="intro.html" title=" Introduction">
+<link rel="next" href="tutorial.html" title=" Tutorial">
+</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="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>
+</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> Internals and Rationale</dt>
+<dt> Usage</dt>
+</dl></div>
+<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.
+ 
+
+ Here
+ is a link to the SVG color constants that my program supports
+ 
+</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.
+ 
+
+ 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.
+ 
+</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>
+
+ 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.
+ 
+
+
+
+<pre class="programlisting">
+// Using a new RGB value
+my_plot.set_title_color(svg_color(139, 69, 19));
+
+// Using an existing RGB value
+my_plot.set_title_color(my_color);
+
+// Using a color constant
+my_plot.set_title_color(saddlebrown);
+
+// 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>
+
+ 
+</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="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>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/intro.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/intro.html 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
@@ -0,0 +1,72 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Introduction</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.intro"></a> Introduction</h2></div></div></div>
+
+ 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
+ would be written in an svg image, compliant with the W3C standard. The goals
+ of the project are as follows:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ To provide an easy syntax for graphing 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
+ </li>
+<li>
+ To allow users to easily customize graphs 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
+ </li>
+<li>
+ To create the backbone of a svg class that will be extended to fully support
+ storing 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
+ 
+</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>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_1d_plot_interface.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_1d_plot_interface.html 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
@@ -0,0 +1,373 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> svg_1d_plot Public Interface</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../index.html" title="SVG_Plot">
+<link rel="up" href="../index.html" title="SVG_Plot">
+<link rel="prev" href="svg_interface.html" title=" SVG Public Interface">
+<link rel="next" href="svg_2d_plot_interface.html" title=" svg_2d_plot Public Interface">
+</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_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="svg_2d_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_1d_plot_interface"></a> <code class="computeroutput">svg_1d_plot</code> Public Interface</h2></div></div></div>
+<div class="informaltable">
+<h4>
+<a name="id335921"></a>
+ Misc
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Signature</th>
+<th>Description</th>
+</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>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>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>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>
+</tr>
+<tr>
+<td><code class="computeroutput">svg_1d_plot& write(ostream&)</code></td>
+<td>Writes
+ the plot to a stream passed as a parameter</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="informaltable">
+<h4>
+<a name="id336567"></a>
+ Commands
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Signature</th>
+<th>Description</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><code class="computeroutput">svg_1d_plot& set_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>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>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>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>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>Determines
+ whether or not the image title is displayed</td>
+</tr>
+<tr>
+<td><code class="computeroutput">svg_1d_plot& set_x_major_grid_on(bool)</code></td>
+<td>Determines
+ whether or not the major grid on the X axis will be displayed</td>
+</tr>
+<tr>
+<td><code class="computeroutput">svg_1d_plot& set_x_minor_grid_on(bool)</code></td>
+<td>Determines
+ whether or not the minor grid on the X axis will be displayed</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="informaltable">
+<h4>
+<a name="id336927"></a>
+ Color Information
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Signature</th>
+<th>Description</th>
+</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>
+</tr>
+<tr>
+<td><code class="computeroutput">svg_1d_plot& set_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>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>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>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_x_axis_color(svg_color_constant 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_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>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>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>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_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_1d_plot& set_x_minor_tick_color(const svg_color &col)</code></td>
+<td>Sets the color of the
+ minor ticks of the x-axis</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="informaltable">
+<h4>
+<a name="id338149"></a>
+ Axis Information
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Signature</th>
+<th>Description</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><code class="computeroutput">svg_1d_plot& set_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>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>
+ for that guarantee</td>
+</tr>
+<tr>
+<td><code class="computeroutput">svg_1d_plot& set_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>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>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>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>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>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>Sets
+ the scale of the x axis from x1 to x2. Throws an exception if x2<=x1
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+
+ (Note: Getters omitted for now)
+ 
+</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_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="svg_2d_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/svg_2d_plot_interface.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_2d_plot_interface.html 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
@@ -0,0 +1,484 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> svg_2d_plot Public Interface</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../index.html" title="SVG_Plot">
+<link rel="up" href="../index.html" title="SVG_Plot">
+<link rel="prev" href="svg_1d_plot_interface.html" title=" svg_1d_plot Public Interface">
+</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_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>
+</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="informaltable">
+<h4>
+<a name="id338696"></a>
+ Misc
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Signature</th>
+<th>Description</th>
+</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>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>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>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>Sets the font size for
+ the legend title</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="informaltable">
+<h4>
+<a name="id339288"></a>
+ Commands
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Signature</th>
+<th>Description</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><code class="computeroutput">svg_2d_plot& set_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>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>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>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>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>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>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>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>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>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>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>Determines
+ whether or not the minor grid on the Y axis will be displayed</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="informaltable">
+<h4>
+<a name="id339809"></a>
+ Color Information
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Signature</th>
+<th>Description</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><code class="computeroutput">svg_2d_plot& set_title_color(svg_color_constant 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>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>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>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>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>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_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>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>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>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>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>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>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>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>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>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>Sets the color of the
+ minor ticks of the Y-axis</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="informaltable">
+<h4>
+<a name="id341545"></a>
+ Axis Information
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Signature</th>
+<th>Description</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><code class="computeroutput">svg_2d_plot& set_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>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>
+ for that guarantee</td>
+</tr>
+<tr>
+<td><code class="computeroutput">svg_2d_plot& set_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>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>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>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>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>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>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>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>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>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>
+ for that guarantee</td>
+</tr>
+<tr>
+<td><code class="computeroutput">svg_2d_plot& set_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>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>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>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>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>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>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>Sets
+ the scale of the Y axis from y1 to y2. Throws an exception if y2<=y1
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+
+ (Note: Getters omitted for now)
+ 
+</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_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>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_interface.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_interface.html 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
@@ -0,0 +1,151 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> SVG Public Interface</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../index.html" title="SVG_Plot">
+<link rel="up" href="../index.html" title="SVG_Plot">
+<link rel="prev" href="tutorial.html" title=" Tutorial">
+<link rel="next" href="svg_1d_plot_interface.html" title=" svg_1d_plot Public Interface">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<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.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>
+ class svg
+ </h4>
+<table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Signature</th>
+<th>Description</th>
+<th>Notes</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><code class="computeroutput">svg()</code></td>
+<td>Constructor</td>
+<td>The
+ default image size is (400, 400)</td>
+</tr>
+<tr>
+<td><code class="computeroutput">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& 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>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> </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>
+</tr>
+<tr>
+<td><code class="computeroutput">svg& rect(double x1, double y1, double width, double height)</code></td>
+<td>Adds
+ a rectangle at point (x1, y1) that has width <code class="computeroutput">width</code>
+ and height <code class="computeroutput">height</code>
+</td>
+<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>
+</tr>
+<tr>
+<td><code class="computeroutput">g_element& add_g_element()</code></td>
+<td>Adds
+ a g_element at the root of the document tree. Acts as a <code class="computeroutput">push_back()</code>
+</td>
+<td>Returns
+ the <code class="computeroutput">g_element</code> that is
+ pushed back. This allows you to do something like the following: <code class="computeroutput">image.add_g_element().line(/**/).line(/**/).rect(/**/); </code>
+ Which adds two lines and a rectangle to the g_element that was just created.</td>
+</tr>
+<tr>
+<td><code class="computeroutput">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>
+</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="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>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial.html 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
@@ -0,0 +1,691 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Tutorial</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="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="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="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.tutorial"></a> Tutorial</h2></div></div></div>
+<div class="toc"><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>
+</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>
+
+
+
+<pre class="programlisting">
+#include <boost/svg_plot/svg_1d_plot.hpp>
+#include <vector>
+
+using std::vector;
+using namespace boost::svg_plot;
+
+int main()
+{
+ // Snip
+
+ vector<double> my_data;
+
+ // initialize my_data here
+
+ svg_1d_plot my_plot;
+
+ my_plot.set_title("My Graph")
+ .set_legend_on(true)
+ .set_x_range(-1, 11);
+
+ plot(my_plot, my_data, "Race times");
+
+ my_plot.write("my_file.svg");
+ return 0;
+}
+umber#>69</phrase><phrase </pre>
+
+ 
+
+ <img src="../my_file.svg" alt="my_file">
+ 
+</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.
+ 
+
+ This syntax may be unfamiliar. However, it works on the same principle
+ that the following code works:
+
+<pre class="programlisting">
+a = b = c = d = 3;
+#*</pre>
+
+ 
+
+ You have also seen it used to print to the console:
+
+<pre class="programlisting">
+std::cout << "Hello" << name << std::endl;
+##</pre>
+
+ 
+
+ Within all of the plot classes, chaining works the same way. The equivalent
+ code for the above is as follows:
+ 
+
+
+
+<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!
+ 
+
+
+
+<pre class="programlisting">
+plot(my_plot, my_data, "Race times");
+dP</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:
+
+<pre class="programlisting">
+plot(my_plot, my_data, "Race Times", blue);
+##</pre>
+
+ 
+
+ is how you could accomplish this
+ 
+
+
+
+<pre class="programlisting">
+my_plot.write("my_file.svg");
+s#</pre>
+
+ 
+
+ This writes our plot to the file "my_file.svg".
+ 
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="svg_plot.tutorial.plot_window"></a> Using a Plot Window</h3></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">
+#include <boost/svg_plot/svg_1d_plot.hpp>
+#include <vector>
+
+using std::vector;
+using namespace boost::svg_plot;
+
+// Snip
+
+vector<double> my_data;
+
+// initialize my_data here
+
+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);
+
+plot(my_plot, my_data, "Race times");
+
+my_plot.write("my_file.svg");
+####)(l#*###)(l#*######</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.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:
+ 
+
+
+
+<pre class="programlisting">
+svg_1d_plot my_plot;
+
+// 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);
+
+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.
+ 
+
+ The other way to define a color is to use the SVG standard's custom color
+ definitions, as defined here
+ 
+
+ Here is an example using color customization:
+ 
+
+
+
+<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)
+ 
+</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>
+
+ 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>
+ 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>Axis</td>
+<td>On</td>
+<td>Most graphs include an axis
+ of some kindl</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. Not including the legend meets this goal. If there is a public
+ outcry, I can change this.</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>Title</td>
+<td>On, "Plot of data"</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>X Axis Label</td>
+<td><code class="computeroutput">"X
+ Axis", Off</code></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 Range</td>
+<td><code class="computeroutput">(-10, 10)</code></td>
+<td>Traditional
+ plot viewport</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>Legend background</td>
+<td>white</td>
+<td>K.I.S.S.
+ Coloring will be highly dependent on user needs</td>
+</tr>
+<tr>
+<td>All other colors</td>
+<td>black</td>
+<td>K.I.S.S.
+ Coloring will be highly dependent on user needs</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="svg_plot.tutorial.plot_function"></a> Getting More Out Of The <code class="computeroutput">plot()</code> Function</h3></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="id333992"></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="id334043"></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">
+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());
+ow><entry>Imag</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.tutorial.plot_function.using_fill_and_stroke_colors"></a><h3>
+<a name="id334385"></a>
+ Using fill and stroke colors
+ </h3>
+
+
+
+<pre class="programlisting">
+plot(my_plot, my_data, "Lions", _fill_color = svg_color(red), _stroke_color = svg_color(black));
+ip</pre>
+
+ 
+
+ This has the same effect as the following:
+ 
+
+
+
+<pre class="programlisting">
+plot(my_plot, my_data, "Lions", svg_color(red), svg_color(black));
+#*</pre>
+
+ 
+
+ and also the same effect as:
+
+<pre class="programlisting">
+plot(my_plot, my_data, "Lions", _stroke_color = svg_color(black), _fill_color = svg_color(red));
+l#</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.tutorial.plot_function.using_all_parameters"></a><h3>
+<a name="id334729"></a>
+ Using all parameters
+ </h3>
+
+
+
+<pre class="programlisting">
+plot(my_plot, my_data, "Lions",
+ _fill_color = svg_color(red),
+ _stroke_color = svg_color(black),
+ _x_functor = my_functor());
+(fill</pre>
+
+ 
+</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="svg_interface.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.qbk (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_plot.qbk 2007-07-22 23:13:45 EDT (Sun, 22 Jul 2007)
@@ -300,9 +300,7 @@
 plot_range(my_plot, data3.begin(), data3.end(), "Bears", red);

 my_plot.write("D:/1d_complex.svg");
-
``
-
This produces the following output:
(Insert image)
[endsect]
@@ -364,21 +362,7 @@
plot(my_plot, my_data, "Lions", _x_functor = my_functor());
``
][
-``
-class boost_default_convert
-{
-public:
- typedef double result_type;
-
- template <class T>
- double operator()(T val) const
- {
- return (double)val;
- }
-};
-``
-
-The above functor is sufficient in all cases where the data stored in the container can be directly casted to a double]]]
+`boost_default_convert` is sufficient in all cases where the data stored in the container can be directly casted to a double]]]

Here are some examples of correct uses:
[h3 Using fill and stroke colors]
@@ -434,23 +418,18 @@
[section:svg_1d_plot_interface `svg_1d_plot` Public Interface]
[table Misc
 [[Signature] [Description]]
-[[``
-void plot_range(std::vector<double>::const_iterator begin,
- std::vector<double>::const_iterator end,
- std::string text)
-``] [Plots a vector<double> from begin() to end(). It adds the text `text` to the legend. If you are looking for the generic version, you can find it below.]]
- [[``
-void plot(const std::vector<double>& _ctr,
- const std::string&,
- const plot_point_style&)
-``] [Plots a vector<double> from begin() to end(). It adds the text `text` to the legend. The point color for this series is going to be `col`. If you are looking for the generic version, you can find it below.]]
+[[ `void plot_range(std::vector<double>::const_iterator begin,
+std::vector<double>::const_iterator end, std::string text);`]
+ [Plots a vector<double> from begin() to end(). It adds the text `text` to the legend. If you are looking for the generic version, you can find it below.]]
+ [[`void plot(const std::vector<double>& _ctr, const std::string&, const plot_point_style&)`]
+ [Plots a vector<double> from begin() to end(). It adds the text `text` to the legend. The point color for this series is going to be `col`. If you are looking for the generic version, you can find it below.]]
 [[`svg_1d_plot()`] [See the defaults section for further details]]
 [[`svg_1d_plot& set_image_size(unsigned int, unsigned int)`] [Sets the size of the image produced, in pixels]]
 [[`svg_1d_plot& set_title(const std::string&)`] [Sets the string to be used for the title]]
 [[`svg_1d_plot& set_title_font_size(unsigned int)`] [Sets the font size for the title]]
- [[`svg_1d_plot& set_legend_title_font_size(unsigned int)`] [Sets the font size for the legend title]]]
- [[`svg_1d_plot& write(const std::string&)] [Writes the plot to the file passed as a parameter]]
- [[`svg_1d_plot& write(ostream&)] [Writes the plot to a stream passed as a parameter]]
+ [[`svg_1d_plot& set_legend_title_font_size(unsigned int)`] [Sets the font size for the legend title]]
+ [[`svg_1d_plot& write(const std::string&)`] [Writes the plot to the file passed as a parameter]]
+ [[`svg_1d_plot& write(ostream&)`] [Writes the plot to a stream passed as a parameter]]]

[table Commands
 [[Signature] [Description]]
@@ -509,17 +488,12 @@
[section:svg_2d_plot_interface `svg_2d_plot` Public Interface]
[table Misc
 [[Signature] [Description]]
-[[``
-void plot_range(std::vector<double>::const_iterator begin,
- std::vector<double>::const_iterator end,
- std::string text)
-``] [Plots a vector<double> from begin() to end(). It adds the text `text` to the legend. If you are looking for the generic version, you can find it below.]]
- [[``
-void plot_range(std::vector<double>::const_iterator begin,
- std::vector<double>::const_iterator end,
- std::string text,
- svg_color_constant col)
-``] [Plots a vector<double> from begin() to end(). It adds the text `text` to the legend. The point color for this series is going to be `col`. If you are looking for the generic version, you can find it below.]]
+[[` void plot_range(std::vector<double>::const_iterator begin,
+std::vector<double>::const_iterator end, std::string text)`]
+[Plots a vector<double> from begin() to end(). It adds the text `text` to the legend. If you are looking for the generic version, you can find it below.]]
+ [[` void plot_range(std::vector<double>::const_iterator begin, std::vector<double>::const_iterator end,
+std::string text, svg_color_constant col)`]
+[Plots a vector<double> from begin() to end(). It adds the text `text` to the legend. The point color for this series is going to be `col`. If you are looking for the generic version, you can find it below.]]
 [[`svg_2d_plot()`] [See the defaults section for further details]]
 [[`svg_2d_plot& set_image_size(unsigned int, unsigned int)`] [Sets the size of the image produced, in pixels]]
 [[`svg_2d_plot& set_title(const std::string&)`] [Sets the string to be used for the title]]
@@ -535,7 +509,7 @@
 [[`svg_2d_plot& set_x_label_on(bool)`] [Sets whether or not the X axis label will show]]
 [[`svg_2d_plot& set_x_major_grid_on(bool)`] [Determines whether or not the major grid on the X axis will be displayed]]
 [[`svg_2d_plot& set_x_major_labels_on(bool)`] [sets whether or not the major ticks will be labelled on the x axis]]
- [[`svg_2d_plot& set_x_minor_grid_on(bool)`] [Determines whether or not the minor grid on the X axis will be displayed]]]
+ [[`svg_2d_plot& set_x_minor_grid_on(bool)`] [Determines whether or not the minor grid on the X axis will be displayed]]
 [[`svg_2d_plot& set_y_label_on(bool)`] [Sets whether or not the Y axis label will show]]
 [[`svg_2d_plot& set_y_major_grid_on(bool)`] [Determines whether or not the major grid on the Y axis will be displayed]]
 [[`svg_2d_plot& set_y_major_labels_on(bool)`] [sets whether or not the major ticks will be labelled on the Y axis]]

Next message: asutton_at_[hidden]: "[Boost-commit] svn:boost r7512"
Previous message: huseyinakcan_at_[hidden]: "[Boost-commit] svn:boost r7510"

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