<p>The <strong class="pkg">Utils</strong> package provides a space for utility functions from a variety of <strong class="pkg">GAP</strong> packages to be collected together into a single package. In this way it is hoped that they will become more visible to other package authors. This package was first distributed as part of the <strong class="pkg">GAP</strong> 4.8.2 distribution.</p>
<p>Functions have been transferred from the following packages:</p>
<ul>
<li><p>Conversion of a <strong class="pkg">GAP</strong> group to a <span class="SimpleMath">\({\sf Magma}\)</span> output string, taken from various sources including <code class="file">other.gi</code> in the main library.</p>
</li>
</ul>
<p>Transfer is complete (for now) for functions from the following packages:</p>
<ul>
<li><p><strong class="pkg">AutoDoc</strong> <a href="chapBib_mj.html#biBAutoDoc">[GH16]</a> (with function names changed);</p>
</li>
</ul>
<p>The package may be obtained either as a compressed <code class="code">.tar</code> file or as a <code class="code">.zip</code> file, <code class="file">utils-version_number.tar.gz</code>, by ftp from one of the following sites:</p>
</li>
<li><p>any <strong class="pkg">GAP</strong> archive, e.g. <span class="URL"><a href="https://www.gap-system.org/Packages/packages.html">https://www.gap-system.org/Packages/packages.html</a></span>;</p>
</li>
</ul>
<p>The package also has a GitHub repository at: <span class="URL"><a href="https://github.com/gap-packages/utils">https://github.com/gap-packages/utils</a></span>.</p>
<p>Once the package is loaded, the manual <code class="code">doc/manual.pdf</code> can be found in the documentation folder. The <code class="code">html</code> versions, with or without <span class="SimpleMath">\({\sf MathJax}\)</span>, may be rebuilt as follows:</p>
<p>It is possible to check that the package has been installed correctly by running the test files (which terminates the <strong class="pkg">GAP</strong> session):</p>
<p>Note that functions listed in this manual that are currently in the process of being transferred are only read from the source package <strong class="pkg">Home</strong> (say), and so can only be used if <strong class="pkg">Home</strong> has already been loaded. There are no such functions in transition at present.</p>
<h4>1.1 <span class="Heading">Information for package authors</span></h4>
<p>A function (or collection of functions) is suitable for transfer from a package <strong class="pkg">Home</strong> to <strong class="pkg">Utils</strong> if the following conditions are satisfied.</p>
<ul>
<li><p>The function is sufficiently non-specialised so that it might be of use to other authors.</p>
</li>
<li><p>The function does not depend on the remaining functions in <strong class="pkg">Home</strong></p>
</li>
<li><p>The function does not do what can already be done with a <strong class="pkg">GAP</strong> library function.</p>
</li>
<li><p>Documentation of the function and test examples are available.</p>
</li>
<li><p>When there is more than one active author of <strong class="pkg">Home</strong>, they should all be aware (and content) that the transfer is taking place.</p>
</li>
</ul>
<p>Authors of packages may be reluctant to let go of their utility functions. The following principles may help to reassure them. (Suggestions for more items here are welcome.)</p>
<ul>
<li><p>A function that has been transferred to <strong class="pkg">Utils</strong> will not be changed without the approval of the original author.</p>
</li>
<li><p>The current package maintainer has every intention of continuing to maintain <strong class="pkg">Utils</strong>. In the event that this proves impossible, the <strong class="pkg">GAP</strong> development team will surely find someone to take over.</p>
</li>
<li><p>Function names will not be changed unless specifically requested by <strong class="pkg">Home</strong>'s author(s) or unless they have the form HOME_FunctionName.
</li>
<li><p>In order to speed up the transfer process, only functions from one package will be in transition at any given time. Hopefully a week or two will suffice for most packages.</p>
</li>
<li><p>Any package author who transfers a function to <strong class="pkg">Utils</strong> will become an author of <strong class="pkg">Utils</strong>. (In truth, <strong class="pkg">Utils</strong> does not have <em>authors</em>, just a large number of <em>contributors</em>.)</p>
</li>
</ul>
<p>The process for transferring utility functions from <strong class="pkg">Home</strong> to <strong class="pkg">Utils</strong> is described in Chapter <a href="chap12_mj.html#X84AC9613842F014C"><span class="RefLink">12</span></a>.</p>
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.
