// Copyright (C) 2005, 2007 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// $Id: IpRegOptions.cpp 1861 2010-12-21 21:34:47Z andreasw $
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2005-06-18

#include "IpoptConfig.h"
#include "IpRegOptions.hpp"

#include <set>

#ifdef HAVE_CSTDIO
# include <cstdio>
#else
# ifdef HAVE_STDIO_H
#  include <stdio.h>
# else
#  error "don't have header file for stdio"
# endif
#endif

#ifdef HAVE_CCTYPE
# include <cctype>
#else
# ifdef HAVE_CTYPE_H
#  include <ctype.h>
# else
#  error "don't have header file for ctype"
# endif
#endif

namespace Ipopt
{

  Index RegisteredOption::next_counter_ = 1;

  void RegisteredOption::OutputDescription(const Journalist& jnlst) const
  {
    std::string type_str = "Unknown";
    if (type_ ==OT_Number) {
      type_str = "Real Number";
    }
    else if (type_ ==OT_Integer) {
      type_str = "Integer";
    }
    else if (type_ ==OT_String) {
      type_str = "String";
    }

    jnlst.Printf(J_SUMMARY, J_DOCUMENTATION,
                 "\n### %s (%s) ###\nCategory: %s\nDescription: %s\n",
                 name_.c_str(), type_str.c_str(),
                 registering_category_.c_str(), short_description_.c_str());

    if (type_ ==OT_Number) {
      if (has_lower_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%g", lower_);
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "-inf");
      }

      if (lower_strict_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " < ");
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <= ");
      }

      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "(%g)", default_number_);

      if (has_upper_ && upper_strict_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " < ");
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <= ");
      }

      if (has_upper_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%g\n", upper_);
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "+inf\n");
      }
    }
    else if (type_ ==OT_Integer) {
      if (has_lower_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%d", (Index)lower_);
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "-inf");
      }

      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <= (%d) <= ", (Index)default_number_);

      if (has_upper_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%d\n", (Index)upper_);
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "+inf\n");
      }
    }
    else if (type_ ==OT_String) {
      std::vector<string_entry>::const_iterator i;
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "Valid Settings:\n");
      for (i = valid_strings_.begin(); i != valid_strings_.end(); i++) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\t%s (%s)\n",
                     (*i).value_.c_str(), (*i).description_.c_str());
      }
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "Default: \"%s\"\n",
                   default_string_.c_str());
    }
  }

  void RegisteredOption::OutputLatexDescription(const Journalist& jnlst) const
  {
    std::string latex_name;
    MakeValidLatexString(name_, latex_name);
    std::string latex_desc;
    MakeValidLatexString(short_description_, latex_desc);
    jnlst.Printf(J_SUMMARY, J_DOCUMENTATION,
                 "\\paragraph{%s:}\\label{sec:%s} %s $\\;$ \\\\\n",
                 latex_name.c_str(),
                 name_.c_str(),
                 latex_desc.c_str());

    //    Index length = name_.length() + short_description_.length();
    //    DBG_ASSERT(length <= 80);
    //    jnlst.PrintStringOverLines(J_SUMMARY, J_DOCUMENTATION, 0, 50,
    //                               latex_desc.c_str());

    if (long_description_ != "") {
      latex_desc = "";
      MakeValidLatexString(long_description_, latex_desc);
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " ");
      jnlst.PrintStringOverLines(J_SUMMARY, J_DOCUMENTATION, 0, 50,
                                 latex_desc.c_str());
    }

    if (type_ == OT_Number) {
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION,
                   " The valid range for this real option is \n$");
      std::string buff;
      if (has_lower_) {
        buff = MakeValidLatexNumber(lower_);
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%s", buff.c_str());
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%s", "{\\tt -inf}");
      }

      if (has_lower_ && !lower_strict_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " \\le ");
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <  ");
      }

      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "{\\tt %s }", latex_name.c_str());

      if (has_upper_ && !upper_strict_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " \\le ");
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <  ");
      }

      if (has_upper_) {
        buff = MakeValidLatexNumber(upper_);
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%s", buff.c_str());
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%s", "{\\tt +inf}");
      }

      buff = MakeValidLatexNumber(default_number_);
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION,
                   "$\nand its default value is $%s$.\n\n", buff.c_str());

    }
    else if (type_ == OT_Integer) {
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION,
                   " The valid range for this integer option is\n$");
      if (has_lower_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%d \\le ", (Index)lower_);
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%s <  ", "{\\tt -inf}");
      }

      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "{\\tt %s }", latex_name.c_str());

      if (has_upper_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " \\le %d", (Index)upper_);
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <  %s", "{\\tt +inf}");
      }

      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION,
                   "$\nand its default value is $%d$.\n\n",
                   (Index)default_number_);
    }
    else if (type_ == OT_String) {
      std::string buff;
      MakeValidLatexString(default_string_, buff);
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION,
                   "\nThe default value for this string option is \"%s\".\n",
                   buff.c_str());

      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\\\\ \nPossible values:\n");
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\\begin{itemize}\n");
      for (std::vector<string_entry>::const_iterator
           i = valid_strings_.begin();
           i != valid_strings_.end(); i++) {
        std::string latex_value;
        MakeValidLatexString((*i).value_, latex_value);
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "   \\item %s: ",
                     latex_value.c_str());

        std::string latex_desc;
        MakeValidLatexString((*i).description_, latex_desc);
        jnlst.PrintStringOverLines(J_SUMMARY, J_DOCUMENTATION, 0, 48,
                                   latex_desc.c_str());
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\n");
      }
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\\end{itemize}\n");
    }
    jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\n");
  }

  void RegisteredOption::MakeValidLatexString(std::string source, std::string& dest) const
  {
    std::string::iterator c;
    for (c=source.begin(); c!=source.end(); c++) {
      if (*c == '_') {
        dest.append("\\_");
      }
      else if (*c == '^') {
        dest.append("\\^");
      }
      else {
        dest += *c;
      }
    }
  }

  std::string RegisteredOption::MakeValidLatexNumber(Number value) const
  {
    char buffer[256];
    Snprintf(buffer, 255, "%g", value);
    std::string source = buffer;
    std::string dest;

    std::string::iterator c;
    bool found_e = false;
    for (c=source.begin(); c!=source.end(); c++) {
      if (*c == 'e') {
        found_e = true;
        dest.append(" \\cdot 10^{");
      }
      else {
        dest += *c;
      }
    }
    if (found_e) {
      dest.append("}");
    }

    return dest;
  }

  void RegisteredOption::OutputShortDescription(const Journalist& jnlst) const
  {
    jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%-30s",  name_.c_str());


    if (type_ == OT_Number) {
      if (has_lower_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%10g", lower_);
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%10s", "-inf");
      }

      if (has_lower_ && !lower_strict_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <= ");
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <  ");
      }

      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "(%11g)", default_number_);

      if (has_upper_ && !upper_strict_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <= ");
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <  ");
      }

      if (has_upper_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%-10g\n", upper_);
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%-10s\n", "+inf");
      }
    }
    else if (type_ == OT_Integer) {
      if (has_lower_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%10d <= ", (Index)lower_);
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "%10s <  ", "-inf");
      }

      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "(%11d)",
                   (Index)default_number_);

      if (has_upper_) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <= %-10d\n", (Index)upper_);
      }
      else {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, " <  %-10s\n", "+inf");
      }
    }
    else if (type_ == OT_String) {
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "(\"%s\")\n",
                   default_string_.c_str());
    }
    jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "   ");
    jnlst.PrintStringOverLines(J_SUMMARY, J_DOCUMENTATION, 3, 76,
                               short_description_.c_str());
    if (long_description_ != "") {
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\n     ");
      jnlst.PrintStringOverLines(J_SUMMARY, J_DOCUMENTATION, 5, 74,
                                 long_description_.c_str());
    }
    if (type_ == OT_String) {
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\n   Possible values:\n");
      for (std::vector<string_entry>::const_iterator
           i = valid_strings_.begin();
           i != valid_strings_.end(); i++) {
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "    - %-23s [",
                     (*i).value_.c_str());

        jnlst.PrintStringOverLines(J_SUMMARY, J_DOCUMENTATION, 31, 48,
                                   (*i).description_.c_str());
        jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "]\n");
      }
    }
    else {
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\n");
    }
    jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\n");
  }

  bool RegisteredOption::IsValidStringSetting(const std::string& value) const
  {
    DBG_ASSERT(type_ == OT_String);

    std::vector<string_entry>::const_iterator i;
    for (i = valid_strings_.begin(); i != valid_strings_.end(); i++) {
      if (i->value_ == "*" || string_equal_insensitive(i->value_, value)) {
        return true;
      }
    }
    return false;
  }

  std::string
  RegisteredOption::MapStringSetting(const std::string& value) const
  {
    DBG_ASSERT(type_ == OT_String);

    std::string matched_setting = "";

    std::vector<string_entry>::const_iterator i;
    for (i = valid_strings_.begin(); i != valid_strings_.end(); i++) {
      if (i->value_ == "*") {
        matched_setting = value;
      }
      else if (string_equal_insensitive(i->value_, value)) {
        matched_setting = i->value_;
      }
    }
    return matched_setting;
  }

  Index
  RegisteredOption::MapStringSettingToEnum(const std::string& value) const
  {
    DBG_ASSERT(type_ == OT_String);

    Index matched_setting = -1;

    Index cnt = 0;
    std::vector<string_entry>::const_iterator i;
    for (i = valid_strings_.begin(); i != valid_strings_.end(); i++) {
      ASSERT_EXCEPTION(i->value_ != "*", IpoptException,
                       "Cannot map a wildcard setting to an enumeration");
      if (string_equal_insensitive(i->value_, value)) {
        matched_setting = cnt;
        break;
      }
      cnt++;
    }

    ASSERT_EXCEPTION(matched_setting != -1, ERROR_CONVERTING_STRING_TO_ENUM,
                     std::string("Could not find a match for setting ") + value +
                     " in option: " + name_);
    return matched_setting;
  }

  bool
  RegisteredOption::string_equal_insensitive(const std::string& s1,
      const std::string& s2) const
  {
    using namespace std;

    if (s1.size()!=s2.size())
      return false;

    string::const_iterator i1 = s1.begin();
    string::const_iterator i2 = s2.begin();

    while (i1!=s1.end()) {
      if (toupper(*i1)!=toupper(*i2))
        return false;
      i1++;
      i2++;
    }
    return true;
  }

  void
  RegisteredOptions::AddNumberOption(const std::string& name,
                                     const std::string& short_description,
                                     Number default_value,
                                     const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_Number);
    option->SetDefaultNumber(default_value);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(),
                     OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddLowerBoundedNumberOption(const std::string& name,
      const std::string& short_description,
      Number lower, bool strict,
      Number default_value,
      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_Number);
    option->SetDefaultNumber(default_value);
    option->SetLowerNumber(lower, strict);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddUpperBoundedNumberOption(const std::string& name,
      const std::string& short_description,
      Number upper, bool strict,
      Number default_value,
      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_Number);
    option->SetDefaultNumber(default_value);
    option->SetUpperNumber(upper, strict);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddBoundedNumberOption(const std::string& name,
      const std::string& short_description,
      Number lower, bool lower_strict,
      Number upper, bool upper_strict,
      Number default_value,
      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_Number);
    option->SetDefaultNumber(default_value);
    option->SetLowerNumber(lower, lower_strict);
    option->SetUpperNumber(upper, upper_strict);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddIntegerOption(const std::string& name,
                                      const std::string& short_description,
                                      Index default_value,
                                      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_Integer);
    option->SetDefaultInteger(default_value);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddLowerBoundedIntegerOption(const std::string& name,
      const std::string& short_description,
      Index lower, Index default_value,
      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_Integer);
    option->SetDefaultInteger(default_value);
    option->SetLowerInteger(lower);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddUpperBoundedIntegerOption(const std::string& name,
      const std::string& short_description,
      Index upper, Index default_value,
      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_Integer);
    option->SetDefaultInteger(default_value);
    option->SetUpperInteger(upper);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddBoundedIntegerOption(const std::string& name,
      const std::string& short_description,
      Index lower, Index upper,
      Index default_value,
      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_Integer);
    option->SetDefaultInteger(default_value);
    option->SetLowerInteger(lower);
    option->SetUpperInteger(upper);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddStringOption(const std::string& name,
                                     const std::string& short_description,
                                     const std::string& default_value,
                                     const std::vector<std::string>& settings,
                                     const std::vector<std::string>& descriptions,
                                     const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_String);
    option->SetDefaultString(default_value);
    DBG_ASSERT(settings.size() == descriptions.size());
    for (int i=0; i<(int)settings.size(); i++) {
      option->AddValidStringSetting(settings[i], descriptions[i]);
    }
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddStringOption1(const std::string& name,
                                      const std::string& short_description,
                                      const std::string& default_value,
                                      const std::string& setting1,
                                      const std::string& description1,
                                      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_String);
    option->SetDefaultString(default_value);
    option->AddValidStringSetting(setting1, description1);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddStringOption2(const std::string& name,
                                      const std::string& short_description,
                                      const std::string& default_value,
                                      const std::string& setting1,
                                      const std::string& description1,
                                      const std::string& setting2,
                                      const std::string& description2,
                                      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_String);
    option->SetDefaultString(default_value);
    option->AddValidStringSetting(setting1, description1);
    option->AddValidStringSetting(setting2, description2);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddStringOption3(const std::string& name,
                                      const std::string& short_description,
                                      const std::string& default_value,
                                      const std::string& setting1,
                                      const std::string& description1,
                                      const std::string& setting2,
                                      const std::string& description2,
                                      const std::string& setting3,
                                      const std::string& description3,
                                      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_String);
    option->SetDefaultString(default_value);
    option->AddValidStringSetting(setting1, description1);
    option->AddValidStringSetting(setting2, description2);
    option->AddValidStringSetting(setting3, description3);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddStringOption4(const std::string& name,
                                      const std::string& short_description,
                                      const std::string& default_value,
                                      const std::string& setting1,
                                      const std::string& description1,
                                      const std::string& setting2,
                                      const std::string& description2,
                                      const std::string& setting3,
                                      const std::string& description3,
                                      const std::string& setting4,
                                      const std::string& description4,
                                      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_String);
    option->SetDefaultString(default_value);
    option->AddValidStringSetting(setting1, description1);
    option->AddValidStringSetting(setting2, description2);
    option->AddValidStringSetting(setting3, description3);
    option->AddValidStringSetting(setting4, description4);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddStringOption5(const std::string& name,
                                      const std::string& short_description,
                                      const std::string& default_value,
                                      const std::string& setting1,
                                      const std::string& description1,
                                      const std::string& setting2,
                                      const std::string& description2,
                                      const std::string& setting3,
                                      const std::string& description3,
                                      const std::string& setting4,
                                      const std::string& description4,
                                      const std::string& setting5,
                                      const std::string& description5,
                                      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_String);
    option->SetDefaultString(default_value);
    option->AddValidStringSetting(setting1, description1);
    option->AddValidStringSetting(setting2, description2);
    option->AddValidStringSetting(setting3, description3);
    option->AddValidStringSetting(setting4, description4);
    option->AddValidStringSetting(setting5, description5);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddStringOption6(const std::string& name,
                                      const std::string& short_description,
                                      const std::string& default_value,
                                      const std::string& setting1,
                                      const std::string& description1,
                                      const std::string& setting2,
                                      const std::string& description2,
                                      const std::string& setting3,
                                      const std::string& description3,
                                      const std::string& setting4,
                                      const std::string& description4,
                                      const std::string& setting5,
                                      const std::string& description5,
                                      const std::string& setting6,
                                      const std::string& description6,
                                      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_String);
    option->SetDefaultString(default_value);
    option->AddValidStringSetting(setting1, description1);
    option->AddValidStringSetting(setting2, description2);
    option->AddValidStringSetting(setting3, description3);
    option->AddValidStringSetting(setting4, description4);
    option->AddValidStringSetting(setting5, description5);
    option->AddValidStringSetting(setting6, description6);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddStringOption7(const std::string& name,
                                      const std::string& short_description,
                                      const std::string& default_value,
                                      const std::string& setting1,
                                      const std::string& description1,
                                      const std::string& setting2,
                                      const std::string& description2,
                                      const std::string& setting3,
                                      const std::string& description3,
                                      const std::string& setting4,
                                      const std::string& description4,
                                      const std::string& setting5,
                                      const std::string& description5,
                                      const std::string& setting6,
                                      const std::string& description6,
                                      const std::string& setting7,
                                      const std::string& description7,
                                      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_String);
    option->SetDefaultString(default_value);
    option->AddValidStringSetting(setting1, description1);
    option->AddValidStringSetting(setting2, description2);
    option->AddValidStringSetting(setting3, description3);
    option->AddValidStringSetting(setting4, description4);
    option->AddValidStringSetting(setting5, description5);
    option->AddValidStringSetting(setting6, description6);
    option->AddValidStringSetting(setting7, description7);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddStringOption8(const std::string& name,
                                      const std::string& short_description,
                                      const std::string& default_value,
                                      const std::string& setting1,
                                      const std::string& description1,
                                      const std::string& setting2,
                                      const std::string& description2,
                                      const std::string& setting3,
                                      const std::string& description3,
                                      const std::string& setting4,
                                      const std::string& description4,
                                      const std::string& setting5,
                                      const std::string& description5,
                                      const std::string& setting6,
                                      const std::string& description6,
                                      const std::string& setting7,
                                      const std::string& description7,
                                      const std::string& setting8,
                                      const std::string& description8,
                                      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_String);
    option->SetDefaultString(default_value);
    option->AddValidStringSetting(setting1, description1);
    option->AddValidStringSetting(setting2, description2);
    option->AddValidStringSetting(setting3, description3);
    option->AddValidStringSetting(setting4, description4);
    option->AddValidStringSetting(setting5, description5);
    option->AddValidStringSetting(setting6, description6);
    option->AddValidStringSetting(setting7, description7);
    option->AddValidStringSetting(setting8, description8);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddStringOption9(const std::string& name,
                                      const std::string& short_description,
                                      const std::string& default_value,
                                      const std::string& setting1,
                                      const std::string& description1,
                                      const std::string& setting2,
                                      const std::string& description2,
                                      const std::string& setting3,
                                      const std::string& description3,
                                      const std::string& setting4,
                                      const std::string& description4,
                                      const std::string& setting5,
                                      const std::string& description5,
                                      const std::string& setting6,
                                      const std::string& description6,
                                      const std::string& setting7,
                                      const std::string& description7,
                                      const std::string& setting8,
                                      const std::string& description8,
                                      const std::string& setting9,
                                      const std::string& description9,
                                      const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_String);
    option->SetDefaultString(default_value);
    option->AddValidStringSetting(setting1, description1);
    option->AddValidStringSetting(setting2, description2);
    option->AddValidStringSetting(setting3, description3);
    option->AddValidStringSetting(setting4, description4);
    option->AddValidStringSetting(setting5, description5);
    option->AddValidStringSetting(setting6, description6);
    option->AddValidStringSetting(setting7, description7);
    option->AddValidStringSetting(setting8, description8);
    option->AddValidStringSetting(setting9, description9);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  void
  RegisteredOptions::AddStringOption10(const std::string& name,
                                       const std::string& short_description,
                                       const std::string& default_value,
                                       const std::string& setting1,
                                       const std::string& description1,
                                       const std::string& setting2,
                                       const std::string& description2,
                                       const std::string& setting3,
                                       const std::string& description3,
                                       const std::string& setting4,
                                       const std::string& description4,
                                       const std::string& setting5,
                                       const std::string& description5,
                                       const std::string& setting6,
                                       const std::string& description6,
                                       const std::string& setting7,
                                       const std::string& description7,
                                       const std::string& setting8,
                                       const std::string& description8,
                                       const std::string& setting9,
                                       const std::string& description9,
                                       const std::string& setting10,
                                       const std::string& description10,
                                       const std::string& long_description)
  {
    SmartPtr<RegisteredOption> option =
      new RegisteredOption(name, short_description, long_description,
                           current_registering_category_);
    option->SetType(OT_String);
    option->SetDefaultString(default_value);
    option->AddValidStringSetting(setting1, description1);
    option->AddValidStringSetting(setting2, description2);
    option->AddValidStringSetting(setting3, description3);
    option->AddValidStringSetting(setting4, description4);
    option->AddValidStringSetting(setting5, description5);
    option->AddValidStringSetting(setting6, description6);
    option->AddValidStringSetting(setting7, description7);
    option->AddValidStringSetting(setting8, description8);
    option->AddValidStringSetting(setting9, description9);
    option->AddValidStringSetting(setting10, description10);
    ASSERT_EXCEPTION(registered_options_.find(name) == registered_options_.end(), OPTION_ALREADY_REGISTERED,
                     std::string("The option: ") + option->Name() + " has already been registered by someone else");
    registered_options_[name] = option;
  }

  SmartPtr<const RegisteredOption> RegisteredOptions::GetOption(const std::string& name)
  {
    std::string tag_only = name;
    std::string::size_type pos = name.rfind(".", name.length());
    if (pos != std::string::npos) {
      tag_only = name.substr(pos+1, name.length()-pos);
    }
    SmartPtr<const RegisteredOption> option;
    std::map< std::string, SmartPtr<RegisteredOption> >::iterator reg_option = registered_options_.find(tag_only);
    if (reg_option == registered_options_.end()) {
      option = NULL;
    }
    else {
      option = ConstPtr(reg_option->second);
    }

    return option;
  }

  void RegisteredOptions::OutputOptionDocumentation(const Journalist& jnlst, std::list<std::string>& categories)
  {
    // create a set to print sorted output
    //     std::set
    //       <std::string> classes;
    //     std::map <std::string, SmartPtr<RegisteredOption> >::iterator option;
    //     for (option = registered_options_.begin(); option != registered_options_.end(); option++) {
    //       classes.insert(option->second->RegisteringCategory());
    //     }


    std::list
    <std::string>::iterator i;
    for (i = categories.begin(); i != categories.end(); i++) {
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION,
                   "\n### %s ###\n\n", (*i).c_str());
      std::map<Index, SmartPtr<RegisteredOption> > class_options;
      std::map <std::string, SmartPtr<RegisteredOption> >::iterator option;
      for (option = registered_options_.begin();
           option != registered_options_.end(); option++) {
        if (option->second->RegisteringCategory() == (*i)) {

          class_options[option->second->Counter()] = option->second;
        }
      }
      std::map<Index, SmartPtr<RegisteredOption> >::const_iterator co;
      for (co = class_options.begin(); co != class_options.end(); co++) {
        co->second->OutputShortDescription(jnlst);
      }
      jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\n");
    }
  }

  void RegisteredOptions::OutputLatexOptionDocumentation(
    const Journalist& jnlst,
    std::list<std::string>& options_to_print)
  {

    if (!options_to_print.empty()) {
      std::list<std::string>::iterator coption;
      for (coption = options_to_print.begin();
           coption != options_to_print.end();
           coption++) {
        // std::map <std::string, SmartPtr<RegisteredOption> >::iterator option;
        if (coption->c_str()[0] == '#') {
          jnlst.Printf(J_SUMMARY, J_DOCUMENTATION, "\\subsection{%s}\n\n",
                       &coption->c_str()[1]);
        }
        else {
          SmartPtr<RegisteredOption> option = registered_options_[*coption];
          DBG_ASSERT(IsValid(option));
          option->OutputLatexDescription(jnlst);
        }
      }
    }
    else {
      std::map <std::string, SmartPtr<RegisteredOption> >::iterator option;
      for (option = registered_options_.begin();
           option != registered_options_.end();
           option++) {
        option->second->OutputLatexDescription(jnlst);
      }
    }
  }
} // namespace Ipopt
