Changeset 7884761 in git

Timestamp:

Jul 12, 2007, 4:36:35 PM (17 years ago)

Author:

Hans Schönemann <hannes@…>

Branches:

(u'spielwiese', '17f1d200f27c5bd38f5dfc6e8a0879242279d1d8')

Children:

f7f49eac6f55bc638e945fa2b770a767a2a4f6d7

Parents:

62fb0b49885ad5337fe7d01209a7258cd28e8894

Message:

*gmg: doc.


git-svn-id: file:///usr/local/Singular/svn/trunk@10197 2c84dea3-7e68-4137-9b89-c4e89433aadc

File:

• Singular/LIB/surfex.lib (modified) (14 diffs)

Singular/LIB/surfex.lib

@@ -1 +1 @@
 //last change: 2007/07/06 (Oliver Labs)
 ///////////////////////////////////////////////////////////////////////////////
-version="$Id: surfex.lib,v 1.4 2007-07-12 12:35:44 Singular Exp $";
+version="$Id: surfex.lib,v 1.5 2007-07-12 14:36:35 Singular Exp $";
 category="Visualization";
 info="
-LIBRARY: surfex.lib      Procedures for visualizing Surfaces.
-         This is still an alpha version (see http://www.AlgebraicSurface.net)
+LIBRARY: surfex.lib      Procedures for visualizing and rotating surfaces.
+@*         It is still an alpha version (see http://www.AlgebraicSurface.net)
 AUTHOR: Oliver Labs
-        This library uses the program surf and surfex.
-        surfex was written by Oliver Labs and others, mainly Stephan Holzer.
-        surf was written by Stefan Endrass and others.
+        This library uses the program surf
+        (written by Stefan Endrass and others)
+        and surfex (written by Oliver Labs and others, mainly Stephan Holzer).
 
 NOTE:
- This library requires the program surfex to be installed.
- This software is used for producing raytraced images of the surfaces.
- You can download @code{surfex} from @uref{http://www.surfex.AlgebraicSurface.net}.
+ This library requires the program surfex, surf and java to be installed.
+ The software is used for producing raytraced images of surfaces.
+ You can download @code{surfex} from http://www.surfex.AlgebraicSurface.net
 
  surfex is a front-end for surf which aims to be easier to use than
@@ -25 +25 @@
                with the coordinates coords(list)
 plotRot(poly);           Similar to plotRotated,
-                         but tries to guess automatically
+                         but guesses automatically
                          which coordinates should be used
 plotRotatedList(varieties, coords); Plot the varieties given by the list varieties
@@ -45 +45 @@
 "
 USAGE: plotRot(poly p, list #)
-Similar to plotRotated, but tries to guess automatically
+Similar to plotRotated, but guesses automatically
 which coordinates should be used.
 
@@ -51 +51 @@
 seen as a surface in the real affine space with coordinates coords.
 
-RETURN: the return code of the system command which executes surfex.
-
-ASSUME: The basering is characteristic zero and without parameters.
+ASSUME: The basering is of characteristic zero and without parameters.
 "
 {
@@ -89 +87 @@
     return(plotRotatedList(list(p), coords, #));
 }
-example {
+example
+{
     "Example:"; echo=2;
 
@@ -114 +113 @@
     // to compute the singular locus before calling surfex.
     poly swallowtail = -4*y^2*z^3-16*x*z^4+27*y^4+144*x*y^2*z+128*x^2*z^2-256*x^3;
-    plotRot(swallowtail, 3);
 }
 
@@ -123 +121 @@
 seen as a surface in the real affine space with coordinates coords.
 
-RETURN: the return code of the system command which executes surfex.
-
 ASSUME: coords is a list of three variables.
-The basering is characteristic zero and without parameters.
+The basering is of characteristic zero and without parameters.
 "
 {
     return(plotRotatedList(list(p), coords, #));
 }
-example {
+example
+{
     "Example:"; echo=2;
 
@@ -139 +136 @@
 //     plotRotated(cayley_cubic, list(x,y,z));
 
-    // An difficult example: a surface with a one-dimensional real component!
+    // A difficult example: a surface with a one-dimensional real component!
     poly whitney_umbrella = x^2*z-y^2;
     // The Whitney Umbrella without its handle:
     plotRotated(whitney_umbrella, list(x,y,z));
+
     // The Whitney Umbrella together with its handle:
     plotRotated(whitney_umbrella, list(x,y,z), 2);
@@ -154 +152 @@
 seen as a surface in the real affine space with coordinates coords.
 
-RETURN: the return code of the system command which executes surfex.
-
-ASSUME: coords is a list of three variables,
-varieties is a list of ideals discribing the varieties to be shown.
-The basering is characteristic zero and without parameters.
+ASSUME: coords is a list of three variables, varieties is a list of ideals
+describing the varieties to be shown.
+The basering is of characteristic zero and without parameters.
 "
 {
@@ -402 +398 @@
 see the example.
 
-RETURN: the return code of the system command which executes surfex.
-
-ASSUME: The basering is characteristic zero.
+ASSUME: The basering is of characteristic zero.
 
 EXAMPLE: example plotRotatedListFromSpecifyList;
@@ -414 +408 @@
     return(plotRotatedFromCode(str, #));
 }
-example {
+example
+{
     "Example:"; echo=2;
 
@@ -454 +449 @@
 seen as a surface in the real affine space with coordinates x,y,z.
 The format for the list varieties is not fully documented yet;
-please, try to adapt the examples to your needs.
-
-RETURN: the return code of the system command which executes surfex.
+please, see the examples below and try to adapt the examples to your needs.
 
 ASSUME:
-Passes the equations directly to surfex,
-i.e., the variable names should be correct, i.e. x,y,z.
+Passes the equations directly to surfex, i.e., the variable names should
+be x,y,z.
 The advantage is that one can use parameters p1, p2, ...;
 these will be passed to surfex.
@@ -469 +462 @@
     return(plotRotatedFromCode(str, #));
 }
-example {
+example
+{
     "Example:"; echo=2;
 
@@ -502 +496 @@
 it takes the surfex-code as a string and calls surfex.
 
-RETURN: the return code of the system command which executes surfex.
 "
 {