Difference between revisions of "Package hermite/HNF.SolveDioph"

From ApCoCoAWiki
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
<command>
 
<command>
 
   <title>HNF.SolveDioph</title>
 
   <title>HNF.SolveDioph</title>
   <short_description>Solves linear systems of equations over the integers </short_description>
+
   <short_description>This function solves linear systems of equations over the integers. </short_description>
 
    
 
    
   <syntax>HNF.SolveDioph(<<input parameters and types>>):<<output type>></syntax>
+
   <syntax>HNF.SolveDioph(A:MAT, B:MAT>):LIST</syntax>
 
   <description>
 
   <description>
 
Computes a solution of the linear system AX=B. If only one argument A is given then the function computes a basis of the solution space of the homogeneous system AX=0.
 
Computes a solution of the linear system AX=B. If only one argument A is given then the function computes a basis of the solution space of the homogeneous system AX=0.
 
     <itemize>
 
     <itemize>
      <!-- Describe every input parameter of the function -->
+
       <item>@param <tt>A</tt> integer matrix of dimension nxm</item>
       <item>@param <tt><<parameter name>></tt> <<parameter description>></item>
+
       <item>@param <tt>B</tt> (optional) integer matrix of dimension mx1</item>
       <item>@param <tt><<parameter name>></tt> <<parameter description>></item>
+
       <item>@return a solution or basis of the solution space if system is homogeneous</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>
+
     <type>LIST</type>
 
   </types>
 
   </types>
  
  <!-- Add keys here (first three are mandatory, other ones are optional) -->
+
   <key>SolveDioph</key>
   <key><<function name>></key>
+
   <key>HNF.SolveDioph</key>
   <key><<alias>>.<<function name>></key>
+
   <key>hermite.SolveDioph</key>
   <key><<package name>>.<<function name>></key>
 
  <key><<first key>></key>
 
  <key><<second key>></key>
 
  
   <wiki-category>Package <<package name>></wiki-category>
+
   <wiki-category>Package hermite</wiki-category>
  
 
</command>
 
</command>

Latest revision as of 15:05, 7 November 2020

HNF.SolveDioph

This function solves linear systems of equations over the integers.

Syntax

HNF.SolveDioph(A:MAT, B:MAT>):LIST

Description

Computes a solution of the linear system AX=B. If only one argument A is given then the function computes a basis of the solution space of the homogeneous system AX=0.

  • @param A integer matrix of dimension nxm

  • @param B (optional) integer matrix of dimension mx1

  • @return a solution or basis of the solution space if system is homogeneous

Example

<<first example>>

Example

<<second example>>