source: tspsg-svn/trunk/docs/html/structs_step.html @ 68

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

Adding documentation generated by doxygen.
File size: 10.2 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: sStep Struct 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
64      <li><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="annotated.html"><span>Class&nbsp;List</span></a></li>
83      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
84    </ul>
85  </div>
86</div>
87<div class="contents">
88<h1>sStep Struct Reference</h1><!-- doxytag: class="sStep" -->
89<p>This structure represents one step of solving. 
90<a href="#_details">More...</a></p>
91
92<p><code>#include &lt;<a class="el" href="tspsolver_8h_source.html">tspsolver.h</a>&gt;</code></p>
93<div class="dynheader">
94Collaboration diagram for sStep:</div>
95<div class="dynsection">
96<div class="center"><img src="structs_step__coll__graph.png" border="0" usemap="#s_step_coll__map" alt="Collaboration graph"/></div>
97<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
98
99<p><a href="structs_step-members.html">List of all members.</a></p>
100<table border="0" cellpadding="0" cellspacing="0">
101<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
102<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa172f0fca5234cfa240121e6363e6951"></a><!-- doxytag: member="sStep::sStep" ref="aa172f0fca5234cfa240121e6363e6951" args="()" -->
103&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structs_step.html#aa172f0fca5234cfa240121e6363e6951">sStep</a> ()</td></tr>
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assigns default values. <br/></td></tr>
105<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
106<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b16ffd0c21e19482d8080559a4ebea7"></a><!-- doxytag: member="sStep::matrix" ref="a0b16ffd0c21e19482d8080559a4ebea7" args="" -->
107<a class="el" href="tspsolver_8h.html#a96b95c574161e5013286210c96c581ba">tMatrix</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structs_step.html#a0b16ffd0c21e19482d8080559a4ebea7">matrix</a></td></tr>
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This step's matrix. <br/></td></tr>
109<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="addaeb82c9ddd12c50b753ad2988ceafc"></a><!-- doxytag: member="sStep::price" ref="addaeb82c9ddd12c50b753ad2988ceafc" args="" -->
110double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structs_step.html#addaeb82c9ddd12c50b753ad2988ceafc">price</a></td></tr>
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The price of travel to this step. <br/></td></tr>
112<tr><td class="memItemLeft" ><a class="anchor" id="a46e252aac4c84cc53d412c76f63fa6fd"></a><!-- doxytag: member="sStep::candidate" ref="a46e252aac4c84cc53d412c76f63fa6fd" args="" -->
113struct {</td></tr>
114<tr><td class="memItemLeft" >&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;<a class="el" href="structs_step.html#afa2175a8daa72a3b0cb510b4dd41b3e2">nRow</a></td></tr>
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A zero-based row number of the candidate. <br/></td></tr>
116<tr><td class="memItemLeft" >&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;<a class="el" href="structs_step.html#a907c1872b0e7881130f0034145169fb1">nCol</a></td></tr>
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A zero-based column number of the candidate. <br/></td></tr>
118<tr><td class="memItemLeft" valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structs_step.html#a46e252aac4c84cc53d412c76f63fa6fd">candidate</a></td></tr>
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A candiadate for branching in the current matrix. <br/></td></tr>
120<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabaeab5d890e4497a76c7a30a3f85cfa"></a><!-- doxytag: member="sStep::alts" ref="aabaeab5d890e4497a76c7a30a3f85cfa" args="" -->
121bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structs_step.html#aabaeab5d890e4497a76c7a30a3f85cfa">alts</a></td></tr>
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indicates whether or not matrix has alternative candidates. <br/></td></tr>
123<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a984255a80c651dff62ac9571079a53"></a><!-- doxytag: member="sStep::plNode" ref="a7a984255a80c651dff62ac9571079a53" args="" -->
124<a class="el" href="structs_step.html">sStep</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structs_step.html#a7a984255a80c651dff62ac9571079a53">plNode</a></td></tr>
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointer to the left branch step. <br/></td></tr>
126<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f14c4a0df25ba8b109c6732d4a68216"></a><!-- doxytag: member="sStep::prNode" ref="a9f14c4a0df25ba8b109c6732d4a68216" args="" -->
127<a class="el" href="structs_step.html">sStep</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structs_step.html#a9f14c4a0df25ba8b109c6732d4a68216">prNode</a></td></tr>
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointer to the right branch step. <br/></td></tr>
129</table>
130<hr/><a name="_details"></a><h2>Detailed Description</h2>
131<p>This structure represents one step of solving. </p>
132<p>A tree of such elements will represent the solving process. </p>
133<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>TODO: List alternative candidates. </dd></dl>
134<hr/>The documentation for this struct was generated from the following file:<ul>
135<li>src/<a class="el" href="tspsolver_8h_source.html">tspsolver.h</a></li>
136</ul>
137</div>
138<!--- window showing the filter options -->
139<div id="MSearchSelectWindow"
140     onmouseover="return searchBox.OnSearchSelectShow()"
141     onmouseout="return searchBox.OnSearchSelectHide()"
142     onkeydown="return searchBox.OnSearchSelectKey(event)">
143<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>
144
145<!-- iframe showing the search results (closed by default) -->
146<div id="MSearchResultsWindow">
147<iframe src="" frameborder="0" 
148        name="MSearchResults" id="MSearchResults">
149</iframe>
150</div>
151
152<hr size="1"/><address style="text-align: right;"><small>Generated on Sat Oct 24 16:33:19 2009 for TSPSG: TSP Solver and Generator by&nbsp;
153<a href="http://www.doxygen.org/index.html">
154<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
155</body>
156</html>
Note: See TracBrowser for help on using the repository browser.