Document changes for upcoming v0.2.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 5ca56d74843bc17ee1e32219f9fe9edb83c06b97..25d7642599604dba642e9ec0386f5c8721e5dbad 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -76,9 +76,11 @@ namespace opt {
     double comp_time_delay = 0.0;               // fixme: find better defaults
 
     // Parameters for the end of the simulation
     double comp_time_delay = 0.0;               // fixme: find better defaults
 
     // Parameters for the end of the simulation

+    double avg_load_ratio = 0.0;

     unsigned lb_maxiter = 0;
     unsigned comp_maxiter = 0;
     double time_limit = 0;
     unsigned lb_maxiter = 0;
     unsigned comp_maxiter = 0;
     double time_limit = 0;

+    int exit_on_convergence = 0;

     bool exit_on_close = true;
 
     // Named parameters lists
     bool exit_on_close = true;
 
     // Named parameters lists


@@ -231,9 +233,13 @@ bool opt::parse_args(int* argc, char* argv[])
     int c;
     opterr = 0;
     while ((c = getopt(*argc, argv,
     int c;
     opterr = 0;
     while ((c = getopt(*argc, argv,

-                       "a:bc:C:d:D:eEhi:I:k:l:L:m:M:N:r:Rs:S:t:T:vVx:X:Z"))
+                       "%:"
+                       "a:bc:C:d:D:eEg:hi:I:k:l:L:m:M:N:r:Rs:S:t:T:vVx:X:Z"))

            != -1) {
         switch (c) {
            != -1) {
         switch (c) {

+        case '%':
+            PARSE_ARG(opt::avg_load_ratio);
+            break;

         case 'a':
             opt::loba_algo = optarg;
             result = opt_helper::nol_find_prefix(opt::loba_algorithms,
         case 'a':
             opt::loba_algo = optarg;
             result = opt_helper::nol_find_prefix(opt::loba_algorithms,


@@ -274,6 +280,9 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'E':
             opt::egocentric = !opt::egocentric;
             break;
         case 'E':
             opt::egocentric = !opt::egocentric;
             break;

+        case 'g':
+            PARSE_ARG(opt::exit_on_convergence);
+            break;

         case 'h':
             opt::help_requested++;
             break;
         case 'h':
             opt::help_requested++;
             break;


@@ -350,13 +359,6 @@ bool opt::parse_args(int* argc, char* argv[])
 
 #undef PARSE_ARG
 
 
 #undef PARSE_ARG
 

-    if (opt::option_x) {        // FIXME: remove this one day...
-        opt::loba_best_divisor = opt::option_x;
-        XBT_WARN("divisor for algorithms *best* set from option -x (%d => %u),"
-                 " use -k instead",
-                 opt::option_x, opt::loba_best_divisor);
-    }
-

     if (opt::version_requested || opt::help_requested)
         return 1;
 
     if (opt::version_requested || opt::help_requested)
         return 1;
 


@@ -425,8 +427,6 @@ void opt::print()
     DESCR("load balancing algorithm", "%s", loba_algo.c_str());
     DESCR("bookkeeping", "%s", h.on_off(bookkeeping));
     DESCR("egocentric mode", "%s", h.on_off(egocentric));
     DESCR("load balancing algorithm", "%s", loba_algo.c_str());
     DESCR("bookkeeping", "%s", h.on_off(bookkeeping));
     DESCR("egocentric mode", "%s", h.on_off(egocentric));

-    DESCR("minimum duration between lb. iterations", "%g",
-          min_lb_iter_duration);

     DESCR("computation cost factors", "[%s]", comp_cost.to_string().c_str());
     DESCR("communication cost factors", "[%s]", comm_cost.to_string().c_str());
     DESCR("minimum data transfer amount", "%g", min_transfer_amount);
     DESCR("computation cost factors", "[%s]", comp_cost.to_string().c_str());
     DESCR("communication cost factors", "[%s]", comm_cost.to_string().c_str());
     DESCR("minimum data transfer amount", "%g", min_transfer_amount);


@@ -435,6 +435,8 @@ void opt::print()
     DESCR("only transfer integer data shares", "%s",
           h.on_off(integer_transfer));
     DESCR("divisor for algorithms *best*", "%u", loba_best_divisor);
     DESCR("only transfer integer data shares", "%s",
           h.on_off(integer_transfer));
     DESCR("divisor for algorithms *best*", "%u", loba_best_divisor);

+    DESCR("minimum duration between lb. iterations", "%g",
+          min_lb_iter_duration);

     DESCR("minimum duration between comp. iterations", "%g",
           min_comp_iter_duration);
     DESCR("computations start after lb. iter", "%u", comp_iter_delay);
     DESCR("minimum duration between comp. iterations", "%g",
           min_comp_iter_duration);
     DESCR("computations start after lb. iter", "%u", comp_iter_delay);


@@ -443,7 +445,10 @@ void opt::print()
           h.val_or_string(lb_maxiter, "no limit"));
     DESCR("maximum number of comp. iterations", "%s",
           h.val_or_string(comp_maxiter, "no limit"));
           h.val_or_string(lb_maxiter, "no limit"));
     DESCR("maximum number of comp. iterations", "%s",
           h.val_or_string(comp_maxiter, "no limit"));

+    DESCR("convergence is assumed within (\%)", "%g", opt::avg_load_ratio);

     DESCR("time limit", "%s", h.val_or_string(time_limit, "no limit"));
     DESCR("time limit", "%s", h.val_or_string(time_limit, "no limit"));

+    DESCR("exit on convergence", "%s",
+          h.val_or_string(exit_on_convergence, "disabled"));

     DESCR("exit on close", "%s", h.on_off(exit_on_close));
     XBT_INFO("`----");
 
     DESCR("exit on close", "%s", h.on_off(exit_on_close));
     XBT_INFO("`----");
 


@@ -562,6 +567,18 @@ void opt::usage()
     std::clog << o("-I value")
               << "maximum number of comp. iterations, 0 for no limit"
               << " [" << opt::comp_maxiter << "]\n";
     std::clog << o("-I value")
               << "maximum number of comp. iterations, 0 for no limit"
               << " [" << opt::comp_maxiter << "]\n";

+    std::clog << o("-% value")
+              << "percent of the load average to assume the convergence"
+              << " [" << opt::avg_load_ratio << "]\n";
+    if (opt::help_requested > 1)
+        std::clog << o("")
+                  << "- if negative: use 100 * (nhosts / -value) / avg_load\n";
+    std::clog << o("-g value")
+              << "number of consecutive detections of convergence to exit"
+              << " [" << opt::exit_on_convergence << "]\n";
+    if (opt::help_requested > 1)
+        std::clog << o("")
+                  << "- use 0 to disable\n";

     std::clog << o("-t value")
               << "time limit (simulated time), 0 for no limit"
               << " [" << opt::time_limit << "]\n";
     std::clog << o("-t value")
               << "time limit (simulated time), 0 for no limit"
               << " [" << opt::time_limit << "]\n";