options.cpp

/*
 *    This file is part of CasADi.
 *
 *    CasADi -- A symbolic framework for dynamic optimization.
 *    Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
 *                            KU Leuven. All rights reserved.
 *    Copyright (C) 2011-2014 Greg Horn
 *
 *    CasADi is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 3 of the License, or (at your option) any later version.
 *
 *    CasADi is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with CasADi; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
 
 
#include "options.hpp"
#include <algorithm>
#include <locale>
 
namespace casadi {
 
  const Options::Entry* Options::find(const std::string& name) const {
    // Check if in one of the bases
    for (auto&& b : bases) {
      const Options::Entry* entry = b->find(name);
      if (entry) return entry;
    }
 
    // Lookup in this class
    auto it = entries.find(name);
    if (it!=entries.end()) {
      return &it->second;
    } else {
      return nullptr;
    }
  }
 
  void Options::Entry::disp(const std::string& name, std::ostream &stream) const {
    stream << "> \"" << name << "\"          ["
           << GenericType::get_type_description(this->type)
           << "] ";
 
    // Print out the description on a new line.
    stream << "     \"" << this->description << "\""<< std::endl;
  }
 
  void Options::disp(std::ostream& stream) const {
    // Print bases
    for (auto&& b : bases) {
      b->disp(stream);
    }
 
    // Print all entries
    for (auto&& e : entries) {
      e.second.disp(e.first, stream);
    }
  }
 
  double Options::word_distance(const std::string &a, const std::string &b) {
    if (a == b) return 0;
    casadi_int na = a.size();
    casadi_int nb = b.size();
    if (na == 0) return static_cast<double>(nb);
    if (nb == 0) return static_cast<double>(na);
 
    std::vector<casadi_int> v0(nb+1, 0);
    std::vector<casadi_int> v1(nb+1, 0);
 
    for (casadi_int i=0;i<nb+1;++i)
      v0[i] = i;
 
    char s;
    char t;
    std::locale loc;
    for (casadi_int i=0;i<na;i++) {
      v1[0] = i + 1;
      for (casadi_int j=0; j<nb; j++) {
        s = std::tolower(a[i], loc);
        t = std::tolower(b[j], loc);
        casadi_int cost = 0;
        if (s != t)
          cost = 1;
 
        v1[j+1] = std::min(std::min(v1[j] + 1, v0[j+1] + 1), v0[j] + cost);
      }
 
      for (casadi_int j=0; j<nb+1; j++)
        v0[j] = v1[j];
    }
 
    return static_cast<double>(v1[nb]);
  }
 
  std::vector<std::string> Options::suggestions(const std::string& word, casadi_int amount) const {
    // Best distances so far
    const double inf = std::numeric_limits<double>::infinity();
    std::vector<std::pair<double, std::string>> best(amount, {inf, ""});
 
    // Iterate over elements
    best_matches(word, best);
 
    // Sort the elements in ascending order
    stable_sort(best.begin(), best.end());
 
    // Collect the values that are non-infinite
    std::vector<std::string> ret;
    ret.reserve(amount);
    for (auto&& e : best) {
      if (e.first!=inf) {
        ret.push_back(e.second);
      }
    }
    return ret;
  }
 
  void Options::best_matches(const std::string& word,
                             std::vector<std::pair<double, std::string> >& best) const {
    // Iterate over bases
    for (auto&& b : bases) {
      b->best_matches(word, best);
    }
 
    // Worst match so far
    auto worst = max_element(best.begin(), best.end());
 
    // Loop over entries
    for (auto&& e : entries) {
      // Get word distance
      double d = word_distance(e.first, word);
 
      // Keep if better than the worst amongst the suggestions
      if (d < worst->first) {
        worst->first = d;
        worst->second = e.first;
        worst = max_element(best.begin(), best.end());
      }
    }
  }
 
  bool Options::has_dot(const Dict& opts) {
    for (auto&& op : opts) {
      if (op.first.find('.') != std::string::npos || op.first.find("__") != std::string::npos) {
        return true;
      }
      // Call recursively
      if (op.second.is_dict() && has_dot(op.second)) return true;
    }
    return false;
  }
 
  bool Options::has_null(const Dict& opts) {
    for (auto&& op : opts) {
      if (op.second.is_null()) return true;
    }
    return false;
  }
 
  bool Options::is_sane(const Dict& opts) {
    return !has_dot(opts) && !has_null(opts);
  }
 
  Dict Options::sanitize(const Dict& opts, bool top_level) {
    // Drop nulls
    if (top_level && has_null(opts)) {
      // Create a new dictionary without the null entries
      Dict ret;
      for (auto&& op : opts) {
        if (!op.second.is_null()) ret[op.first] = op.second;
      }
      return sanitize(ret, false);
    }
 
    //  Treat the case where any of the options have a dot (dictionary shorthand)
    if (has_dot(opts)) {
      // New options dictionary being constructed
      Dict ret;
 
      // Sub-dictionary and corresponding name being constructed
      Dict sopts;
      std::string sname;
 
      // Process options
      for (auto&& op : opts) {
        // Find the dot if any
        std::string::size_type dotpos = op.first.find('.'), dotpos_end;
        if (dotpos==std::string::npos) {
          dotpos = op.first.find("__");
          if (dotpos!=std::string::npos) dotpos_end = dotpos+2;
        } else {
          dotpos_end = dotpos+1;
        }
 
        // Flush last sub-dictionary
        if (!sname.empty() && (dotpos==std::string::npos
                               || op.first.compare(0, dotpos, sname)!=0)) {
          update_dict(ret, sname, sanitize(sopts, false), true);
 
          sname.clear();
          sopts.clear();
        }
 
        GenericType value = op.second;
        if (value.is_dict()) {
          value = sanitize(value, false);
        }
 
        // Add to dictionary
        if (dotpos != std::string::npos) {
          sname = op.first.substr(0, dotpos);
          std::string target_name = op.first.substr(dotpos_end);
          sopts[target_name] = value;
        } else {
          update_dict(ret, op.first, value, true);
        }
      }
 
      // Flush trailing sub-dictionary
      if (!sname.empty()) {
        update_dict(ret, sname, sanitize(sopts, false), true);
      }
 
      return ret;
    }
 
    // Nothing to do
    return opts;
  }
 
  void Options::check(const Dict& opts) const {
    // Make sure all options exist and have the correct type
    for (auto&& op : opts) {
      const Options::Entry* entry = find(op.first);
 
      // Informative error message if option does not exist
      if (entry==nullptr) {
        std::stringstream ss;
        ss << "Unknown option: " << op.first << std::endl;
        ss << std::endl;
        ss << "Did you mean one of the following?" << std::endl;
        for (auto&& s : suggestions(op.first)) {
          print_one(s, ss);
        }
        ss << "Use print_options() to get a full list of options." << std::endl;
        casadi_error(ss.str());
      }
 
      // Check type
      casadi_assert(op.second.can_cast_to(entry->type),
                            "Illegal type for " + op.first + ": " +
                            op.second.get_description() +
                            " cannot be cast to " +
                            GenericType::get_type_description(entry->type) + ".");
 
    }
  }
 
  void Options::print_all(std::ostream &stream) const {
    stream << "\"Option name\" [type] = value" << std::endl;
    disp(stream);
    stream << std::endl;
  }
 
  void Options::print_one(const std::string &name, std::ostream &stream) const {
    const Options::Entry* entry = find(name);
    if (entry!=nullptr) {
      entry->disp(name, stream);
    } else {
      stream << "  \"" << name << "\" does not exist.";
    }
  }
 
  std::vector<std::string> Options::all() const {
    std::vector<std::string> ret;
    for (auto&& e : entries) ret.push_back(e.first);
    return ret;
  }
 
  std::string Options::type(const std::string& name) const {
    const Options::Entry* entry = find(name);
    casadi_assert(entry!=nullptr, "Option \"" + name + "\" does not exist");
    return GenericType::get_type_description(entry->type);
  }
 
  std::string Options::info(const std::string& name) const {
    const Options::Entry* entry = find(name);
    casadi_assert(entry!=nullptr, "Option \"" + name + "\" does not exist");
    return entry->description;
  }
 
} // namespace casadi