Changeset 894 in Sophya for trunk/SophyaLib/TArray/matharr.h

Timestamp:

Apr 12, 2000, 7:42:33 PM (25 years ago)

Author:

ansari

Message:

documentation cmv 12/4/00

File:

• trunk/SophyaLib/TArray/matharr.h (modified) (2 diffs)

trunk/SophyaLib/TArray/matharr.h

@@ -12 +12 @@
 namespace SOPHYA {
 
-//       Class for simple mathematical operation on arrays 
-//   Instanciated only for real and double (r_4, r_8) type arrays 
-//                                                Reza 03/2000
+//! Class for simple mathematical operation on arrays 
+/*!
+  \warning Instanciated only for \b real and \b double (r_4, r_8) type arrays
+*/
 template <class T>
 class MathArray {
@@ -84 +85 @@
 #endif
 
+//! Return \b mean and \b sigma of elements of array \b a
 template <class T>
 inline double MeanSigma(const TArray<T>& a, double & mean, double & sig)
   { MathArray<T> ma;   return( ma.MeanSigma(a, mean, sig) ); }
 
+//! Return \b mean of elements of array \b a
 template <class T>
 inline double Mean(const TArray<T>& a)