Add more documentation.

[loba.git] / process.h

diff --git a/process.h b/process.h
index 607a6af130e1dc330f555d4b5b23edc45eea8c24..268fac9a2902641225f3145bf9cd3f30283f1aaa 100644 (file)
--- a/process.h
+++ b/process.h
@@ -26,35 +26,58 @@ protected:
     typedef std::vector<neighbor> neigh_type;
     typedef std::vector<neighbor*> pneigh_type;
 
     typedef std::vector<neighbor> neigh_type;
     typedef std::vector<neighbor*> pneigh_type;
 

-    neigh_type neigh;
-    pneigh_type pneigh;
+    pneigh_type pneigh;         // list of pointers to neighbors that
+                                // we are free to reorder
+
+    // Returns the sum of "to_send" for all neighbors.
+    double sum_of_to_send() const;

 
 private:
     typedef MAP_TEMPLATE<m_host_t, neighbor*> rev_neigh_type;
 
 private:
     typedef MAP_TEMPLATE<m_host_t, neighbor*> rev_neigh_type;

-    enum recv_wait_mode { NO_WAIT = 0, WAIT, WAIT_FOR_CLOSE };

 
 

-    rev_neigh_type rev_neigh;
+    neigh_type neigh;           // list of neighbors (do not alter
+                                // after construction!)
+    rev_neigh_type rev_neigh;   // map m_host_t -> neighbor

 
 

-    communicator comm;
-    int ctrl_close_pending;
-    int data_close_pending;
+    communicator comm;          // communicator for this process
+    int ctrl_close_pending;     // number of "close" messages to wait
+                                // on ctrl channel
+    int data_close_pending;     // number of "close" messages to wait
+                                // on data channel

 
 

-    unsigned iter;
+    unsigned iter;              // counter of iterations

 
 

-    double prev_load_broadcast;
-    double load;
-    double expected_load;
+    double prev_load_broadcast; // used to ensure that we do not send
+                                // a same information messages
+    double load;                // current load
+    double expected_load;       // expected load in bookkeeping mode

 
 

-    double sum_of_to_send() const;
+    // The load balancing algorithm comes here...
+    // Parameter "my_load" is the load to take into account for myself
+    // (may be load or expected load).
+    // Returns the total load sent to neighbors.

     virtual double load_balance(double my_load);
 
     virtual double load_balance(double my_load);
 

+    // Virtually do some computation

     void compute();
     void compute();

+
+    // Send procedures, with helpers for bookkeeping mode or not

     void send1_no_bookkeeping(neighbor& nb);
     void send1_bookkeeping(neighbor& nb);
     void send();
     void send1_no_bookkeeping(neighbor& nb);
     void send1_bookkeeping(neighbor& nb);
     void send();

+
+    // Receive procedure: wait (or not) for a message to come.
+    // Returns false if some "close" message was received, returns true
+    // otherwise.
+    enum recv_wait_mode { NO_WAIT = 0, WAIT, WAIT_FOR_CLOSE };

     bool receive(recv_wait_mode wait);
     bool receive(recv_wait_mode wait);

+
+    // Finalize sends a "close" message to each neighbor and wait for
+    // all of them to answer.

     void finalize1(neighbor& nb);
     void finalize();
     void finalize1(neighbor& nb);
     void finalize();

+
+    // Print with given priority what we know about our neighbors' loads

     void print_loads(e_xbt_log_priority_t logp = xbt_log_priority_info);
 };
 
     void print_loads(e_xbt_log_priority_t logp = xbt_log_priority_info);
 };