Changeset e1b841 in git

Timestamp:

Jan 7, 2012, 12:42:56 AM (12 years ago)

Author:

Andreas Steenpass <steenpass@…>

Branches:

(u'spielwiese', '8e0ad00ce244dfd0756200662572aef8402f13d5')

Children:

5abb0e7fdca82a2bad9778e410148c74d7b49a0b

Parents:

f1cfef36a45967a6dc88672e6efc050bf9c592b1

git-author:

Andreas Steenpass <steenpass@mathematik.uni-kl.de>2012-01-07 00:42:56+01:00

git-committer:

Andreas Steenpass <steenpass@mathematik.uni-kl.de>2012-08-02 18:26:50+02:00

Message:

update documentation for parallel.lib and realclassify.lib

Location:

Singular/LIB

Files:

• parallel.lib (modified) (3 diffs)
• realclassify.lib (modified) (6 diffs)

Singular/LIB/parallel.lib

@@ -3 +3 @@
 category="General purpose";
 info="
-LIBRARY:   parallel.lib  An Interface for Parallelization
+LIBRARY:   parallel.lib  Tools for Parallelization
 AUTHOR:    Andreas Steenpass, e-mail: steenpass@mathematik.uni-kl.de
+
+OVERVIEW:
+This library provides tools to do several computations in parallel. They
+are aimed at ordinary Singular users as well as authors of Singular
+libraries.
+@* Even without this library, it is possible to do execute self-defined
+Singular commands in parallel using @ref{links}, but the handling of
+such links can be quite tedious. With the pocedures described below,
+this can be done by one-line commands.
+@* There are many parallel 'skeletons' (i.e. ways in which parallel
+tasks rely upon and interact with each other). A few of them are already
+implemented. Future plans include an abstraction layer for modular
+techniques, 'worker farms', and parallel tests.
 
 SEE ALSO:  link, modstd_lib, assprimeszerodim_lib
@@ -26 +39 @@
 RETURN:  a list, containing the results of commands[i] applied to arg[i],
          i = 1, ..., size(commands).
-         @* The entries of the list commands must be strings.
-         @* The entries of the list args must be lists.
          @* The procedure waits for N jobs to finish.
-         @* An optional timeout in ms can be provided. Default is 0 which
+
+         @* OPTIONAL PARAMETERS:
+
+            An optional timeout in ms can be provided. Default is 0 which
             disables the timeout.
-         @* Supported linktypes are up to now \"ssi\" and \"mp\", see
+
+            Supported linktypes are up to now \"ssi\" and \"mp\", see
             @ref{Ssi links} and @ref{MP links}.
+
+            Servers:
          @* Each server is given by a list containing the address of the server,
             the number of cores to use on this server and the command to start
-            Singular. If the address is \"localhost\", the processes will
-            be generated on the same machine using forks. If the command to
-            start Singular is \"\" (the empty string), \"Singular\" will be
-            used. Default is @code{list(\"localhost\", system(\"cpu\"), \"\")}.
-            There are some obvious shortcuts for servers, e.g. \"myserver\" is
+            Singular.
+         @* If the address is \"localhost\", the processes will be generated on
+            the same machine using forks. If the command to start Singular is
+            \"\" (the empty string), \"Singular\" will be used.
+         @* Default is @code{list(\"localhost\", system(\"cpu\"), \"\")}.
+         @* There are some obvious shortcuts for servers, e.g. \"myserver\" is
             a shortcut for
             @code{list(\"myserver\", [nb. of cores on myserver], \"\")}, or 3
             for @code{list(\"localhost\", 3, \"\")}.
+
+            Memory limits:
          @* If an intvec maxmemory of size @code{size(commands)} is given, the
             i-th job will be killed if it uses more than maxmemory[i] MB of
             memory. If maxmemory[i] is 0, there will be no restraint for the
             i-th job. Default is @code{0:size(commands)}.
-NOTE:       The returned list may contain more than N results if several jobs
+NOTE:       The entries of the list commands must be strings.
+         @* The entries of the list args must be lists.
+         @* The returned list may contain more than N results if several jobs
             finished \"at the same time\". It may contain less than N results in
             the case of timeout or errors occurring.
@@ -542 +564 @@
   ideal i = z8+z6+4z5+4z3+4z2+4, y-z2;
   ideal j = 3x3y+x3+xy3+y2z2, 2x3z-xy-xz3-y4-z2, 2x2yz-2xy2+xz2-y4;
-  list commands = list("std", "primdecGTZ", "primdecSY", "std", "primdecGTZ",
-                       "primdecSY");
+  list commands = list("std", "primdecGTZ", "primdecSY",
+                       "std", "primdecGTZ", "primdecSY");
   list args = list(list(i), list(i), list(i), list(j), list(j), list(j));
   parallelWaitN(commands, args, 3);

Singular/LIB/realclassify.lib

@@ -9 +9 @@
 OVERVIEW:
    A library for classifying isolated hypersurface singularities over the reals
-   w.r.t. right
-   equivalence, based on the determinator of singularities by V.I. Arnold.
-   This library is based on classify.lib by Kai Krueger, but handles the real
-   case, while classify.lib does the complex classification.
+   w.r.t. right equivalence, based on the determinator of singularities by
+   V.I. Arnold. This library is based on classify.lib by Kai Krueger, but
+   handles the real case, while classify.lib does the complex classification.
+
+REFERENCES:
+Arnold, Varchenko, Gusein-Zade: Singularities of Differentiable Maps.
+Vol. 1: The classification of critical points caustics and wave fronts.
+Birkh\"auser, Boston 1985
+
+Greuel, Lossen, Shustin: Introduction to singularities and deformations.
+Springer, Berlin 2007
 
 PROCEDURES:
@@ -31 +38 @@
 RETURN:   A list containing (in this order)
           @* - the type of the singularity as a string,
-          @* - the normal form as well as
+          @* - the normal form,
           @* - the corank, the Milnor number, the inertia index and
                a bound for the determinacy as integers.
@@ -778 +785 @@
   "EXAMPLE:";
   echo = 2;
-  LIB "realclassify.lib";
   ring r = 0, (x,y,z), ds;
   poly f = (x2+3y-2z)^2+xyz-(x-y3+x2z3)^3;
@@ -1006 +1012 @@
   "EXAMPLE:";
   echo = 2;
-  LIB "realclassify.lib";
   ring r = 0, (x,y,z), ds;
   poly f = (x2+3y-2z)^2+xyz-(x-y3+x2z3)^3;
@@ -1053 +1058 @@
   "EXAMPLE:";
   echo = 2;
-  LIB "realclassify.lib";
   ring r = 0, (x,y), ds;
   poly f = x3+y4;
@@ -1145 +1149 @@
   "EXAMPLE:";
   echo = 2;
-  LIB "realclassify.lib";
   ring r = 0, (x,y), ds;
   poly f = x3+xy3;