cpplint pass

include/rabit.h

@@ -1,6 +1,5 @@
-#ifndef RABIT_RABIT_H
-#define RABIT_RABIT_H
 /*!
+ *  Copyright (c) 2014 by Contributors
  * \file rabit.h
  * \brief This file defines unified Allreduce/Broadcast interface of rabit
  *   The actual implementation is redirected to rabit engine
@@ -9,12 +8,14 @@
  *   rabit.h and serializable.h is all the user need to use rabit interface
  * \author Tianqi Chen, Ignacio Cano, Tianyi Zhou
  */
+#ifndef RABIT_RABIT_H_
+#define RABIT_RABIT_H_
 #include <string>
 #include <vector>
 // optionally support of lambda function in C++11, if available
 #if __cplusplus >= 201103L
 #include <functional>
-#endif // C++11
+#endif  // C++11
 // contains definition of ISerializable
 #include "./rabit_serializable.h"
 // engine definition of rabit, defines internal implementation
@@ -116,7 +117,7 @@ inline void Broadcast(std::string *sendrecv_data, int root);
  */
 template<typename OP, typename DType>
 inline void Allreduce(DType *sendrecvbuf, size_t count,
-                      void (*prepare_fun)(void *arg) = NULL, 
+                      void (*prepare_fun)(void *arg) = NULL,
                       void *prepare_arg = NULL);
 
 // C++11 support for lambda prepare function
@@ -142,9 +143,9 @@ inline void Allreduce(DType *sendrecvbuf, size_t count,
  * \tparam DType type of data
  */
 template<typename OP, typename DType>
-inline void Allreduce(DType *sendrecvbuf, size_t count, std::function<void()> prepare_fun);
-#endif // C++11
-
+inline void Allreduce(DType *sendrecvbuf, size_t count,
+                      std::function<void()> prepare_fun);
+#endif  // C++11
 /*!
  * \brief load latest check point
  * \param global_model pointer to the globally shared model/state
@@ -228,6 +229,7 @@ class Reducer {
   inline void Allreduce(DType *sendrecvbuf, size_t count,
                         std::function<void()> prepare_fun);
 #endif
+
  private:
   /*! \brief function handle to do reduce */
   engine::ReduceHandle handle_;
@@ -274,6 +276,7 @@ class SerializeReducer {
                         size_t max_nbyte, size_t count,
                         std::function<void()> prepare_fun);
 #endif
+
  private:
   /*! \brief function handle to do reduce */
   engine::ReduceHandle handle_;
@@ -283,4 +286,4 @@ class SerializeReducer {
 }  // namespace rabit
 // implementation of template functions
 #include "./rabit/rabit-inl.h"
-#endif  // RABIT_ALLREDUCE_H
+#endif  // RABIT_RABIT_H_

include/rabit/engine.h

@@ -1,10 +1,12 @@
 /*!
+ *  Copyright (c) 2014 by Contributors
  * \file engine.h
  * \brief This file defines the core interface of allreduce library
  * \author Tianqi Chen, Nacho, Tianyi
  */
-#ifndef RABIT_ENGINE_H
-#define RABIT_ENGINE_H
+#ifndef RABIT_ENGINE_H_
+#define RABIT_ENGINE_H_
+#include <string>
 #include "../rabit_serializable.h"
 
 namespace MPI {
@@ -122,7 +124,7 @@ class IEngine {
   virtual int GetRank(void) const = 0;
   /*! \brief get total number of */
   virtual int GetWorldSize(void) const = 0;
-  /*! \brief get the host name of current node */  
+  /*! \brief get the host name of current node */
   virtual std::string GetHost(void) const = 0;
   /*!
    * \brief print the msg in the tracker,
@@ -211,7 +213,7 @@ class ReduceHandle {
   /*! \return the number of bytes occupied by the type */
   static int TypeSize(const MPI::Datatype &dtype);
 
- private:
+ protected:
   // handle data field
   void *handle_;
   // handle to the type field
@@ -221,5 +223,4 @@ class ReduceHandle {
 };
 }  // namespace engine
 }  // namespace rabit
-#endif  // RABIT_ENGINE_H
-
+#endif  // RABIT_ENGINE_H_

include/rabit/io.h

@@ -1,16 +1,19 @@
-#ifndef RABIT_UTILS_IO_H
-#define RABIT_UTILS_IO_H
-#include <cstdio>
-#include <vector>
-#include <cstring>
-#include <string>
-#include "./utils.h"
-#include "../rabit_serializable.h"
 /*!
+ *  Copyright (c) 2014 by Contributors
  * \file io.h
  * \brief utilities that implements different serializable interface
  * \author Tianqi Chen
  */
+#ifndef RABIT_UTILS_IO_H_
+#define RABIT_UTILS_IO_H_
+#include <cstdio>
+#include <vector>
+#include <cstring>
+#include <string>
+#include <algorithm>
+#include "./utils.h"
+#include "../rabit_serializable.h"
+
 namespace rabit {
 namespace utils {
 /*! \brief interface of i/o stream that support seek */
@@ -25,8 +28,9 @@ class ISeekStream: public IStream {
 /*! \brief fixed size memory buffer */
 struct MemoryFixSizeBuffer : public ISeekStream {
  public:
-  MemoryFixSizeBuffer(void *p_buffer, size_t buffer_size) 
-      : p_buffer_(reinterpret_cast<char*>(p_buffer)), buffer_size_(buffer_size) {
+  MemoryFixSizeBuffer(void *p_buffer, size_t buffer_size)
+      : p_buffer_(reinterpret_cast<char*>(p_buffer)),
+        buffer_size_(buffer_size) {
     curr_ptr_ = 0;
   }
   virtual ~MemoryFixSizeBuffer(void) {}
@@ -40,7 +44,7 @@ struct MemoryFixSizeBuffer : public ISeekStream {
   }
   virtual void Write(const void *ptr, size_t size) {
     if (size == 0) return;
-    utils::Assert(curr_ptr_ + size <=  buffer_size_, 
+    utils::Assert(curr_ptr_ + size <=  buffer_size_,
                   "write position exceed fixed buffer size");
     memcpy(p_buffer_ + curr_ptr_, ptr, size);
     curr_ptr_ += size;
@@ -59,12 +63,12 @@ struct MemoryFixSizeBuffer : public ISeekStream {
   size_t buffer_size_;
   /*! \brief current pointer */
   size_t curr_ptr_;
-}; // class MemoryFixSizeBuffer
+};  // class MemoryFixSizeBuffer
 
 /*! \brief a in memory buffer that can be read and write as stream interface */
 struct MemoryBufferStream : public ISeekStream {
  public:
-  MemoryBufferStream(std::string *p_buffer) 
+  explicit MemoryBufferStream(std::string *p_buffer)
       : p_buffer_(p_buffer) {
     curr_ptr_ = 0;
   }
@@ -82,7 +86,7 @@ struct MemoryBufferStream : public ISeekStream {
     if (curr_ptr_ + size > p_buffer_->length()) {
       p_buffer_->resize(curr_ptr_+size);
     }
-    memcpy(&(*p_buffer_)[0] + curr_ptr_, ptr, size); 
+    memcpy(&(*p_buffer_)[0] + curr_ptr_, ptr, size);
     curr_ptr_ += size;
   }
   virtual void Seek(size_t pos) {
@@ -97,36 +101,7 @@ struct MemoryBufferStream : public ISeekStream {
   std::string *p_buffer_;
   /*! \brief current pointer */
   size_t curr_ptr_;
-}; // class MemoryBufferStream
-
-/*! \brief implementation of file i/o stream */
-class FileStream : public ISeekStream {
- public:
-  explicit FileStream(FILE *fp) : fp(fp) {}
-  explicit FileStream(void) {
-    this->fp = NULL;
-  }
-  virtual size_t Read(void *ptr, size_t size) {
-    return std::fread(ptr, size, 1, fp);
-  }
-  virtual void Write(const void *ptr, size_t size) {
-    std::fwrite(ptr, size, 1, fp);
-  }
-  virtual void Seek(size_t pos) {
-    std::fseek(fp, static_cast<long>(pos), SEEK_SET);
-  }
-  virtual size_t Tell(void) {
-    return std::ftell(fp);
-  }
-  inline void Close(void) {
-    if (fp != NULL){
-      std::fclose(fp); fp = NULL;
-    }
-  }
-
- private:
-  FILE *fp;
-};
+};  // class MemoryBufferStream
 }  // namespace utils
 }  // namespace rabit
-#endif
+#endif  // RABIT_UTILS_IO_H_

include/rabit/utils.h

@@ -1,10 +1,11 @@
-#ifndef RABIT_UTILS_H_
-#define RABIT_UTILS_H_
 /*!
+ *  Copyright (c) 2014 by Contributors
  * \file utils.h
  * \brief simple utils to support the code
  * \author Tianqi Chen
  */
+#ifndef RABIT_UTILS_H_
+#define RABIT_UTILS_H_
 #define _CRT_SECURE_NO_WARNINGS
 #include <cstdio>
 #include <string>
@@ -19,7 +20,7 @@
 #define fopen64 std::fopen
 #endif
 #ifdef _MSC_VER
-// NOTE: sprintf_s is not equivalent to snprintf, 
+// NOTE: sprintf_s is not equivalent to snprintf,
 // they are equivalent when success, which is sufficient for our case
 #define snprintf sprintf_s
 #define vsnprintf vsprintf_s
@@ -30,7 +31,7 @@
 #endif
 #endif
 
-#ifdef __APPLE__ 
+#ifdef __APPLE__
 #define off64_t off_t
 #define fopen64 std::fopen
 #endif
@@ -186,5 +187,5 @@ inline const char* BeginPtr(const std::string &str) {
   if (str.length() == 0) return NULL;
   return &str[0];
 }
-} // namespace rabit
+}  // namespace rabit
 #endif  // RABIT_UTILS_H_

include/rabit_serializable.h

@@ -1,13 +1,14 @@
-#ifndef RABIT_RABIT_SERIALIZABLE_H
-#define RABIT_RABIT_SERIALIZABLE_H
-#include <vector>
-#include <string>
-#include "./rabit/utils.h"
 /*!
+ *  Copyright (c) 2014 by Contributors
  * \file serializable.h
  * \brief defines serializable interface of rabit
  * \author Tianqi Chen
  */
+#ifndef RABIT_RABIT_SERIALIZABLE_H_
+#define RABIT_RABIT_SERIALIZABLE_H_
+#include <vector>
+#include <string>
+#include "./rabit/utils.h"
 namespace rabit {
 /*!
  * \brief interface of stream I/O, used by ISerializable
@@ -96,4 +97,4 @@ class ISerializable {
   virtual void Save(IStream &fo) const = 0;
 };
 }  // namespace rabit
-#endif
+#endif  // RABIT_RABIT_SERIALIZABLE_H_