Merge branch 'master' into master

Author: apavlo

src/include/binder/bind_node_visitor.h

@@ -38,6 +38,9 @@ class Catalog;
 
 namespace binder {
 
+/**
+ * @brief      Interface to be notified of the composition of a bind node.
+ */
 class BindNodeVisitor : public SqlNodeVisitor {
  public:
   BindNodeVisitor(concurrency::TransactionContext *txn,

src/include/binder/binder_context.h

@@ -153,9 +153,7 @@ class BinderContext {
       std::vector<std::unique_ptr<expression::AbstractExpression>> &exprs);
 
  private:
-  /**
-   * @brief Map table alias to table obj
-   */
+  /** @brief Map table alias to table obj */
   std::unordered_map<std::string, std::shared_ptr<catalog::TableCatalogObject>>
       regular_table_alias_map_;
   std::unordered_map<std::string, std::unordered_map<std::string, type::TypeId>>

src/include/brain/brain_util.h

@@ -1,4 +1,3 @@
-
 //===----------------------------------------------------------------------===//
 //
 //                         Peloton

src/include/brain/clusterer.h

@@ -30,10 +30,14 @@ namespace brain {
 // Clusterer
 //===--------------------------------------------------------------------===//
 
-// Column Id to < Tile Id, Tile Column Id >
+/**
+ * Column Id to < Tile Id, Tile Column Id > 
+ */
 typedef std::map<oid_t, std::pair<oid_t, oid_t>> column_map_type;
 
-// Sequential k-Means Clustering
+/**
+ * Sequential k-Means Clustering
+ */
 class Clusterer : public Printable {
  public:
   Clusterer(oid_t cluster_count, oid_t sample_column_count,
@@ -46,47 +50,76 @@ class Clusterer : public Printable {
         sample_count_(0),
         sample_column_count_(sample_column_count) {}
 
+  /**
+   * @brief      Gets the cluster count.
+   *
+   * @return     The cluster count.
+   */
   oid_t GetClusterCount() const { return cluster_count_; }
 
-  // process the sample and update the means
+  /**
+   * process the sample and update the means
+   *
+   * @param[in]  sample  The sample
+   */
   void ProcessSample(const Sample &sample);
 
-  // find closest cluster for the given sample
+  /**
+   * find closest cluster for the given sample
+   *
+   * @param[in]  sample  The sample
+   */
   oid_t GetClosestCluster(const Sample &sample);
 
-  // get cluster mean sample
+  /**
+   * get cluster mean sample
+   *
+   * @param[in]  cluster_offset  The cluster offset
+   */
   Sample GetCluster(oid_t cluster_offset) const;
 
-  // get history
+  /**
+   * get history
+   *
+   * @param[in]  cluster_offset  The cluster offset
+   *
+   * @return     The fraction.
+   */
   double GetFraction(oid_t cluster_offset) const;
 
-  // get partitioning
+  /**
+   * get partitioning
+   *
+   * @param[in]  tile_count  The tile count
+   */
   column_map_type GetPartitioning(oid_t tile_count) const;
 
-  // Get a string representation for debugging
+  /**
+   * Get a string representation for debugging
+   */
   const std::string GetInfo() const;
 
  private:
   //===--------------------------------------------------------------------===//
   // MEMBERS
   //===--------------------------------------------------------------------===//
 
-  // # of clusters
+  /** # of clusters */
   oid_t cluster_count_;
 
-  // means_
+  /**  means_ */
   std::vector<Sample> means_;
 
-  // history
+  /** history */
   std::vector<int> closest_;
 
-  // weight for new sample
+  /** weight for new sample */
   double new_sample_weight_;
 
-  // sample count
+  /** sample count */
   int sample_count_;
 
-  // sample column count
+  /** sample column count */
   oid_t sample_column_count_;
 };