<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>linbox: PlotGraph< NAM > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">linbox</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lin_box.html">LinBox</a> </li>
<li class="navelem"><a class="el" href="class_lin_box_1_1_plot_graph.html">PlotGraph</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">PlotGraph< NAM > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::PlotGraph" -->
<p>The graph.
<a href="class_lin_box_1_1_plot_graph.html#details">More...</a></p>
<p><code>#include <benchmark.h></code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_plot_graph.html#ae5eac1fa348ced4fff60f14bdb6260f6">PlotGraph</a> (<a class="el" href="class_lin_box_1_1_plot_data.html">PlotData</a>< NAM > &data, <a class="el" href="class_lin_box_1_1_plot_style.html">PlotStyle</a> &style)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for the <a class="el" href="class_lin_box_1_1_plot_graph.html" title="The graph.">PlotGraph</a> class. <a href="#ae5eac1fa348ced4fff60f14bdb6260f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_plot_graph.html#abe3e29745e52da1bade247b9572ebe36">setOutFilename</a> (std::string filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets the ouput file name. <a href="#abe3e29745e52da1bade247b9572ebe36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_plot_graph.html#adea50ecbec0a01566fecc9302fcef10b">print_latex</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints data in a latex tabular. <a href="#adea50ecbec0a01566fecc9302fcef10b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_plot_graph.html#a7c532b2923c0d01e63bf9c11e53ecaf0">print_gnuplot</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Plots the data with gnuplot. <a href="#a7c532b2923c0d01e63bf9c11e53ecaf0"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class NAM><br/>
class LinBox::PlotGraph< NAM ></h3>
<p>The graph. </p>
<p>This class joins a <a class="el" href="class_lin_box_1_1_plot_style.html" title="Represents a table of values to plot.">PlotStyle</a> and a <a class="el" href="class_lin_box_1_1_plot_data.html" title="The raw data to plot.">PlotData</a> to build up a graph. A filename should be provided as well, indicating where the output graph and scripts will be generated.</p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>the filename will get a random suffix before the extension so as not to overwrite files "par inadvertance". </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae5eac1fa348ced4fff60f14bdb6260f6"></a><!-- doxytag: member="LinBox::PlotGraph::PlotGraph" ref="ae5eac1fa348ced4fff60f14bdb6260f6" args="(PlotData< NAM > &data, PlotStyle &style)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_plot_graph.html">PlotGraph</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lin_box_1_1_plot_data.html">PlotData</a>< NAM > & </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_lin_box_1_1_plot_style.html">PlotStyle</a> & </td>
<td class="paramname"><em>style</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor for the <a class="el" href="class_lin_box_1_1_plot_graph.html" title="The graph.">PlotGraph</a> class. </p>
<p>Plots a series of data according to a style. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>data to be plot, will be processed by the style </td></tr>
<tr><td class="paramname">style</td><td>sets parameters to gnuplot to achieve a nice plot. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abe3e29745e52da1bade247b9572ebe36"></a><!-- doxytag: member="LinBox::PlotGraph::setOutFilename" ref="abe3e29745e52da1bade247b9572ebe36" args="(std::string filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setOutFilename </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sets the ouput file name. </p>
<p>All output is put in a "data" subfolder. </p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>Since no file is overwritten, this directory can rapidly get very populated. </dd></dl>
</div>
</div>
<a class="anchor" id="adea50ecbec0a01566fecc9302fcef10b"></a><!-- doxytag: member="LinBox::PlotGraph::print_latex" ref="adea50ecbec0a01566fecc9302fcef10b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void print_latex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prints data in a latex tabular. </p>
<p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000063">Todo:</a></b></dt><dd>check FN opened. </dd></dl>
</p>
</div>
</div>
<a class="anchor" id="a7c532b2923c0d01e63bf9c11e53ecaf0"></a><!-- doxytag: member="LinBox::PlotGraph::print_gnuplot" ref="a7c532b2923c0d01e63bf9c11e53ecaf0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void print_gnuplot </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Plots the data with gnuplot. </p>
<p>Produces data in a .dat file, creates a .gp gnuplot script and outputs a graph calling gnuplot. </p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>If gnuplot is not available, fall back to the latex method. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="benchmark_8h.html">benchmark.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Aug 30 2011 for linbox by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
