Difference between revisions of "ApCoCoA-1:BBF.Finish"

From ApCoCoAWiki
(Added parameter and return value list.)
m (insert version info)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{Version|1}}
 
<command>
 
<command>
    <title>BBF.Finish</title>
+
  <title>BBF.Finish</title>
    <short_description>Finish a border basis computation.</short_description>
+
  <short_description>Finishes a border basis computation.</short_description>
 +
 
 
<syntax>
 
<syntax>
 
BBF.Finish():STRING
 
BBF.Finish():STRING
 
</syntax>
 
</syntax>
    <description>
+
  <description>
Finish a border basis computation in non-interactive mode. You can check the status of the computation by calling [[ApCoCoA:BBF.Status|BBF.Status]]. If you want to return to the interactive computation mode use [[ApCoCoA:BBF.Cancel|BBF.Cancel]]. Please note that in order to use this function you have to start the ApCoCoABBFServer.
+
<em>Please note:</em> The function(s) explained on this page is/are using the <em>ApCoCoABBFServer</em>. You will have to start the ApCoCoABBFServer in order to use it/them.
 +
<par/>
 +
This command finishes a border basis computation in non-interactive mode. You can check the status of the computation by calling <ref>ApCoCoA-1:BBF.Status|BBF.Status</ref>. If you want to return to the interactive computation mode use <ref>ApCoCoA-1:BBF.Cancel|BBF.Cancel</ref>.  
  
The output of this function is a status string.
 
 
<itemize>
 
<itemize>
 
   <item>@return Status string.</item>
 
   <item>@return Status string.</item>
 
</itemize>
 
</itemize>
<example>
+
  <example>
Use Z/(32003)[x, y, z],DegLex;
+
Use ZZ/(32003)[x, y, z],DegLex;
 
I:=Ideal(-4*x^2, -4*y^2, 5*z^2);
 
I:=Ideal(-4*x^2, -4*y^2, 5*z^2);
 
BBF.Init(I);
 
BBF.Init(I);
Line 21: Line 24:
  
 
-------------------------------
 
-------------------------------
</example>
+
  </example>
    </description>
+
  </description>
     <see>Border Basis Framework overview</see>
+
  <types>
    <see>BBasis</see>
+
     <type>borderbasis</type>
    <key>kaspar</key>
+
  </types>
    <key>bbf.finish</key>
+
  <see>ApCoCoA-1:BB.BBasis|BB.BBasis</see>
    <wiki-category>Package_bbf</wiki-category>
+
  <key>Finish</key>
 +
  <key>BBF.Finish</key>
 +
  <wiki-category>ApCoCoA-1:Package_bbf</wiki-category>
 
</command>
 
</command>

Latest revision as of 09:47, 7 October 2020

This article is about a function from ApCoCoA-1.

BBF.Finish

Finishes a border basis computation.

Syntax

BBF.Finish():STRING

Description

Please note: The function(s) explained on this page is/are using the ApCoCoABBFServer. You will have to start the ApCoCoABBFServer in order to use it/them.

This command finishes a border basis computation in non-interactive mode. You can check the status of the computation by calling BBF.Status. If you want to return to the interactive computation mode use BBF.Cancel.

  • @return Status string.

Example

Use ZZ/(32003)[x, y, z],DegLex;
I:=Ideal(-4*x^2, -4*y^2, 5*z^2);
BBF.Init(I);
BBF.Finish();

Computation started.

-------------------------------
  

BB.BBasis