Package hermite/HNF.HermiteNF: Difference between revisions

From ApCoCoAWiki
← Older editNewer edit →
No edit summary
No edit summary
Line 4: Line 4:
   <short_description>Computes the Hermite normalform of an integer matrix</short_description>
   <short_description>Computes the Hermite normalform of an integer matrix</short_description>
    
    
   <syntax>HNF.HermiteNF(<<input parameters and types>>):<<output type>></syntax>
   <syntax>HNF.HermiteNF(Matrix:MAT):MAT></syntax>
   <description>
   <description>
<!-- (no indent) Here comes a short description of the functions -->
 
     <itemize>
     <itemize>
      <!-- Describe every input parameter of the function -->
       <item>@param <tt>Matrix</tt> Integer Matrix></item>
       <item>@param <tt><<parameter name>></tt> <<parameter description>></item>
      <item>@param <tt><<parameter name>></tt> <<parameter description>></item>
      <item>@return <<description of the return value>></item>
     </itemize>
     </itemize>
   
   
    <!-- Examples here (also only one or more than two possible) -->
    <!-- It is important to omit any indentation inside the example environment -->
    <!-- may also go over more lines, but the </example>-tag should not be in a new line -->
     <example><<first example>></example>
     <example><<first example>></example>
     <example><<second example>></example>
     <example><<second example>></example>
   </description>
   </description>


  <!-- Add related pages (also more or none possible) -->
  <seealso>
    <see><<first page>></see>
    <see><<second page>></see>
  </seealso>
  <!-- Add all data types used in the signature of your function (also more or none possible) -->
   <types>
   <types>
     <type><<first type>></type>
     <type>MAT</type>
    <type><<second type>></type>
   </types>
   </types>


   <!-- Add keys here (first three are mandatory, other ones are optional) -->
   <!-- Add keys here (first three are mandatory, other ones are optional) -->
   <key><<function name>></key>
   <key>HermiteNF</key>
   <key><<alias>>.<<function name>></key>
   <key>HNF.HermiteNF</key>
   <key><<package name>>.<<function name>></key>
   <key>hermite.HermiteNF</key>
  <key><<first key>></key>
  <key><<second key>></key>


   <wiki-category>Package <<package name>></wiki-category>
   <wiki-category>Package hermite</wiki-category>


</command>
</command>

Revision as of 14:33, 6 November 2020

HNF.HermiteNF

Computes the Hermite normalform of an integer matrix

Syntax

HNF.HermiteNF(Matrix:MAT):MAT>

Description


  • @param Matrix Integer Matrix>

Example

<<first example>>

Example

<<second example>>






Retrieved from "https://app.apcocoa.uni-passau.de/wiki/index.php?title=Package_hermite/HNF.HermiteNF&oldid=16276"