Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
forbid an incomplete and unused constructor
[simgrid.git] / src / kernel / lmm / maxmin.hpp
index be288f2..e5efd9d 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -85,7 +85,7 @@ namespace lmm {
  *
  *     max( var1.weight * var1.value * elem5.value  ,  var3.weight * var3.value * elem6.value ) <= cons3.bound
  *
- * This is usefull for the sharing of resources for various models.
+ * This is useful for the sharing of resources for various models.
  * For instance, for the network model, each link is associated to a constraint and each communication to a variable.
  *
  * Implementation details
@@ -145,9 +145,9 @@ XBT_PUBLIC(void) bottleneck_solve(lmm_system_t sys);
 /** Default functions associated to the chosen protocol. When using the lagrangian approach. */
 
 XBT_PUBLIC(void)
-lmm_set_default_protocol_function(double (*func_f)(const Variable& var, double x),
-                                  double (*func_fp)(const Variable& var, double x),
-                                  double (*func_fpi)(const Variable& var, double x));
+set_default_protocol_function(double (*func_f)(const Variable& var, double x),
+                              double (*func_fp)(const Variable& var, double x),
+                              double (*func_fpi)(const Variable& var, double x));
 
 XBT_PUBLIC(double) func_reno_f(const Variable& var, double x);
 XBT_PUBLIC(double) func_reno_fp(const Variable& var, double x);
@@ -209,7 +209,7 @@ struct ConstraintLight {
 XBT_PUBLIC_CLASS Constraint
 {
 public:
-  Constraint() = default;
+  Constraint() = delete;
   Constraint(void* id_value, double bound_value);
 
   /** @brief Unshare a constraint. */
@@ -230,7 +230,7 @@ public:
 
   /**
    * @brief Sets the concurrency limit for this constraint
-   * @param concurrency_limit The concurrency limit to use for this constraint
+   * @param limit The concurrency limit to use for this constraint
    */
   void set_concurrency_limit(int limit)
   {
@@ -314,7 +314,7 @@ public:
   int concurrency_maximum; /* The maximum number of (enabled and disabled) variables associated to the constraint at any
                             * given time (essentially for tracing)*/
 
-  int sharing_policy; /* see @e_surf_link_sharing_policy_t (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
+  int sharing_policy; /* see @e_surf_link_sharing_policy_t (0: FATPIPE, 1: SHARED, 2: SPLITDUPLEX) */
   int id_int;
   double lambda;
   double new_lambda;
@@ -353,7 +353,7 @@ public:
 
   /**
    * @brief Set the concurrent share of the variable
-   * @param concurrency_share The new concurrency share
+   * @param value The new concurrency share
    */
   void set_concurrency_share(short int value) { concurrency_share = value; }
 
@@ -416,7 +416,7 @@ public:
   short int concurrency_share; /* The maximum number of elements that variable will add to a constraint */
   simgrid::surf::Action* id;
   int id_int;
-  unsigned visited; /* used by lmm_update_modified_set */
+  unsigned visited; /* used by System::update_modified_set() */
   /* \begin{For Lagrange only} */
   double mu;
   double new_mu;
@@ -442,16 +442,16 @@ inline void Element::make_inactive()
 /**
  * @brief LMM system
  */
-XBT_PUBLIC_CLASS s_lmm_system_t
+XBT_PUBLIC_CLASS System
 {
 public:
   /**
    * @brief Create a new Linear MaxMim system
    * @param selective_update whether we should do lazy updates
    */
-  explicit s_lmm_system_t(bool selective_update);
+  explicit System(bool selective_update);
   /** @brief Free an existing Linear MaxMin system */
-  ~s_lmm_system_t();
+  ~System();
 
   /**
    * @brief Create a new Linear MaxMin constraint
@@ -609,8 +609,8 @@ public:
 
 private:
   bool selective_update_active; /* flag to update partially the system only selecting changed portions */
-  unsigned visited_counter;     /* used by lmm_update_modified_set and lmm_remove_modified_set to cleverly (un-)flag the
-                                 * constraints (more details in these functions) */
+  unsigned visited_counter;     /* used by System::update_modified_set() and System::remove_all_modified_set() to
+                                 * cleverly (un-)flag the constraints (more details in these functions) */
   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
                                                                    &Constraint::constraint_set_hook>>
       constraint_set;