[METRIC] all metric move finished

include/xgboost/metric.h

@@ -0,0 +1,75 @@
+/*!
+ * Copyright 2014 by Contributors
+ * \file metric.h
+ * \brief interface of evaluation metric function supported in xgboost.
+ * \author Tianqi Chen, Kailong Chen
+ */
+#ifndef XGBOOST_METRIC_H_
+#define XGBOOST_METRIC_H_
+
+#include <dmlc/registry.h>
+#include <vector>
+#include <functional>
+#include "./data.h"
+#include "./base.h"
+
+namespace xgboost {
+/*!
+ * \brief interface of evaluation metric used to evaluate model performance.
+ *  This has nothing to do with training, but merely act as evaluation purpose.
+ */
+class Metric {
+ public:
+  /*!
+   * \brief evaluate a specific metric
+   * \param preds prediction
+   * \param info information, including label etc.
+   * \param distributed whether a call to Allreduce is needed to gather
+   *        the average statistics across all the node,
+   *        this is only supported by some metrics
+   */
+  virtual float Eval(const std::vector<float>& preds,
+                     const MetaInfo& info,
+                     bool distributed) const = 0;
+  /*! \return name of metric */
+  virtual const char* Name() const = 0;
+  /*! \brief virtual destructor */
+  virtual ~Metric() {}
+  /*!
+   * \brief create a metric according to name.
+   * \param name name of the metric.
+   *  name can be in form metric@param
+   *  and the name will be matched in the registry.
+   * \return the created metric.
+   */
+  static Metric* Create(const char *name);
+};
+
+/*!
+ * \brief Registry entry for Metric factory functions.
+ *  The additional parameter const char* param gives the value after @, can be null.
+ *  For example, metric map@3, then: param == "3".
+ */
+struct MetricReg
+    : public dmlc::FunctionRegEntryBase<MetricReg,
+                                        std::function<Metric* (const char*)> > {
+};
+
+/*!
+ * \brief Macro to register metric.
+ *
+ * \code
+ * // example of registering a objective ndcg@k
+ * XGBOOST_REGISTER_METRIC(RMSE, "ndcg")
+ * .describe("Rooted mean square error.")
+ * .set_body([](const char* param) {
+ *     int at_k = atoi(param);
+ *     return new NDCG(at_k);
+ *   });
+ * \endcode
+ */
+#define XGBOOST_REGISTER_METRIC(UniqueId, Name)                         \
+  static ::xgboost::MetricReg & __make_ ## MetricReg ## _ ## UniqueId ## __ = \
+      ::dmlc::Registry< ::xgboost::MetricReg>::Get()->__REGISTER__(#Name)
+}  // namespace xgboost
+#endif  // XGBOOST_METRIC_H_

include/xgboost/objective.h

@@ -70,7 +70,7 @@ class ObjFunction {
 };
 
 /*!
- * \brief Registry entry for DataIterator factory functions.
+ * \brief Registry entry for objective factory functions.
  */
 struct ObjFunctionReg
     : public dmlc::FunctionRegEntryBase<ObjFunctionReg,
@@ -78,7 +78,7 @@ struct ObjFunctionReg
 };
 
 /*!
- * \brief Macro to register objective
+ * \brief Macro to register objective function.
  *
  * \code
  * // example of registering a objective

include/xgboost/sync.h

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2014 by Contributors
+ * \file sync.h
+ * \brief the synchronization module of rabit
+ *        redirects to rabit header
+ * \author Tianqi Chen
+ */
+#ifndef XGBOOST_SYNC_H_
+#define XGBOOST_SYNC_H_
+
+#include <rabit.h>
+
+#endif  // XGBOOST_SYNC_H_