Changeset b16644 in git

Timestamp:

Jun 30, 1998, 6:31:24 PM (26 years ago)

Author:

Jens Schmidt <schmidt@…>

Branches:

(u'spielwiese', 'fe61d9c35bf7c61f2b6cbf1b56e25e2f08d536cc')

Children:

a27df307c91f70f0f5d41b82d969ab659daea3b6

Parents:

1b43cfe16aa9a713a667bfa57eb3f37d7fe9400f

Message:

	* cf_algorithm.h: doc fixes


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

File:

• factory/cf_algorithm.h (modified) (4 diffs)

factory/cf_algorithm.h

@@ -1 +1 @@
 /* emacs edit mode for this file is -*- C++ -*- */
-/* $Id: cf_algorithm.h,v 1.10 1998-03-12 10:26:47 schmidt Exp $ */
+/* $Id: cf_algorithm.h,v 1.11 1998-06-30 16:31:24 schmidt Exp $ */
 
 #ifndef INCL_CF_ALGORITHM_H
@@ -9 +9 @@
 // cf_algorithm.h - declarations of higher level algorithms.
 //
+// Header file corresponds to: cf_algorithms.cc, cf_chinese.cc,
+//   cf_factor.cc, cf_linsys.cc, cf_resultant.cc
+//
+// Hierarchy: mathematical algorithms on canonical forms
+//
+// Developers note:
+// ----------------
 // This header file collects declarations of most of the
-// functions in factory which implement higher level algorithms
+// functions in Factory which implement higher level algorithms
 // on canonical forms (factorization, gcd, etc.) and declarations
-// of some low level mathematical functions, too (absolute vale,
+// of some low level mathematical functions, too (absolute value,
 // euclidean norm, etc.).
-//
-// This header file corresponds to:
-//
-// cf_algorithms.cc, cf_chinese.cc, cf_factor.cc, cf_linsys.cc,
-// cf_resultant.cc
 //
 //}}}
@@ -82 +84 @@
 // returned, otherwise `f'.
 //
-// Most useful for integers and rationals.  May be used to
-// sign-normalize the leading coefficient of arbitrary
-// polynomials, too.
+// This behaviour is most useful for integers and rationals.  But
+// it may be used to sign-normalize the leading coefficient of
+// arbitrary polynomials, too.
+//
+// Type info:
+// ----------
+// f: CurrentPP
 //
 //}}}
@@ -90 +96 @@
 abs ( const CanonicalForm & f )
 {
-    // it is not only more general using `sign()', it is faster, too
+    // it is not only more general to use `sign()' instead of a
+    // direct comparison `f < 0', it is faster, too
     if ( sign( f ) < 0 )
         return -f;