To #184: finish .funcpieces

By fixing autolinking

CHANGES.mp.md

@@ -1,11 +1,24 @@
 Summary of recent updates to the AMPL MP Library
 ================================================
 
+## 20220720
+- *Propagating suffixes via expression trees into flat constraints*
+    Partially implemented #184. x-gurobi accepts options
+    'funcpieces...' and corresponding suffixes which are passed into
+    GRBaddgenconstrExp etc.
+
+    Subexpressions: note that if a subexpression is contained in several
+    constraints, for contradicting suffix values the maximum is taken.
+
+- *Option 'cvt:writegraph'*
+   Exporting the flattening / conversion graph in JSON Lines format (WIP).
+
+
 ## 20220617
 - *PowConstraint is reduced to quadratics in some cases*
     For constant non-negative integer exponent and base variables
     with negative lower bound, PowConstraint
-    is reduced to quadratics (possibly ewith auxiliary variables).
+    is reduced to quadratics (possibly with auxiliary variables).
     Reason: Gurobi's GRBaddgenconstrPow
     not accepting negative bases.
 

CMakeLists.txt

@@ -436,9 +436,6 @@ endif ()
 
 option(BUILD_DOC "Build documentation" ON)
 if(BUILD_DOC)
-  message(STATUS
-    "Building documentation (if the requirements are installed). "
-    "Set BUILD_DOC=off otherwise.")
   add_subdirectory(doc)
 endif()
 add_subdirectory(src/asl)

README.rst

@@ -5,8 +5,6 @@ AMPL/MP
 MP Library is a set of tools recommended to create new AMPL solver interfaces.
 See `documentation <https://amplmp.readthedocs.io/en/latest/>`_.
 
-If the above link is not accessible, see documentation sources in folder ``doc``.
-
 
 Links
 -----

doc/CMakeLists.txt

@@ -1,17 +1,22 @@
 # Check requirements.
-# Use specific version of Sphinx which fixes local search and has
-# better C++ support.
+# Use the specific version of Sphinx (see requirements.txt)
+# which fixes local search and has better C++ support.
 find_program(DOXYGEN doxygen)
 if (NOT DOXYGEN)
   message(STATUS "Target doc disabled (requires doxygen)")
   return ()
 endif ()
+
 find_package(Sphinx)
 if(NOT SPHINX_EXECUTABLE)
   message(STATUS "Documentation generation disabled (requires sphinx)")
   return()
 endif()
 
+message(STATUS
+  "Documentation building configured. "
+  "Set BUILD_DOC=off otherwise.")
+
 add_prefix(doc_deps ../ ${MP_ALL_HEADERS})
 
 set(DOC_BASEDIR ${CMAKE_CURRENT_SOURCE_DIR})

doc/rst/components.rst

@@ -265,6 +265,8 @@ via the solver's modeling API wrapper:
 * :ref:`value-presolver` transforms solutions and suffixes between the
   original NL model and the flat model.
 
+* :ref:`conversion-graph` discusses exporting of the flattening / conversion graph.
+
 
 .. _flat-model-api:
 
@@ -380,10 +382,28 @@ To implement value pre- / postsolving, the following API is used:
 
 - `mp::pre::BasicLink` is the interface to various implementations of links
   between nodes, such as
-  `mp::pre::CopyLink`. Templates `mp::pre::BasicIndivEntryLink` and
-  `mp::pre::BasicStaticIndivEntryLink` are base classes for links such as
+  `mp::pre::CopyLink`, `mp::pre::One2ManyLink`, and
   `mp::pre::RangeCon2Slack`.
 
+- Expression tree flattenings into new constraints and variables,
+  as well as subsequent conversions,
+  are by default automatically linked by `mp::pre::One2ManyLink`.
+  To implement a specific link, see the example of `mp::pre::RangeCon2Slack`.
+  In particular, autolinking should normally be turned off.
+
+
+.. _conversion-graph:
+
+Conversion graph
+~~~~~~~~~~~~~~~~
+
+The flattening and conversion graph can be exported by the `cvt:writegraph`
+option (WIP).
+
+At the moment only arcs are exported. Terminal nodes (variables, constraints,
+objectives) can be seen in the NL model (ampl: `expand`) and the
+final flat model (x-gurobi: option `writeprob`).
+
 
 C++ ASL adapter
 ---------------

doc/rst/intro.rst

@@ -51,7 +51,10 @@ An included `CMake build script`__ can be used to build the MP library,
 solver interfaces and function libraries on a wide range of platforms.
 You can download CMake for free from http://www.cmake.org/download/.
 
-__ CMakeLists.txt
+__ /~https://github.com/ampl/mp/tree/master/CMakeLists.txt
+
+CMake workflow
+``````````````
 
 CMake works by generating native makefiles or project files that can
 be used in the compiler environment of your choice. The typical
@@ -151,12 +154,18 @@ the index.
 Building the documentation
 ``````````````````````````
 
-To build the documentation (automatically, via CMake) you need Python 3.x with Sphinx and Breathe,
-see :file:`doc/requirements.txt` (install automatically by :code:`pip install -r requirements.txt`).
-The HTML output is located in :file:`(build folder)/doc/index.html`. To have the alphabetic index
-automatically generated, install `pandoc`.
-Configure CMake with
-:code:`-DBUILD_DOC=off` to switch off.
+To build the documentation (automatically, via CMake) you need `Doxygen`__
+as well as Python 3.x with Sphinx and Breathe,
+see :file:`doc/requirements.txt` (install automatically by
+:code:`pip install -r requirements.txt`).
+The HTML output is located in :file:`(build folder)/doc/index.html`.
+To have the alphabetic index automatically generated, install `pandoc`.
+
+__ https://doxygen.nl/
+
+Configure CMake with :code:`-DBUILD_DOC=off` to switch documentation
+building off.
+
 
 
 

include/mp/flat/convert_functional.h

@@ -36,7 +36,7 @@ class BasicFCC {
       if (GetConverter().DoingAutoLinking()) {  // Autolink known targets
         auto& varvn = GetConverter().GetVarValueNode();
         GetConverter().AutoLink( varvn.Select(GetResultVar()) );
-        auto& ck = GetConverter().template GetConstraintKeeper(
+        auto& ck = GetConverter().GetConstraintKeeper(
               (Constraint*)0 );
         GetConverter().AutoLink( ck.SelectValueNodeRange(i) );
       }

include/mp/flat/redef/std/range_con.h

@@ -55,31 +55,27 @@ class RangeCon2Slack :
   /// (3 is the base class template parameter)
   /// and means the following indexes: {range_con, lin_con, slack_index}
 
-  /// MaxAmongNon0 double: a generic value presolve method.
-  /// TODO move these to BasicLink via abstract interface.
+  /// PresolveGeneric double
   void PresolveGenericDblEntry(const typename Base::LinkEntry& be) {
     auto src_val = GetDbl(be, CON_SRC);
     SetDbl(be, CON_TARGET, src_val);
     SetDbl(be, VAR_SLK, src_val);
   }
 
-  /// MaxAmongNon0 double: a generic value postsolve method.
-  /// Assume we don't meet another value.
+  /// PostsolveGeneric double
   void PostsolveGenericDblEntry(const typename Base::LinkEntry& be) {
     SetDbl(be, CON_SRC, std::max(
              GetDbl(be, CON_TARGET), GetDbl(be, VAR_SLK)));
   }
 
-  /// MaxAmongNon0 int: a generic value presolve method.
-  /// Assume we don't meet another value.
+  /// PresolveGeneric int
   void PresolveGenericIntEntry(const typename Base::LinkEntry& be) {
     auto src_val = GetInt(be, CON_SRC);
     SetInt(be, CON_TARGET, src_val);
     SetInt(be, VAR_SLK, src_val);
   }
 
-  /// MaxAmongNon0 int: a generic value postsolve method.
-  /// Assume we don't meet another value.
+  /// PostsolveGeneric int
   void PostsolveGenericIntEntry(const typename Base::LinkEntry& be) {
     SetInt(be, CON_SRC, std::max(
              GetInt(be, CON_TARGET), GetInt(be, VAR_SLK)));
@@ -143,6 +139,7 @@ class RangeCon2Slack :
   }
 
 protected:
+  /// Get the model converter
   ModelConverter& GetMC() { return cvt_; }
 
   using Base::GetInt;

include/mp/utils-file.h

@@ -32,7 +32,7 @@ namespace mp {
 class BasicFileAppender {
 public:
   /// Destruct
-  ~BasicFileAppender() { }
+  virtual ~BasicFileAppender() { }
 
   /// Open file
   virtual bool Open(const std::string& fln, bool fErase) = 0;

include/mp/valcvt-base.h

@@ -64,7 +64,7 @@ class ValueMap {
   template <class SomeArray>
   ValueMap(SomeArray r) :
       map_{ {0, std::move(r) } } {
-    SetValueNodeName(map_.at(0), name_ + "[0]");
+    SetValueNodeName(map_.at(0), name_ + "()");
   }
 
   /// Construct from the low-level MapType
@@ -116,9 +116,10 @@ class ValueMap {
   Array& operator()() {
     if (map_.empty())
       SetValueNodeName(
-            *map_.insert({ 0,
-                           CreateArray<Array, Param>(prm_) }).first,
-            name_ + "[0]");
+            map_.insert({ 0,
+                           CreateArray<Array, Param>(prm_) }).
+            first->second,
+            name_ + "()");
     else
       assert(IsSingleKey());
     return map_.at(0);
@@ -134,8 +135,8 @@ class ValueMap {
     if (map_.end() == map_.find(i)) {
       Array arr = CreateArray<Array, Param>(prm_);
       SetValueNodeName(
-            *map_.insert({ i, std::move(arr) }).first,
-            name_ + std::to_string(i));
+            map_.insert({ i, std::move(arr) }).first->second,
+            name_ + '(' + std::to_string(i) + ')');
     }
     return map_.at(i);
   }
@@ -156,7 +157,7 @@ class ValueMap {
 
 private:
   Param prm_;
-  std::string name_ { "default_value_map" };
+  std::string name_ { "VMapName__unset" };
   MapType map_;
 };
 
@@ -181,7 +182,7 @@ class ModelValues {
   using ParamType = typename VMap::ParamType;
 
   /// Constructor
-  ModelValues(ParamType prm, std::string nm) :
+  ModelValues(ParamType prm, const std::string& nm) :
       name_{nm}, vars_(prm), cons_(prm), objs_(prm) {
     vars_.SetName(nm+"_vars");
     cons_.SetName(nm+"_cons");

include/mp/valcvt-link.h

@@ -441,7 +441,7 @@ class AutoLinkScope {
         for (const auto& t: targets) {
           assert(t.IsValid());
           cvt_.GetOne2ManyLink().AddEntry(   // use One2ManyLink
-                { cvt_.GetAutoLinkSource(), targets.front() } );
+                { cvt_.GetAutoLinkSource(), t } );
         }
       }
     }

include/mp/valcvt-node.h

@@ -265,11 +265,13 @@ void ValueNode::SetVal<int>(size_t i, int v) { SetInt(i, v); }
 
 /// Specialize SetValueNodeName() for ValueNode
 inline void
-SetValueNodeName(ValueNode& vn, std::string nm) { vn.SetName(nm); }
+SetValueNodeName(ValueNode& vn, std::string nm)
+{ vn.SetName(std::move(nm)); }
 
 
-/// Default CreateArray() for ValueNode
+/// Specialize CreateArray() for ValueNode
 template <>
+inline
 ValueNode CreateArray(BasicValuePresolver& vp) { return ValueNode{vp}; }
 
 

include/mp/valcvt.h

@@ -210,8 +210,8 @@ class ValuePresolver : public BasicValuePresolver {
 
   /// val_nodes_ should be before src_ / dest_
   mutable ModelValuesTerminal
-    src_{*this, "src__"},
-    dest_{*this, "dest__"};
+    src_{*this, "src"},
+    dest_{*this, "dest"};
 
   /// The link ranges
   LinkRangeList brl_;

solvers/gurobi/CHANGES.gurobi.md

@@ -1,8 +1,18 @@
 Summary of recent updates to x-gurobi for AMPL
 ==============================================
 
+## 20220720
+- *Options 'funcpieces', 'funcpiecelength', 'funcpieceratio', 'funcpieceerror'*
+    The above options (and corresponding suffixes) are passed to Gurobi. The
+    suffixes can specialize the values for individual constraints.
+
+    Subexpressions: note that if a subexpression is contained in several
+    constraints, for contradicting suffix values the maximum is taken.
+
+
 ## 20220706
-- Relinked with Gurobi 9.5.2, which contains bug fixes
+- *Relinked with Gurobi 9.5.2, which contains bug fixes*
+
 
 ## 20220511
 - *Complementarity constraints: also quadratics*

solvers/gurobi/gurobibackend.cc

@@ -2209,8 +2209,6 @@ static void DoPlayGrbObjNParams(
 void GurobiBackend::GrbPlayObjNParams() {
   int nobj;
   GRB_CALL( GRBgetintattr(model(), GRB_INT_ATTR_NUMOBJ, &nobj) );
-  if (debug_mode())
-    printf("Number of objectives: %d\n", nobj);
   DoPlayGrbObjNParams(objnparam_int_, model(), env());
   DoPlayGrbObjNParams(objnparam_dbl_, model(), env());
 }

src/utils_file.cc

@@ -34,8 +34,10 @@ class FileAppender__fstream : public BasicFileAppender {
 public:
   /// Open file
   bool Open(const std::string& fln, bool fErase=false) override {
-    fs_.open(fln,
-             fErase ? std::ios::app|std::ios::ate : std::ios::app);
+    if (fErase) {
+      std::ofstream ofs(fln, std::ios::trunc | std::ios::out);
+    }
+    fs_.open(fln, std::ios::app | std::ios::out);
     return fs_.good();
   }
 
@@ -47,7 +49,7 @@ class FileAppender__fstream : public BasicFileAppender {
 
 
 private:
-  std::fstream fs_;
+  std::ofstream fs_;
 };
 
 /// FileAppender maker