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

From ApCoCoAWiki
(Short description update.)
m (insert version info)
 
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
{{Version|1}}
 
<command>
 
<command>
    <title>BBF.Cancel</title>
+
  <title>BBF.Cancel</title>
    <short_description>Cancel the current border basis computation.</short_description>
+
  <short_description>Cancels the current border basis computation.</short_description>
 +
 
 
<syntax>
 
<syntax>
 
BBF.Cancel():STRING
 
BBF.Cancel():STRING
 
</syntax>
 
</syntax>
    <description>
+
  <description>
Cancel a currently running border basis computation. This will not invalidate the current computation but just interrupt it. The computation will stop after the current computation step has finished. If you cancel a non-interactive computation started by [[ApCoCoA:BBF.Finish|BBF.Finish]] you will return to the interactive computation mode. 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 cancels a currently running border basis computation. This will not invalidate the current computation, but just interrupt it. The computation will stop after the current computation step has finished. If you cancel a non-interactive computation started by <ref>ApCoCoA-1:BBF.Finish|BBF.Finish</ref> you will return to the interactive computation mode.  
  
The output of this function is a status string.
+
<itemize>
<example>
+
  <item>@return A Status string.</item>
 +
</itemize>
 +
  <example>
 
Use ZZ/(32003)[x, y, z],DegLex;
 
Use ZZ/(32003)[x, y, z],DegLex;
 
I:=Ideal(-4*x^200, -4*y^2, 5*z^2);
 
I:=Ideal(-4*x^200, -4*y^2, 5*z^2);
Line 21: Line 27:
  
 
-------------------------------
 
-------------------------------
</example>
+
  </example>
    </description>
+
  </description>
     <see>Border Basis Framework overview</see>
+
  <types>
    <see>BBasis</see>
+
     <type>borderbasis</type>
    <key>kaspar</key>
+
  </types>
    <key>bbf.cancel</key>
+
  <see>ApCoCoA-1:BB.BBasis|BB.BBasis</see>
    <wiki-category>Package_bbf</wiki-category>
+
 
 +
  <key>Cancel</key>
 +
  <key>BBF.Cancel</key>
 +
  <wiki-category>ApCoCoA-1:Package_bbf</wiki-category>
 
</command>
 
</command>

Latest revision as of 09:45, 7 October 2020

This article is about a function from ApCoCoA-1.

BBF.Cancel

Cancels the current border basis computation.

Syntax

BBF.Cancel():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 cancels a currently running border basis computation. This will not invalidate the current computation, but just interrupt it. The computation will stop after the current computation step has finished. If you cancel a non-interactive computation started by BBF.Finish you will return to the interactive computation mode.

  • @return A Status string.

Example

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

-------------------------------
Current computation will stop after current step has finished.

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

BB.BBasis