diff options
Diffstat (limited to 'docs/html/class_maze_math.html')
| -rw-r--r-- | docs/html/class_maze_math.html | 288 |
1 files changed, 288 insertions, 0 deletions
diff --git a/docs/html/class_maze_math.html b/docs/html/class_maze_math.html new file mode 100644 index 0000000..1f53f7f --- /dev/null +++ b/docs/html/class_maze_math.html @@ -0,0 +1,288 @@ +<!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>Rally X: MazeMath Class Reference</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> + +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + <td id="projectlogo"><img alt="Logo" src="car.PNG"/></td> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">Rally X + + </div> + <div id="projectbrief">ELEN3009 Project by Justin Wernick and David Schneider</div> + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.5.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="header"> + <div class="summary"> +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="#pri-methods">Private Member Functions</a> </div> + <div class="headertitle"> +<div class="title">MazeMath Class Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="MazeMath" --> +<p>Class of static methods for common math functions that occur in the 2D maze setting. + <a href="class_maze_math.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_maze_math_8h_source.html">MazeMath.h</a>></code></p> + +<p><a href="class_maze_math-members.html">List of all members.</a></p> +<table class="memberdecls"> +<tr><td colspan="2"><h2><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze_math.html#a2314f211065f4dc7cb11469770fd2f1c">round</a> (double value)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Rounds a value to the nearest integer. <a href="#a2314f211065f4dc7cb11469770fd2f1c"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze_math.html#a5735276fb4c76f25944f2c02d622c3f6">distance</a> (double x1, double y1, double x2, double y2)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds the straight line distance between two points on a 2D plane. <a href="#a5735276fb4c76f25944f2c02d622c3f6"></a><br/></td></tr> +<tr><td colspan="2"><h2><a name="pri-methods"></a> +Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze_math.html#ac85f1216ce8dc44bc2fb4483b3f4a128">MazeMath</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unimplemented constructor. <a href="#ac85f1216ce8dc44bc2fb4483b3f4a128"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze_math.html#a8e1499b201cd7034b4a73ed180a87eda">MazeMath</a> (const <a class="el" href="class_maze_math.html">MazeMath</a> &ref)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unimplemented copy constructor. <a href="#a8e1499b201cd7034b4a73ed180a87eda"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_maze_math.html">MazeMath</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze_math.html#ac7cf69d865cf69b82c991241fa39cd59">operator=</a> (const <a class="el" href="class_maze_math.html">MazeMath</a> &rhs)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unimplemented assignment operator. <a href="#ac7cf69d865cf69b82c991241fa39cd59"></a><br/></td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"><p>Class of static methods for common math functions that occur in the 2D maze setting. </p> +<dl class="author"><dt><b>Author:</b></dt><dd>Justin Wernick </dd> +<dd> +David Schneider </dd></dl> + +<p>Definition at line <a class="el" href="_maze_math_8h_source.html#l00012">12</a> of file <a class="el" href="_maze_math_8h_source.html">MazeMath.h</a>.</p> +</div><hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="ac85f1216ce8dc44bc2fb4483b3f4a128"></a><!-- doxytag: member="MazeMath::MazeMath" ref="ac85f1216ce8dc44bc2fb4483b3f4a128" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MazeMath::MazeMath </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Unimplemented constructor. </p> +<p>being a grouping of static functions, construction and destruction of <a class="el" href="class_maze_math.html" title="Class of static methods for common math functions that occur in the 2D maze setting.">MazeMath</a> objects is unneccesary. </p> + +</div> +</div> +<a class="anchor" id="a8e1499b201cd7034b4a73ed180a87eda"></a><!-- doxytag: member="MazeMath::MazeMath" ref="a8e1499b201cd7034b4a73ed180a87eda" args="(const MazeMath &ref)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">MazeMath::MazeMath </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_maze_math.html">MazeMath</a> & </td> + <td class="paramname"><em>ref</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Unimplemented copy constructor. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a5735276fb4c76f25944f2c02d622c3f6"></a><!-- doxytag: member="MazeMath::distance" ref="a5735276fb4c76f25944f2c02d622c3f6" args="(double x1, double y1, double x2, double y2)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">double MazeMath::distance </td> + <td>(</td> + <td class="paramtype">double </td> + <td class="paramname"><em>x1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double </td> + <td class="paramname"><em>y1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double </td> + <td class="paramname"><em>x2</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double </td> + <td class="paramname"><em>y2</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Finds the straight line distance between two points on a 2D plane. </p> +<p>Implemented using Pythagoras' Theorem.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">x1</td><td>The x coordinate of the first point. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">y1</td><td>The y coordinate of the first point. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">x2</td><td>The x coordinate of the second point. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">y2</td><td>The y coordinate of the second point.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>The distance between the two given points. </dd></dl> + +<p>Definition at line <a class="el" href="_maze_math_8cpp_source.html#l00015">15</a> of file <a class="el" href="_maze_math_8cpp_source.html">MazeMath.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="ac7cf69d865cf69b82c991241fa39cd59"></a><!-- doxytag: member="MazeMath::operator=" ref="ac7cf69d865cf69b82c991241fa39cd59" args="(const MazeMath &rhs)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_maze_math.html">MazeMath</a>& MazeMath::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_maze_math.html">MazeMath</a> & </td> + <td class="paramname"><em>rhs</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Unimplemented assignment operator. </p> + +</div> +</div> +<a class="anchor" id="a2314f211065f4dc7cb11469770fd2f1c"></a><!-- doxytag: member="MazeMath::round" ref="a2314f211065f4dc7cb11469770fd2f1c" args="(double value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">double MazeMath::round </td> + <td>(</td> + <td class="paramtype">double </td> + <td class="paramname"><em>value</em></td><td>)</td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Rounds a value to the nearest integer. </p> +<p>Values with a decimal fraction less than 0.5 are floored, while values with a decimal fraction greater than or eqaul to 0.5 are ceiled.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be rounded off.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>The rounded off version of the given value. </dd></dl> + +<p>Definition at line <a class="el" href="_maze_math_8cpp_source.html#l00003">3</a> of file <a class="el" href="_maze_math_8cpp_source.html">MazeMath.cpp</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>source/logic/<a class="el" href="_maze_math_8h_source.html">MazeMath.h</a></li> +<li>source/logic/<a class="el" href="_maze_math_8cpp_source.html">MazeMath.cpp</a></li> +</ul> +</div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + + + +<hr class="footer"/><address class="footer"><small> +Generated on Wed Oct 5 2011 20:08:31 for Rally X by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.7.5.1 +</small></address> + +</body> +</html> |