source: tspsg-svn/trunk/docs/html/globals_8h.html @ 100

Last change on this file since 100 was 100, checked in by laleppa, 15 years ago

+ Added Installation Guide.

  • Updated translations.
  • Updated documentaion.

NB: This will be the second public alpha release.
File size: 19.6 KB
Line 
1<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<title>TSPSG: TSP Solver and Generator: src/globals.h File Reference</title>
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="search/search.css" rel="stylesheet" type="text/css"/>
9<script type="text/javaScript" src="search/search.js"></script>
10<link href="doxygen.css" rel="stylesheet" type="text/css"/>
11</head>
12<body onload='searchBox.OnSelectItem(0);'>
13<!-- Generated by Doxygen 1.6.1 -->
14<script type="text/javascript"><!--
15var searchBox = new SearchBox("searchBox", "search",false,'Search');
16--></script>
17<script type="text/javascript">
18<!--
19function changeDisplayState (e){
20  var num=this.id.replace(/[^[0-9]/g,'');
21  var button=this.firstChild;
22  var sectionDiv=document.getElementById('dynsection'+num);
23  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
24    sectionDiv.style.display='block';
25    button.src='open.gif';
26  }else{
27    sectionDiv.style.display='none';
28    button.src='closed.gif';
29  }
30}
31function initDynSections(){
32  var divs=document.getElementsByTagName('div');
33  var sectionCounter=1;
34  for(var i=0;i<divs.length-1;i++){
35    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
36      var header=divs[i];
37      var section=divs[i+1];
38      var button=header.firstChild;
39      if (button!='IMG'){
40        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
41        button=document.createElement('img');
42        divs[i].insertBefore(button,divs[i].firstChild);
43      }
44      header.style.cursor='pointer';
45      header.onclick=changeDisplayState;
46      header.id='dynheader'+sectionCounter;
47      button.src='closed.gif';
48      section.id='dynsection'+sectionCounter;
49      section.style.display='none';
50      section.style.marginLeft='14px';
51      sectionCounter++;
52    }
53  }
54}
55window.onload = initDynSections;
56-->
57</script>
58<div class="navigation" id="top">
59  <div class="tabs">
60    <ul>
61      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
62      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
63      <li><a href="annotated.html"><span>Classes</span></a></li>
64      <li class="current"><a href="files.html"><span>Files</span></a></li>
65      <li>
66        <div id="MSearchBox" class="MSearchBoxInactive">
67        <img id="MSearchSelect" src="search/search.png"
68             onmouseover="return searchBox.OnSearchSelectShow()"
69             onmouseout="return searchBox.OnSearchSelectHide()"
70             alt=""/>
71        <input type="text" id="MSearchField" value="Search" accesskey="S"
72             onfocus="searchBox.OnSearchFieldFocus(true)" 
73             onblur="searchBox.OnSearchFieldFocus(false)" 
74             onkeyup="searchBox.OnSearchFieldChange(event)"/>
75        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
76        </div>
77      </li>
78    </ul>
79  </div>
80  <div class="tabs">
81    <ul>
82      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
83      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
84    </ul>
85  </div>
86</div>
87<div class="contents">
88<h1>src/globals.h File Reference</h1>
89<p>Contains TSPSG global defines. 
90<a href="#_details">More...</a></p>
91<code>#include &lt;QtCore&gt;</code><br/>
92<code>#include &lt;QtGui&gt;</code><br/>
93<code>#include &lt;limits&gt;</code><br/>
94<code>#include &quot;<a class="el" href="version_8h_source.html">version.h</a>&quot;</code><br/>
95<code>#include &quot;<a class="el" href="os_8h_source.html">os.h</a>&quot;</code><br/>
96<code>#include &quot;<a class="el" href="defaults_8h_source.html">defaults.h</a>&quot;</code><br/>
97<code>#include &quot;<a class="el" href="qtwin_8h_source.html">qtwin.h</a>&quot;</code><br/>
98<div class="dynheader">
99Include dependency graph for globals.h:</div>
100<div class="dynsection">
101<div class="center"><img src="globals_8h__incl.png" border="0" usemap="#src_2globals_8h_map" alt=""/></div>
102<map name="src_2globals_8h_map" id="src_2globals_8h">
103<area shape="rect" id="node9" href="version_8h.html" title="Contains TSPSG version information defines." alt="" coords="245,83,317,111"/>
104<area shape="rect" id="node11" href="os_8h.html" title="Contains TSPSG target CPU architecture and OS detection." alt="" coords="341,83,387,111"/>
105<area shape="rect" id="node13" href="defaults_8h.html" title="Contains TSPSG defaults." alt="" coords="411,83,488,111"/>
106<area shape="rect" id="node15" href="qtwin_8h.html" title="qtwin.h" alt="" coords="512,83,573,111"/>
107</map>
108</div>
109<div class="dynheader">
110This graph shows which files directly or indirectly include this file:</div>
111<div class="dynsection">
112<div class="center"><img src="globals_8h__dep__incl.png" border="0" usemap="#src_2globals_8hdep_map" alt=""/></div>
113<map name="src_2globals_8hdep_map" id="src_2globals_8hdep">
114<area shape="rect" id="node3" href="mainwindow_8h.html" title="Defines MainWindow class." alt="" coords="79,238,202,266"/>
115<area shape="rect" id="node5" href="settingsdialog_8h.html" title="Defines SettingsDialog class." alt="" coords="22,161,155,189"/>
116<area shape="rect" id="node8" href="tspmodel_8h.html" title="Defines CTSPModel class." alt="" coords="138,83,245,111"/>
117<area shape="rect" id="node11" href="tspsolver_8h.html" title="Defines TMatrix typedef, SCandidate and SStep structs and CTSPSolver class." alt="" coords="230,161,334,189"/>
118</map>
119</div>
120
121<p><a href="globals_8h_source.html">Go to the source code of this file.</a></p>
122<table border="0" cellpadding="0" cellspacing="0">
123<tr><td colspan="2"><h2>Defines</h2></td></tr>
124<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70edda218af688662bb006cf0552544e"></a><!-- doxytag: member="globals.h::MAX_NUM_CITIES" ref="a70edda218af688662bb006cf0552544e" args="" -->
125#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a70edda218af688662bb006cf0552544e">MAX_NUM_CITIES</a>&nbsp;&nbsp;&nbsp;50</td></tr>
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum available number of cities. <br/></td></tr>
127<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1703614f274735e91c1539048ef1093f"></a><!-- doxytag: member="globals.h::MAX_RAND_VALUE" ref="a1703614f274735e91c1539048ef1093f" args="" -->
128#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a1703614f274735e91c1539048ef1093f">MAX_RAND_VALUE</a>&nbsp;&nbsp;&nbsp;1000</td></tr>
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum allowed value for random generation limits. <br/></td></tr>
130<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27fa861afe50713394493c32c26741b9"></a><!-- doxytag: member="globals.h::PATH_L10N" ref="a27fa861afe50713394493c32c26741b9" args="" -->
131#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a27fa861afe50713394493c32c26741b9">PATH_L10N</a>&nbsp;&nbsp;&nbsp;&quot;l10n&quot;</td></tr>
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="elRef" doxygen="qt-4.6.tag:http://doc.trolltech.com/4.6/" href="http://doc.trolltech.com/4.6/phonon-path.html">Path</a> to internationalization files. <br/></td></tr>
133<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93de9563d724c12880c908961ca78dae"></a><!-- doxytag: member="globals.h::PATH_DOCS" ref="a93de9563d724c12880c908961ca78dae" args="" -->
134#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a93de9563d724c12880c908961ca78dae">PATH_DOCS</a>&nbsp;&nbsp;&nbsp;&quot;help&quot;</td></tr>
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Bath to documentation files. <br/></td></tr>
136<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd9c3c65456a20b4b281165a29583e78"></a><!-- doxytag: member="globals.h::TSPT" ref="abd9c3c65456a20b4b281165a29583e78" args="" -->
137#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#abd9c3c65456a20b4b281165a29583e78">TSPT</a>&nbsp;&nbsp;&nbsp;quint32(0x54535054)</td></tr>
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TSPSG Task file signature - letters <code>TSPT</code>. <br/></td></tr>
139<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc611d658b90f441ae837a2478b5bdb1"></a><!-- doxytag: member="globals.h::TSPT_VERSION" ref="afc611d658b90f441ae837a2478b5bdb1" args="" -->
140#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#afc611d658b90f441ae837a2478b5bdb1">TSPT_VERSION</a>&nbsp;&nbsp;&nbsp;quint8(1)</td></tr>
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TSPSG Task file version. <br/></td></tr>
142<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c516e985c6e8edf1b54bcd7c15ad89c"></a><!-- doxytag: member="globals.h::TSPT_META_VERSION" ref="a4c516e985c6e8edf1b54bcd7c15ad89c" args="" -->
143#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a4c516e985c6e8edf1b54bcd7c15ad89c">TSPT_META_VERSION</a>&nbsp;&nbsp;&nbsp;quint8(1)</td></tr>
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TSPSG Task file metadata version. <br/></td></tr>
145<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98ea46119cfda59f7b9c6f50ef72636e"></a><!-- doxytag: member="globals.h::TSPT_META_SIZE" ref="a98ea46119cfda59f7b9c6f50ef72636e" args="" -->
146#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a98ea46119cfda59f7b9c6f50ef72636e">TSPT_META_SIZE</a>&nbsp;&nbsp;&nbsp;2</td></tr>
147<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TSPSG Task file metadata size in bytes (incl. version). <br/></td></tr>
148<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a437bcbf6414d33f7a885a4507c1b9940"></a><!-- doxytag: member="globals.h::ZKT" ref="a437bcbf6414d33f7a885a4507c1b9940" args="" -->
149#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a437bcbf6414d33f7a885a4507c1b9940">ZKT</a>&nbsp;&nbsp;&nbsp;quint16(0x5A4B)</td></tr>
150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ZKomModRd Task file signature - letters <code>ZK</code>. <br/></td></tr>
151<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6d630d0a03e4e53fceb0567653ca629"></a><!-- doxytag: member="globals.h::ZKT_VERSION" ref="ab6d630d0a03e4e53fceb0567653ca629" args="" -->
152#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#ab6d630d0a03e4e53fceb0567653ca629">ZKT_VERSION</a>&nbsp;&nbsp;&nbsp;quint8(1)</td></tr>
153<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ZKomModRd Task file version. <br/></td></tr>
154<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a956e2723d559858d08644ac99146e910">INFINITY</a>&nbsp;&nbsp;&nbsp;std::numeric_limits&lt;double&gt;::infinity()</td></tr>
155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This value means infinity :-).  <a href="#a956e2723d559858d08644ac99146e910"></a><br/></td></tr>
156<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ae8033146e07fa0bae37f148b90cd6b"></a><!-- doxytag: member="globals.h::INFSTR" ref="a1ae8033146e07fa0bae37f148b90cd6b" args="" -->
157#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a1ae8033146e07fa0bae37f148b90cd6b">INFSTR</a>&nbsp;&nbsp;&nbsp;&quot;---&quot;</td></tr>
158<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This string represents infinite value in the table. <br/></td></tr>
159<tr><td colspan="2"><h2>Functions</h2></td></tr>
160<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a594842d2fcaf774c3c42b944f3f031d2">isInteger</a> (double x)</td></tr>
161<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks whether <em>x</em> contains an integer value.  <a href="#a594842d2fcaf774c3c42b944f3f031d2"></a><br/></td></tr>
162<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="globals_8h.html#a3ffe98116f42de97041cde4a2b0404e6">toggleStyle</a> (<a class="elRef" doxygen="qt-4.6.tag:http://doc.trolltech.com/4.6/" href="http://doc.trolltech.com/4.6/qwidget.html">QWidget</a> *widget, bool enable)</td></tr>
163<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enables or disables a mask for the <em>widget</em>.  <a href="#a3ffe98116f42de97041cde4a2b0404e6"></a><br/></td></tr>
164</table>
165<hr/><a name="_details"></a><h2>Detailed Description</h2>
166<p>Contains TSPSG global defines. </p>
167<dl class="author"><dt><b>Author:</b></dt><dd>Copyright &copy; 2007-2010 Lёppa &lt;contacts[at]oleksii[dot]name&gt;</dd></dl>
168<dl class="rcs"><dt><b>Id</b></dt><dd><a class="el" href="globals_8h.html" title="Contains TSPSG global defines.">globals.h</a> 98 2010-03-12 19:28:42Z laleppa </dd></dl>
169<dl class="rcs"><dt><b>URL</b></dt><dd><a href="https://tspsg.svn.sourceforge.net/svnroot/tspsg/trunk/src/globals.h">https://tspsg.svn.sourceforge.net/svnroot/tspsg/trunk/src/globals.h</a> </dd></dl>
170<p><b>TSPSG: TSP Solver and Generator</b></p>
171<p>This file is part of TSPSG.</p>
172<p>TSPSG is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
173<p>TSPSG is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
174<p>You should have received a copy of the GNU General Public License along with TSPSG. If not, see &lt;<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;. </p>
175<hr/><h2>Define Documentation</h2>
176<a class="anchor" id="a956e2723d559858d08644ac99146e910"></a><!-- doxytag: member="globals.h::INFINITY" ref="a956e2723d559858d08644ac99146e910" args="" -->
177<div class="memitem">
178<div class="memproto">
179      <table class="memname">
180        <tr>
181          <td class="memname">#define INFINITY&nbsp;&nbsp;&nbsp;std::numeric_limits&lt;double&gt;::infinity()</td>
182        </tr>
183      </table>
184</div>
185<div class="memdoc">
186
187<p>This value means infinity :-). </p>
188<p>Some libraries already have <code>INFINITY</code> defined. We need to redefine it for the <code>INFINITY</code> to always have the same value. </p>
189
190</div>
191</div>
192<hr/><h2>Function Documentation</h2>
193<a class="anchor" id="a594842d2fcaf774c3c42b944f3f031d2"></a><!-- doxytag: member="globals.h::isInteger" ref="a594842d2fcaf774c3c42b944f3f031d2" args="(double x)" -->
194<div class="memitem">
195<div class="memproto">
196      <table class="memname">
197        <tr>
198          <td class="memname">bool isInteger </td>
199          <td>(</td>
200          <td class="paramtype">double&nbsp;</td>
201          <td class="paramname"> <em>x</em></td>
202          <td>&nbsp;)&nbsp;</td>
203          <td><code> [inline]</code></td>
204        </tr>
205      </table>
206</div>
207<div class="memdoc">
208
209<p>Checks whether <em>x</em> contains an integer value. </p>
210<dl><dt><b>Parameters:</b></dt><dd>
211  <table border="0" cellspacing="2" cellpadding="0">
212    <tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>A value to check. </td></tr>
213  </table>
214  </dd>
215</dl>
216<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if <em>x</em> countains an integer, oherwise <code>false</code>. </dd></dl>
217
218</div>
219</div>
220<a class="anchor" id="a3ffe98116f42de97041cde4a2b0404e6"></a><!-- doxytag: member="globals.h::toggleStyle" ref="a3ffe98116f42de97041cde4a2b0404e6" args="(QWidget *widget, bool enable)" -->
221<div class="memitem">
222<div class="memproto">
223      <table class="memname">
224        <tr>
225          <td class="memname">void toggleStyle </td>
226          <td>(</td>
227          <td class="paramtype"><a class="elRef" doxygen="qt-4.6.tag:http://doc.trolltech.com/4.6/" href="http://doc.trolltech.com/4.6/qwidget.html">QWidget</a> *&nbsp;</td>
228          <td class="paramname"> <em>widget</em>, </td>
229        </tr>
230        <tr>
231          <td class="paramkey"></td>
232          <td></td>
233          <td class="paramtype">bool&nbsp;</td>
234          <td class="paramname"> <em>enable</em></td><td>&nbsp;</td>
235        </tr>
236        <tr>
237          <td></td>
238          <td>)</td>
239          <td></td><td></td><td></td>
240        </tr>
241      </table>
242</div>
243<div class="memdoc">
244
245<p>Enables or disables a mask for the <em>widget</em>. </p>
246<dl><dt><b>Parameters:</b></dt><dd>
247  <table border="0" cellspacing="2" cellpadding="0">
248    <tr><td valign="top"></td><td valign="top"><em>widget</em>&nbsp;</td><td>A widget to toggle mask on. </td></tr>
249    <tr><td valign="top"></td><td valign="top"><em>enable</em>&nbsp;</td><td>Set to <code>true</code> to enable mask or <code>false</code> to disable it.</td></tr>
250  </table>
251  </dd>
252</dl>
253<p>This function is used to enable an outlined font effect for <code><a class="elRef" doxygen="qt-4.6.tag:http://doc.trolltech.com/4.6/" href="http://doc.trolltech.com/4.6/qlabel.html">QLabel</a></code> with a static text. </p>
254
255<p><div class="dynheader">
256Here is the call graph for this function:</div>
257<div class="dynsection">
258<div class="center"><img src="globals_8h_a3ffe98116f42de97041cde4a2b0404e6_cgraph.png" border="0" usemap="#globals_8h_a3ffe98116f42de97041cde4a2b0404e6_cgraph_map" alt=""></div>
259<map name="globals_8h_a3ffe98116f42de97041cde4a2b0404e6_cgraph_map" id="globals_8h_a3ffe98116f42de97041cde4a2b0404e6_cgraph">
260<area shape="rect" id="node3" doxygen="qt-4.6.tag:http://doc.trolltech.com/4.6/" href="http://doc.trolltech.com/4.6/qwidget.html#window" title="QWidget::window" alt="" coords="141,5,264,33"/>
261</map>
262</div>
263</p>
264
265</div>
266</div>
267</div>
268<!--- window showing the filter options -->
269<div id="MSearchSelectWindow"
270     onmouseover="return searchBox.OnSearchSelectShow()"
271     onmouseout="return searchBox.OnSearchSelectHide()"
272     onkeydown="return searchBox.OnSearchSelectKey(event)">
273<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>
274
275<!-- iframe showing the search results (closed by default) -->
276<div id="MSearchResultsWindow">
277<iframe src="" frameborder="0" 
278        name="MSearchResults" id="MSearchResults">
279</iframe>
280</div>
281
282<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Apr 8 23:15:53 2010 for TSPSG: TSP Solver and Generator by&nbsp;
283<a href="http://www.doxygen.org/index.html">
284<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
285</body>
286</html>
Note: See TracBrowser for help on using the repository browser.