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

Timestamp:

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

Author:

ansari

Message:

documentation cmv 12/4/00

File:

• trunk/SophyaLib/TArray/matharr.cc (modified) (5 diffs)

trunk/SophyaLib/TArray/matharr.cc

@@ -10 +10 @@
 // ----------------------------------------------------
 
+
+//! Apply Function In Place (function double version)
+/*!
+  \param a : array to be replaced in place
+  \param f : function for replacement
+  \return Return an array \b a filled with function f(a(i,j))
+*/
 template <class T>
 TArray<T>& MathArray<T>::ApplyFunctionInPlace(TArray<T> & a, Arr_DoubleFunctionOfX f)
@@ -36 +43 @@
 }
 
+//! Apply Function In Place (function float version)
+/*!
+  \param a : array to be replaced in place
+  \param f : function for replacement
+  \return Return an array \b a filled with function f(a(i,j))
+*/
 template <class T>
 TArray<T>& MathArray<T>::ApplyFunctionInPlace(TArray<T> & a, Arr_FloatFunctionOfX f)
@@ -63 +76 @@
 
 
+//! Apply Function (function double version)
+/*!
+  \param a : argument array of the function
+  \param f : function for replacement
+  \return Return a new array filled with function f(a(i,j))
+*/
 template <class T>
 TArray<T> MathArray<T>::ApplyFunction(TArray<T> const & a, Arr_DoubleFunctionOfX f)
@@ -72 +91 @@
 }
 
+//! Apply Function (function float version)
+/*!
+  \param a : argument array of the function
+  \param f : function for replacement
+  \return Return a new array filled with function f(a(i,j))
+*/
 template <class T>
 TArray<T> MathArray<T>::ApplyFunction(TArray<T> const & a, Arr_FloatFunctionOfX f)
@@ -81 +106 @@
 }
 
+//! Compute \b mean and \b sigma of elements of array \b a, return \b mean
 template <class T>
 double MathArray<T>::MeanSigma(TArray<T> const & a, double & mean, double & sig)