<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>PlotMM: PlotMM::ScaleDiv class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>PlotMM::ScaleDiv Class Reference</h1><a href="class_plot_m_m_1_1_scale_div-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
A class for building scale divisions.
<p>
The <a class="el" href="class_plot_m_m_1_1_scale_div.html">ScaleDiv</a> class can build linear and logarithmic scale divisions for specified intervals. It uses an adjustable algorithm to generate the major and minor step widths automatically. A scale division has a minimum value, a maximum value, a vector of major marks, and a vector of minor marks.<p>
<dl compact><dt><b>Warning:</b></dt><dd><a class="el" href="class_plot_m_m_1_1_scale_div.html">ScaleDiv</a> uses implicit sharing for the mark vectors. </dd></dl>
<dl compact><dt><b>Example</b></dt><dd>To build a logarithmic scale division from 0.01 to 1000 and print out the major and minor marks. <pre class="fragment"><div>
#include <plotmm/scalediv.h>
#include <iostream.h>
main()
{
int i,k;
PlotMM::ScaleDiv sd;
sd.rebuild(0.01, 1000, 10, 10, TRUE, 0.0);
k=0;
for (i=0;i<sd.maj_count();i++)
{
while(k < sd.min_count())
{
if (sd.min_mark(k) < sd.maj_mark(i))
{
cout << " - " << sd.min_mark(i) << "\n";
k++;
}
else
break;
}
cout << "-- " << sd.maj_mark(i) << "\n";
}
while(k < sd.min_count())
{
cout << " - " << sd.min_mark(i) << "\n";
k++;
}
}</div></pre></dd></dl>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva0">ScaleDiv</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva1">operator==</a> (const <a class="el" href="class_plot_m_m_1_1_scale_div.html">ScaleDiv</a> &s) const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva2">operator!=</a> (const <a class="el" href="class_plot_m_m_1_1_scale_div.html">ScaleDiv</a> &s) const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>double </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva3">low_bound</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>double </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva4">high_bound</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>uint </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva5">min_count</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>uint </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva6">maj_count</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva7">log_scale</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>double </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva8">maj_mark</a> (int i) const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>double </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva9">min_mark</a> (int i) const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>double </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva10">maj_step</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva11">reset</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva12">rebuild</a> (double lBound, double hBound, int maxMaj, int maxMin, bool log, double step=0.0, bool ascend=true)</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="_plot_m_m_1_1_scale_diva0" doxytag="PlotMM::ScaleDiv::ScaleDiv" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> ScaleDiv::ScaleDiv </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a <a class="el" href="class_plot_m_m_1_1_scale_div.html">ScaleDiv</a> instance.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="_plot_m_m_1_1_scale_diva4" doxytag="PlotMM::ScaleDiv::high_bound" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> double PlotMM::ScaleDiv::high_bound </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Returns:</b></dt><dd>right bound </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva12">ScaleDiv::rebuild</a></dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="_plot_m_m_1_1_scale_diva7" doxytag="PlotMM::ScaleDiv::log_scale" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool PlotMM::ScaleDiv::log_scale </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Returns:</b></dt><dd>TRUE id ths scale div is logarithmic </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva12">ScaleDiv::rebuild</a></dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="_plot_m_m_1_1_scale_diva3" doxytag="PlotMM::ScaleDiv::low_bound" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> double PlotMM::ScaleDiv::low_bound </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Returns:</b></dt><dd>left bound </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva12">ScaleDiv::rebuild</a></dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="_plot_m_m_1_1_scale_diva6" doxytag="PlotMM::ScaleDiv::maj_count" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> uint PlotMM::ScaleDiv::maj_count </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Returns:</b></dt><dd>major mark count </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva12">ScaleDiv::rebuild</a></dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="_plot_m_m_1_1_scale_diva8" doxytag="PlotMM::ScaleDiv::maj_mark" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> double PlotMM::ScaleDiv::maj_mark </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>i</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return major mark at position i.
<p>
</td>
</tr>
</table>
<a class="anchor" name="_plot_m_m_1_1_scale_diva10" doxytag="PlotMM::ScaleDiv::maj_step" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> double PlotMM::ScaleDiv::maj_step </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Returns:</b></dt><dd>major step size </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva12">ScaleDiv::rebuild</a></dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="_plot_m_m_1_1_scale_diva5" doxytag="PlotMM::ScaleDiv::min_count" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> uint PlotMM::ScaleDiv::min_count </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Returns:</b></dt><dd>minor mark count </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_plot_m_m_1_1_scale_div.html#_plot_m_m_1_1_scale_diva12">ScaleDiv::rebuild</a></dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="_plot_m_m_1_1_scale_diva9" doxytag="PlotMM::ScaleDiv::min_mark" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> double PlotMM::ScaleDiv::min_mark </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>i</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return minor mark at position i.
<p>
</td>
</tr>
</table>
<a class="anchor" name="_plot_m_m_1_1_scale_diva2" doxytag="PlotMM::ScaleDiv::operator!=" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ScaleDiv::operator!= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="class_plot_m_m_1_1_scale_div.html">ScaleDiv</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>s</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Inequality.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if this instance is not equal to s </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="_plot_m_m_1_1_scale_diva1" doxytag="PlotMM::ScaleDiv::operator==" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ScaleDiv::operator== </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="class_plot_m_m_1_1_scale_div.html">ScaleDiv</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>s</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Equality operator.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if this instance is equal to s </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="_plot_m_m_1_1_scale_diva12" doxytag="PlotMM::ScaleDiv::rebuild" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool ScaleDiv::rebuild </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname" nowrap> <em>x1</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>x2</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>maxMajSteps</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>maxMinSteps</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>log</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>step</em> = 0.0, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>ascend</em> = true</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Build a scale width major and minor divisions If no fixed step width is specified or if it is set to 0, the major step width will be calculated automatically according to the the value of maxMajSteps. The maxMajSteps parameter has no effect if a fixed step size is specified. The minor step width is always calculated automatically.
<p>
If the step width is to be calculated automatically, the algorithm tries to find reasonable values fitting into the scheme {1,2,5}*10^n with an integer number n for linear scales.<p>
For logarithmic scales, there are three different cases <ol>
<li>
If the major step width is one decade, the minor marks will fit into one of the schemes {1,2,...9}, {2,4,6,8}, {2,5} or {5}, depending on the maxMinSteps parameter. </li>
<li>
If the major step size spans more than one decade, the minor step size will be {1,2,5}*10^n decades with a natural number n. </li>
<li>
If the whole range is less than one decade, a linear scale division will be built. </li>
</ol>
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>x1</em> </td><td>first boundary value </td></tr>
<tr><td valign=top><em>x2</em> </td><td>second boundary value </td></tr>
<tr><td valign=top><em>maxMajSteps</em> </td><td>max. number of major step intervals </td></tr>
<tr><td valign=top><em>maxMinSteps</em> </td><td>max. number of minor step intervals </td></tr>
<tr><td valign=top><em>log</em> </td><td>logarithmic division (true/false) </td></tr>
<tr><td valign=top><em>step</em> </td><td>fixed major step width. Defaults to 0.0. </td></tr>
<tr><td valign=top><em>ascend</em> </td><td>if true, sort in ascending order from min(x1, x2) to max(x1, x2). If false, sort in the direction from x1 to x2. Defaults to true. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>True if the arrays have been allocated successfully. </dd></dl>
<dl compact><dt><b>Warning:</b></dt><dd>For logarithmic scales, the step width is measured in decades. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="_plot_m_m_1_1_scale_diva11" doxytag="PlotMM::ScaleDiv::reset" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ScaleDiv::reset </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Detach the shared data and set everything to zero.
<p>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jul 8 14:56:46 2004 for PlotMM by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.6 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
55ae40ecad2e75548f2982fd64f38f3a
>
files
>
94
