Context Navigation

statistics

Timestamp:

Oct 11, 2007, 7:01:01 PM (16 years ago)

Author:

Peter

Message:

fixing some doxygen warnings

Location:

trunk/yat/statistics

Files:

-                      r865
+                      r966
   public:
     ///
+    ///
+    ///
+    /// \brief Defaul Constructor
+    /// \param absolute if true max(AUC, 1-AUC) is used
+    ///
     AUC(bool absolute=true);

r865	r966
57	57	///
58	58	/// @param s0 \f$ s_0 \f$ is a fudge factor
	59	/// @param absolute if true max(score, -score) is used
59	60	///
60	61	SAMScore(const double s0, bool absolute=true);

r865	r966
118	118	/// is wanted.
119	119	///
120		/// ~~@a value and @~~weight are copied to utility::vector and the
	120	/// \a value and \a weight are copied to utility::vector and the
121	121	/// corresponding operator is called. If speed is important this
122	122	/// operator should be implemented in inherited class to avoid

-                      r865
+                      r966
   struct VectorFunction
+  {
+    /**
+       \brief Destructor
+     */
     virtual ~VectorFunction();
+    /**
+       \brief abstract interface
+     */
     virtual double operator()(const std::vector<double>&) const=0;
   };
 …
   };
+  /**
+     Functor that picks Nth smalles element in a vector.
+   */
   class Nth_Element : public VectorFunction
+  {

r937	r966
23	23	: public vector_distance_tag
24	24	{
	25	/// \brief tag for euclidean distance
25	26	typedef euclidean_vector_distance_tag distance;
26	27	};

r937	r966
22	22	: public vector_distance_tag
23	23	{
	24	/// \brief tag for pearson distance
24	25	typedef pearson_vector_distance_tag distance;
25	26	};

-                      r865
+                      r966
 } \f$
+       \param target Target defining the two groups
+       \param value Vector with data points on which calculation is based
        @param dof double pointer in which approximation of degrees of
        freedom is returned: pos.n()+neg.n()-2. See AveragerWeighted.
 …
        } \f$. See AveragerWeighted for details.
+       \param target Target defining the two groups
+       \param value Vector with values/weights on which calculation is based
        @param dof double pointer in which approximation of degrees of
        freedom is returned: pos.n()+neg.n()-2. See AveragerWeighted.
 …
        + n_y - 2 } \f$. See AveragerWeighted for details.
+       \param target Target defining the two groups
+       \param value Vector with data values on which calculation is based
+       \param weight Vector with weight associated to \a value
        @param dof double pointer in which approximation of degrees of
        freedom is returned: pos.n()+neg.n()-2. See AveragerWeighted.

-                      r958
+                      r966
   /// For each measure to calculate distances between containers
   /// with random access iterators one should provide a struct
   /// which inherits from vector_distance_tag and provides a "label" for
+  /// that inherits from vector_distance_tag and provides a "label" for
   /// the distance measure.
   ///
   struct vector_distance_tag {
+    /// tag defining distance measure
     typedef vector_distance_tag distance;
   };
 …
   template <class T>
   struct vector_distance_traits {
+    /// \return distance type
     typedef typename T::distance distance;
   };

Note: See TracChangeset for help on using the changeset viewer.