geosolver/doc/pydoc/geosolver.configuration.html

108 lines
8.1 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module geosolver.configuration</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="geosolver.html"><font color="#ffffff">geosolver</font></a>.configuration</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/rick/Programming/Python/GeoSolver/geosolver/configuration.py">/home/rick/Programming/Python/GeoSolver/geosolver/configuration.py</a></font></td></tr></table>
<p><tt>This&nbsp;module&nbsp;provides&nbsp;a&nbsp;<a href="#Configuration">Configuration</a>&nbsp;class.&nbsp;<br>
&nbsp;<br>
A&nbsp;configuration&nbsp;is&nbsp;a&nbsp;set&nbsp;of&nbsp;named&nbsp;points&nbsp;with&nbsp;coordinates.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="math.html">math</a><br>
</td><td width="25%" valign=top><a href="re.html">re</a><br>
</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
</td><td width="25%" valign=top><a href="geosolver.vector.html">geosolver.vector</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="geosolver.configuration.html#Configuration">Configuration</a>
</font></dt></dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Configuration">class <strong>Configuration</strong></a></font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>A&nbsp;set&nbsp;of&nbsp;named&nbsp;points&nbsp;with&nbsp;coordinates&nbsp;of&nbsp;a&nbsp;specified&nbsp;dimension.&nbsp;<br>
&nbsp;<br>
Immutable.&nbsp;Defines&nbsp;equality&nbsp;and&nbsp;a&nbsp;hash&nbsp;function.&nbsp;<br>
&nbsp;<br>
Attributes:&nbsp;<br>
map&nbsp;-&nbsp;a&nbsp;dictionary&nbsp;mapping&nbsp;variable&nbsp;names&nbsp;to&nbsp;point&nbsp;values.<br>
dimension&nbsp;-&nbsp;the&nbsp;dimension&nbsp;of&nbsp;the&nbsp;space&nbsp;in&nbsp;which&nbsp;the&nbsp;configuration&nbsp;is&nbsp;embedded<br>
underconstrained&nbsp;-&nbsp;flag&nbsp;indicating&nbsp;an&nbsp;underconstrained&nbsp;merge&nbsp;(not&nbsp;a&nbsp;unique&nbsp;solution)<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Configuration-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>two&nbsp;configurations&nbsp;are&nbsp;equal&nbsp;if&nbsp;they&nbsp;map&nbsp;onto&nbsp;eachother&nbsp;modulo&nbsp;rotation&nbsp;and&nbsp;translation</tt></dd></dl>
<dl><dt><a name="Configuration-__hash__"><strong>__hash__</strong></a>(self)</dt></dl>
<dl><dt><a name="Configuration-__init__"><strong>__init__</strong></a>(self, map)</dt><dd><tt>instantiate&nbsp;a&nbsp;<a href="#Configuration">Configuration</a></tt></dd></dl>
<dl><dt><a name="Configuration-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Configuration-add"><strong>add</strong></a>(self, c)</dt><dd><tt>return&nbsp;a&nbsp;new&nbsp;configuration&nbsp;which&nbsp;is&nbsp;this&nbsp;configuration&nbsp;extended&nbsp;with&nbsp;all&nbsp;points&nbsp;in&nbsp;c&nbsp;not&nbsp;in&nbsp;this&nbsp;configuration</tt></dd></dl>
<dl><dt><a name="Configuration-checkdimension"><strong>checkdimension</strong></a>(self)</dt><dd><tt>returns&nbsp;the&nbsp;dimension&nbsp;of&nbsp;the&nbsp;points,&nbsp;or&nbsp;zero&nbsp;if&nbsp;they&nbsp;are&nbsp;of&nbsp;different&nbsp;dimensions</tt></dd></dl>
<dl><dt><a name="Configuration-copy"><strong>copy</strong></a>(self)</dt><dd><tt>returns&nbsp;a&nbsp;shallow&nbsp;copy</tt></dd></dl>
<dl><dt><a name="Configuration-get"><strong>get</strong></a>(self, var)</dt><dd><tt>return&nbsp;position&nbsp;of&nbsp;point&nbsp;var</tt></dd></dl>
<dl><dt><a name="Configuration-makehash"><strong>makehash</strong></a>(self)</dt><dd><tt>the&nbsp;hash&nbsp;is&nbsp;based&nbsp;only&nbsp;on&nbsp;variable&nbsp;names&nbsp;(not&nbsp;values)</tt></dd></dl>
<dl><dt><a name="Configuration-merge"><strong>merge</strong></a>(self, other)</dt><dd><tt>returns&nbsp;a&nbsp;new&nbsp;configurations&nbsp;which&nbsp;is&nbsp;this&nbsp;one&nbsp;plus&nbsp;the&nbsp;given&nbsp;other&nbsp;configuration&nbsp;transformed,&nbsp;such&nbsp;that&nbsp;common&nbsp;points&nbsp;will&nbsp;overlap&nbsp;(if&nbsp;possible).</tt></dd></dl>
<dl><dt><a name="Configuration-merge_scale"><strong>merge_scale</strong></a>(self, other)</dt><dd><tt>returns&nbsp;a&nbsp;new&nbsp;configurations&nbsp;which&nbsp;is&nbsp;this&nbsp;one&nbsp;plus&nbsp;the&nbsp;given&nbsp;other&nbsp;configuration&nbsp;transformed,&nbsp;such&nbsp;that&nbsp;common&nbsp;points&nbsp;will&nbsp;overlap&nbsp;(if&nbsp;possible).</tt></dd></dl>
<dl><dt><a name="Configuration-merge_scale_2D"><strong>merge_scale_2D</strong></a>(self, other, vars<font color="#909090">=[]</font>)</dt><dd><tt>returns&nbsp;a&nbsp;new&nbsp;configurations&nbsp;which&nbsp;is&nbsp;this&nbsp;one&nbsp;plus&nbsp;the&nbsp;given&nbsp;other&nbsp;configuration&nbsp;transformed,&nbsp;such&nbsp;that&nbsp;common&nbsp;points&nbsp;will&nbsp;overlap&nbsp;(if&nbsp;possible).</tt></dd></dl>
<dl><dt><a name="Configuration-merge_scale_transform"><strong>merge_scale_transform</strong></a>(self, other)</dt></dl>
<dl><dt><a name="Configuration-merge_transform"><strong>merge_transform</strong></a>(self, other)</dt></dl>
<dl><dt><a name="Configuration-select"><strong>select</strong></a>(self, vars)</dt><dd><tt>return&nbsp;a&nbsp;new&nbsp;configuration&nbsp;that&nbsp;is&nbsp;a&nbsp;subconfiguration&nbsp;of&nbsp;this&nbsp;configuration,&nbsp;containing&nbsp;only&nbsp;the&nbsp;selected&nbsp;variables</tt></dd></dl>
<dl><dt><a name="Configuration-transform"><strong>transform</strong></a>(self, t)</dt><dd><tt>returns&nbsp;a&nbsp;new&nbsp;configuration,&nbsp;which&nbsp;is&nbsp;this&nbsp;one&nbsp;transformed&nbsp;by&nbsp;matrix&nbsp;t</tt></dd></dl>
<dl><dt><a name="Configuration-vars"><strong>vars</strong></a>(self)</dt><dd><tt>return&nbsp;list&nbsp;of&nbsp;variables</tt></dd></dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt><a name="-perp2D"><strong>perp2D</strong></a>(v)</dt></dl>
<dl><dt><a name="-test"><strong>test</strong></a>()</dt></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>NegInf</strong> = geosolver.tolerance.NegInf<br>
<strong>PosInf</strong> = geosolver.tolerance.PosInf<br>
<strong>default_tol</strong> = 9.9999999999999995e-07<br>
<strong>diag_selector</strong> = &lt;_sre.SRE_Pattern object at 0xb7ec9b60&gt;<br>
<strong>diag_stream</strong> = &lt;open file '&lt;stdout&gt;', mode 'w' at 0xb7eb3068&gt;</td></tr></table>
</body></html>