Changeset 50c8659 in git for factory/templates/ftmpl_functions.h

Timestamp:

Jun 29, 1998, 5:44:45 PM (25 years ago)

Author:

Jens Schmidt <schmidt@…>

Branches:

(u'spielwiese', 'd0474371d8c5d8068ab70bfb42719c97936b18a6')

Children:

030f132f22f4af7b7e819ab46ad07fcde54175cd

Parents:

147c2a4c808ea309e2cf5a023a5d31e57724f662

Message:

	* templates/ftmpl_functions.h: doc fixes


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

File:

• factory/templates/ftmpl_functions.h (modified) (6 diffs)

factory/templates/ftmpl_functions.h

@@ -1 +1 @@
 /* emacs edit mode for this file is -*- C++ -*- */
-/* $Id: ftmpl_functions.h,v 1.4 1998-03-11 10:47:02 schmidt Exp $ */
+/* $Id: ftmpl_functions.h,v 1.5 1998-06-29 15:44:45 schmidt Exp $ */
 
 #ifndef INCL_FUNCTIONS_H
@@ -9 +9 @@
 // ftmpl_functions.h - some useful template functions.
 //
+// Header file corresponds to: nothing
+//
+// Hierarchy: bottom, templates
+//
+// Developer note:
+// ---------------
 // Sooner or later you need them: functions to calculate the
 // minimum or maximum of two values or the absolute value.  Here
@@ -14 +20 @@
 // file corresponding to `ftmpl_functions.h'.
 //
-// The functions are for internal use only (i.e. to build the
+// The functions are for internal use only (i.e., to build the
 // library), hence they should not be included from `factory.h'.
 // However, we have to install `ftmpl_functions.h' with the other
 // templates since the functions have to be instantiated.
-//
-// Used by: cf_gcd.cc, cf_map.cc, fac_ezgcd.cc, sm_sparsemod.cc,
-//   ftmpl_inst.cc
 //
 //}}}
@@ -31 +34 @@
 // tmax() - return the maximum of `a' and `b'.
 //
+// Developers note:
+// ----------------
 // `T' should have an `operator >()'.
 //
@@ -46 +51 @@
 // tmin() - return the minimum of `a' and `b'.
 //
+// Developers note:
+// ----------------
 // `T' should have an `operator <()'.
 //
@@ -61 +68 @@
 // tabs() - return the absolute value of `a'.
 //
+// `a' is negated iff it is less or equal `T( 0 )'.
+//
+// Developers note:
+// ----------------
 // `T' should have an `operator >()', an `operator -()', and a
 // `T::T( int )' constructor.