Quellcodebibliothek Statistik Leitseite products/Sources/formale Sprachen/GAP/pkg/simpcomp/doc/   (Algebra von RWTH Aachen Version 4.15.1©)  Datei vom 18.2.2022 mit Größe 20 kB image not shown  

Quelle  chap18.html   Sprache: HTML

 
 products/Sources/formale Sprachen/GAP/pkg/simpcomp/doc/chap18.html


<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>GAP (simpcomp) - Chapter 18: simpcomp internals</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta name="generator" content="GAPDoc2HTML" />
<link rel="stylesheet" type="text/css" href="manual.css" />
<script src="manual.js" type="text/javascript"></script>
<script type="text/javascript">overwriteStyle();</script>
</head>
<body class="chap18"  onload="jscontent()">


<div class="chlinktop"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chap4.html">4</a>  <a href="chap5.html">5</a>  <a href="chap6.html">6</a>  <a href="chap7.html">7</a>  <a href="chap8.html">8</a>  <a href="chap9.html">9</a>  <a href="chap10.html">10</a>  <a href="chap11.html">11</a>  <a href="chap12.html">12</a>  <a href="chap13.html">13</a>  <a href="chap14.html">14</a>  <a href="chap15.html">15</a>  <a href="chap16.html">16</a>  <a href="chap17.html">17</a>  <a href="chap18.html">18</a>  <a href="chapBib.html">Bib</a>  <a href="chapInd.html">Ind</a>  </div>

<div class="chlinkprevnexttop"> <a href="chap0.html">[Top of Book]</a>   <a href="chap0.html#contents">[Contents]</a>    <a href="chap17.html">[Previous Chapter]</a>    <a href="chapBib.html">[Next Chapter]</a>   </div>

<p id="mathjaxlink" class="pcenter"><a href="chap18_mj.html">[MathJax on]</a></p>
<p><a id="X8478539A7A292D1A" name="X8478539A7A292D1A"></a></p>
<div class="ChapSects"><a href="chap18.html#X8478539A7A292D1A">18 <span class="Heading"><strong class="pkg">simpcomp</strong> internals</span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap18.html#X8724C47486F7CC1E">18.1 <span class="Heading">The <strong class="pkg">GAP</strong> object type <code class="code">SCPropertyObject</code></span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X7AFC8525796297C9">18.1-1 SCProperties</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X868776A48419FA88">18.1-2 SCPropertiesFlush</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X7C92D8187B5C1EF6">18.1-3 SCPropertiesManaged</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X82EA577A830E0826">18.1-4 SCPropertiesNames</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X7A52957C7B183855">18.1-5 SCPropertiesTmp</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X797A290E8665E6D0">18.1-6 SCPropertiesTmpNames</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X8211194D85D30B32">18.1-7 SCPropertyByName</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X8304C9BC7E8CF4F8">18.1-8 SCPropertyDrop</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X7FC306B28335BFDC">18.1-9 SCPropertyHandlersSet</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X86FEBD517B7963C6">18.1-10 SCPropertySet</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X798E9C9C7895C9F0">18.1-11 SCPropertySetMutable</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X78D646707A17AC62">18.1-12 SCPropertyTmpByName</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X836F936B7E09E5F1">18.1-13 SCPropertyTmpDrop</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap18.html#X86CF3B9585A965A0">18.1-14 SCPropertyTmpSet</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap18.html#X862DE7827D3D9F95">18.2 <span class="Heading">Example of a common attribute</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap18.html#X7888C5D97F4E8F85">18.3 <span class="Heading">Writing a method for an attribute</span></a>
</span>
</div>
</div>

<h3>18 <span class="Heading"><strong class="pkg">simpcomp</strong> internals</span></h3>

<p>The package <strong class="pkg">simpcomp</strong> works with geometric objects for which the <strong class="pkg">GAP</strong> object types <code class="code">SCSimplicialComplex</code> and <code class="code">SCNormalSurface</code> are defined and calculates properties of these objects via so called property handlers. This chapter describes how to extend <strong class="pkg">simpcomp</strong> by writing own property handlers.</p>

<p>If you extended <strong class="pkg">simpcomp</strong> and want to share your extension with other users please send your extension to one of the authors and we will consider including it (of course with giving credit) in a future release of <strong class="pkg">simpcomp</strong>.</p>

<p><a id="X8724C47486F7CC1E" name="X8724C47486F7CC1E"></a></p>

<h4>18.1 <span class="Heading">The <strong class="pkg">GAP</strong> object type <code class="code">SCPropertyObject</code></span></h4>

<p>In the following, we present a number of functions to manage a <strong class="pkg">GAP</strong> object of type <code class="code">SCPropertyObject</code>. Since most properties of <code class="code">SCPolyhedralComplex</code>, <code class="code">SCSimplicialComplex</code> and <code class="code">SCNormalSurface</code> are managed by the GAP4 type system (cf. <a href="chapBib.html#biBBreuer98GAP4TypeSystem">[BL98]</a>), the functions described below are mainly used by the object type <code class="code">SCLibRepository</code> and to store temporary properties.</p>

<p><a id="X7AFC8525796297C9" name="X7AFC8525796297C9"></a></p>

<h5>18.1-1 SCProperties</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCProperties</code>( <var class="Arg">po</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: a record upon success.</p>

<p>Returns the record of all stored properties of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var>.</p>

<p><a id="X868776A48419FA88" name="X868776A48419FA88"></a></p>

<h5>18.1-2 SCPropertiesFlush</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertiesFlush</code>( <var class="Arg">po</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> upon success.</p>

<p>Drops all properties and temporary properties of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var>.</p>

<p><a id="X7C92D8187B5C1EF6" name="X7C92D8187B5C1EF6"></a></p>

<h5>18.1-3 SCPropertiesManaged</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertiesManaged</code>( <var class="Arg">po</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: a list of managed properties upon success, <code class="keyw">fail</code> otherwise.</p>

<p>Returns a list of all properties that are managed for the <code class="code">SCPropertyObject</code> <var class="Arg">po</var> via property handler functions. See <code class="func">SCPropertyHandlersSet</code> (<a href="chap18.html#X7FC306B28335BFDC"><span class="RefLink">18.1-9</span></a>).</p>

<p><a id="X82EA577A830E0826" name="X82EA577A830E0826"></a></p>

<h5>18.1-4 SCPropertiesNames</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertiesNames</code>( <var class="Arg">po</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: a list upon success.</p>

<p>Returns a list of all the names of the stored properties of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var>. These can be accessed via <code class="func">SCPropertySet</code> (<a href="chap18.html#X86FEBD517B7963C6"><span class="RefLink">18.1-10</span></a>) and <code class="func">SCPropertyDrop</code> (<a href="chap18.html#X8304C9BC7E8CF4F8"><span class="RefLink">18.1-8</span></a>).</p>

<p><a id="X7A52957C7B183855" name="X7A52957C7B183855"></a></p>

<h5>18.1-5 SCPropertiesTmp</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertiesTmp</code>( <var class="Arg">po</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: a record upon success.</p>

<p>Returns the record of all stored temporary properties (these are mutable in contrast to regular properties and not serialized when the object is serialized to XML) of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var>.</p>

<p><a id="X797A290E8665E6D0" name="X797A290E8665E6D0"></a></p>

<h5>18.1-6 SCPropertiesTmpNames</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertiesTmpNames</code>( <var class="Arg">po</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: a list upon success.</p>

<p>Returns a list of all the names of the stored temporary properties of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var>. These can be accessed via <code class="func">SCPropertyTmpSet</code> (<a href="chap18.html#X86CF3B9585A965A0"><span class="RefLink">18.1-14</span></a>) and <code class="func">SCPropertyTmpDrop</code> (<a href="chap18.html#X836F936B7E09E5F1"><span class="RefLink">18.1-13</span></a>).</p>

<p><a id="X8211194D85D30B32" name="X8211194D85D30B32"></a></p>

<h5>18.1-7 SCPropertyByName</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertyByName</code>( <var class="Arg">po</var>, <var class="Arg">name</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: any value upon success, <code class="keyw">fail</code> otherwise.</p>

<p>Returns the value of the property with name <var class="Arg">name</var> of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var> if this property is known for <var class="Arg">po</var> and <code class="keyw">fail</code> otherwise. The names of known properties can be accessed via the function <code class="func">SCPropertiesNames</code> (<a href="chap18.html#X82EA577A830E0826"><span class="RefLink">18.1-4</span></a>)</p>

<p><a id="X8304C9BC7E8CF4F8" name="X8304C9BC7E8CF4F8"></a></p>

<h5>18.1-8 SCPropertyDrop</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertyDrop</code>( <var class="Arg">po</var>, <var class="Arg">name</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> upopn success, <code class="keyw">fail</code> otherwise</p>

<p>Drops the property with name <var class="Arg">name</var> of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var>. Returns <code class="keyw">true</code> if the property is successfully dropped and <code class="keyw">fail</code> if a property with that name did not exist.</p>

<p><a id="X7FC306B28335BFDC" name="X7FC306B28335BFDC"></a></p>

<h5>18.1-9 SCPropertyHandlersSet</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertyHandlersSet</code>( <var class="Arg">po</var>, <var class="Arg">handlers</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code></p>

<p>Sets the property handling functions for a SCPropertyObject <var class="Arg">po</var> to the functions described in the record <var class="Arg">handlers</var>. The record <var class="Arg">handlers</var> has to contain entries of the following structure: <code class="code">[Property Name]:=[Function name computing and returning the property]</code>. For <code class="code">SCSimplicialComplex</code> for example <strong class="pkg">simpcomp</strong> defines (among many others): <code class="code">F:=SCFVector</code>. See the file <code class="code">lib/prophandler.gd</code>.</p>

<p><a id="X86FEBD517B7963C6" name="X86FEBD517B7963C6"></a></p>

<h5>18.1-10 SCPropertySet</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertySet</code>( <var class="Arg">po</var>, <var class="Arg">name</var>, <var class="Arg">data</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> upon success.</p>

<p>Sets the value of the property with name <var class="Arg">name</var> of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var> to <var class="Arg">data</var>. Note that the argument becomes immutable. If this behaviour is not desired, use <code class="func">SCPropertySetMutable</code> (<a href="chap18.html#X798E9C9C7895C9F0"><span class="RefLink">18.1-11</span></a>) instead.</p>

<p><a id="X798E9C9C7895C9F0" name="X798E9C9C7895C9F0"></a></p>

<h5>18.1-11 SCPropertySetMutable</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertySetMutable</code>( <var class="Arg">po</var>, <var class="Arg">name</var>, <var class="Arg">data</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> upon success.</p>

<p>Sets the value of the property with name <var class="Arg">name</var> of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var> to <var class="Arg">data</var>. Note that the argument does not become immutable. If this behaviour is not desired, use <code class="func">SCPropertySet</code> (<a href="chap18.html#X86FEBD517B7963C6"><span class="RefLink">18.1-10</span></a>) instead.</p>

<p><a id="X78D646707A17AC62" name="X78D646707A17AC62"></a></p>

<h5>18.1-12 SCPropertyTmpByName</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertyTmpByName</code>( <var class="Arg">po</var>, <var class="Arg">name</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: any value upon success, <code class="keyw">fail</code> otherwise.</p>

<p>Returns the value of the temporary property with the name <var class="Arg">name</var> of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var> if this temporary property is known for <var class="Arg">po</var> and <code class="keyw">fail</code> otherwise. The names of known temporary properties can be accessed via the function <code class="func">SCPropertiesTmpNames</code> (<a href="chap18.html#X797A290E8665E6D0"><span class="RefLink">18.1-6</span></a>)</p>

<p><a id="X836F936B7E09E5F1" name="X836F936B7E09E5F1"></a></p>

<h5>18.1-13 SCPropertyTmpDrop</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertyTmpDrop</code>( <var class="Arg">po</var>, <var class="Arg">name</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> upon success, <code class="keyw">fail</code> otherwise</p>

<p>Drops the temporary property with name <var class="Arg">name</var> of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var>. Returns <code class="keyw">true</code> if the property is successfully dropped and <code class="keyw">fail</code> if a temporary property with that name did not exist.</p>

<p><a id="X86CF3B9585A965A0" name="X86CF3B9585A965A0"></a></p>

<h5>18.1-14 SCPropertyTmpSet</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCPropertyTmpSet</code>( <var class="Arg">po</var>, <var class="Arg">name</var>, <var class="Arg">data</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> upon success.</p>

<p>Sets the value of the temporary property with name <var class="Arg">name</var> of the <code class="code">SCPropertyObject</code> <var class="Arg">po</var> to <var class="Arg">data</var>. Note that the argument does not become immutable. This is the standard behaviour for temporary properties.</p>

<p><a id="X862DE7827D3D9F95" name="X862DE7827D3D9F95"></a></p>

<h4>18.2 <span class="Heading">Example of a common attribute</span></h4>

<p>In this section we will have a look at the property handler <code class="func">SCEulerCharacteristic</code> (<a href="chap7.html#X788BAE187D584103"><span class="RefLink">7.3-3</span></a>) in order to explain the inner workings of property handlers. This is the code of the property handler for calculating the Euler characteristic of a complex in <strong class="pkg">simpcomp</strong>:</p>


<div class="example"><pre>
DeclareAttribute("SCEulerCharacteristic",SCIsPolyhedralComplex);

InstallMethod(SCEulerCharacteristic,
"for SCSimplicialComplex",
[SCIsSimplicialComplex],
function(complex)

 local  f, chi, i;

 f:=SCFVector(complex);
 if f=fail then
  return fail;
 fi;
 chi:=0;

 for i in [1..Size(f)] do
   chi:=chi + ((-1)^(i+1))*f[i];
 od;

 return chi;
end);

InstallMethod(SCEulerCharacteristic,
"for SCNormalSurface",
[SCIsNormalSurface],
function(sl)

  local facets, f, chi;

   
  f:=SCFVector(sl);
  if(f=fail) then
   return fail;
  fi;
 
 if Length(f) = 1 then
    return f[1];
 elif Length(f) =3 then
     return f[1]-f[2]+f[3];
  elif Length(f) =4 then
     return f[1]-f[2]+f[3]+f[4];
  else
   Info(InfoSimpcomp,1,"SCEulerCharacteristic: illegal f-vector found: ",f,". ");
   return fail;
  fi;

end);

</pre></div>

<p>When looking at the code one already sees the structure that such a handler needs to have:</p>

<ol>
<li><p>Each property handler (a GAP operation) needs to be defined. This is done by the first line of code. Once an operation is defined, multiple methods can by implemented for various types of GAP objects (here two methods are implemented for the GAP object types <code class="code">SCSimplicialComplex</code> and <code class="code">SCNormalSurface</code>).</p>

</li>
<li><p>First note that the validity of the arguments is checked by GAP. For example, the first method only accepts an argument of type <code class="code">SCSimplicialComplex</code>.</p>

</li>
<li><p>If the property was already computed, the GAP4 type system automatically returns the cached property avoiding unnecessary double calculations.</p>

</li>
<li><p>If the property is not already known. it is computed and returned (and automatically cached by the GAP4 type system).</p>

</li>
</ol>
<p><a id="X7888C5D97F4E8F85" name="X7888C5D97F4E8F85"></a></p>

<h4>18.3 <span class="Heading">Writing a method for an attribute</span></h4>

<p>This section provides the skeleton of a method that can be used when writing own methods:</p>


<div class="example"><pre>
DeclareAttribute("SCMyPropertyHandler",SCPolyhedralComplex);

InstallMethod(SCMyPropertyHandler,
"for SCSimplicialComplex[ and further arguments]",
[SCIsSimplicialComplex[, further arguments]],
function(complex[, further arguments])

 local myprop, ...;

 # compute the property
 [ do property computation here]

 return myprop;
end);
</pre></div>


<div class="chlinkprevnextbot"> <a href="chap0.html">[Top of Book]</a>   <a href="chap0.html#contents">[Contents]</a>    <a href="chap17.html">[Previous Chapter]</a>    <a href="chapBib.html">[Next Chapter]</a>   </div>


<div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chap4.html">4</a>  <a href="chap5.html">5</a>  <a href="chap6.html">6</a>  <a href="chap7.html">7</a>  <a href="chap8.html">8</a>  <a href="chap9.html">9</a>  <a href="chap10.html">10</a>  <a href="chap11.html">11</a>  <a href="chap12.html">12</a>  <a href="chap13.html">13</a>  <a href="chap14.html">14</a>  <a href="chap15.html">15</a>  <a href="chap16.html">16</a>  <a href="chap17.html">17</a>  <a href="chap18.html">18</a>  <a href="chapBib.html">Bib</a>  <a href="chapInd.html">Ind</a>  </div>

<hr />
<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
</body>
</html>

100%


¤ Dauer der Verarbeitung: 0.48 Sekunden  (vorverarbeitet)  ¤

*© Formatika GbR, Deutschland




Wurzel

Suchen

Beweissystem der NASA

Beweissystem Isabelle

NIST Cobol Testsuite

Cephes Mathematical Library

Wiener Entwicklungsmethode

Haftungshinweis

Die Informationen auf dieser Webseite wurden nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit, noch Qualität der bereit gestellten Informationen zugesichert.

Bemerkung:

Die farbliche Syntaxdarstellung ist noch experimentell.