casadi::NlImporter Class Reference

#include <nlp_builder.hpp>

Detailed Description

\Helper class for .nl import The .nl format is described in "Writing .nl Files" paper by David M. Gay (2005)

Date

2016

Author

Joel Andersson

Definition at line 96 of file nlp_builder.hpp.

Public Member Functions
	NlImporter (NlpBuilder &nlp, const std::string &filename, const Dict &opts)
	~NlImporter ()

Constructor & Destructor Documentation

NlImporter()

casadi::NlImporter::NlImporter	(	NlpBuilder &	nlp,
		const std::string &	filename,
		const Dict &	opts
	)

Definition at line 47 of file nlp_builder.cpp.

  : nlp_(nlp) {
    // Set default options
    verbose_=false;
 
    // Read user options
    for (auto&& op : opts) {
      if (op.first == "verbose") {
        verbose_ = op.second;
      } else {
        std::stringstream ss;
        ss << "Unknown option \"" << op.first << "\"" << std::endl;
        throw CasadiException(ss.str());
      }
    }
    // Open file for reading
    s_.open(filename.c_str());
    if (verbose_) casadi_message("Reading file \"" + filename + "\"");
 
    // Read the header of the NL-file (first 10 lines)
    const casadi_int header_sz = 10;
    std::vector<std::string> header(header_sz);
    for (casadi_int k=0; k<header_sz; ++k) {
      getline(s_, header[k]);
    }
 
    // Assert that the file is not in binary form
    if (header.at(0).at(0)=='g') {
      binary_ = false;
    } else if (header.at(0).at(0)=='b') {
      binary_ = true;
    } else {
      casadi_error("File could not be read");
    }
 
    // Get the number of objectives and constraints
    std::stringstream ss(header[1]);
    ss >> n_var_ >> n_con_ >> n_obj_ >> n_eq_ >> n_lcon_;
    if (verbose_) {
      casadi_message("n_var=" + str(n_var_) + ", n_con =" + str(n_con_) + ", "
                     "n_obj=" + str(n_obj_) + ", n_eq=" + str(n_eq_) + ", "
                     "n_lcon=" + str(n_lcon_));
    }
 
    // Get the number of nonlinear vars in constraints, objectives, both
    std::stringstream ss4(header[4]);
    ss4 >> nlvc_ >> nlvo_ >> nlvb_;
    if (verbose_) {
      casadi_message("nlvc=" + str(nlvc_) + ", nlvo=" + str(nlvo_) + ", nlvb=" + str(nlvb_));
    }
 
    // Get the number of discrete variables
    std::stringstream ss6(header[6]);
    ss6 >> nbv_ >> niv_ >> nlvbi_ >> nlvci_ >> nlvoi_;
    if (verbose_) {
      casadi_message("nbv=" + str(nbv_) + ", niv =" + str(niv_) + ", "
                     "nlvbi=" + str(nlvbi_) + ", nlvci=" + str(nlvci_) + ", "
                     "nlvoi=" + str(nlvoi_));
    }
 
    // Allocate variables
    nlp_.x = MX::sym("x", 1, 1, n_var_);
 
    // Allocate f and c
    nlp_.f = 0;
    nlp_.g.resize(n_con_, 0);
 
    // Allocate bounds for x and primal initial guess
    nlp_.x_lb.resize(n_var_, -inf);
    nlp_.x_ub.resize(n_var_,  inf);
    nlp_.x_init.resize(n_var_, 0);
 
    // Allocate bounds for g and dual initial guess
    nlp_.g_lb.resize(n_con_, -inf);
    nlp_.g_ub.resize(n_con_,  inf);
    nlp_.lambda_init.resize(n_con_, 0);
 
    // Allocate binary variables vector
    nlp_.discrete.clear();
 
    //D. M. Gay and M. Hill, 'Hooking Your Solver to AMPL' October, 1997.
    // continuous in an objective and in a constraint
    for (casadi_int j=0; j<nlvb_-nlvbi_; ++j) nlp_.discrete.push_back(false);
 
    // integer in an objective and in a constraint
    for (casadi_int j=0; j<nlvbi_; ++j) nlp_.discrete.push_back(true);
 
    // continuous just in constraints
    for (casadi_int j=0; j<nlvc_ - (nlvb_ + nlvci_); ++j) nlp_.discrete.push_back(false);
 
    // integer just in constraints
    for (casadi_int j=0; j<nlvci_; ++j) nlp_.discrete.push_back(true);
 
    // continuous just in objectives
    for (casadi_int j=0; j<nlvo_ - (nlvc_ + nlvoi_); ++j) nlp_.discrete.push_back(false);
 
    // integer just in objectives
    for (casadi_int j=0; j < nlvoi_; ++j) nlp_.discrete.push_back(true);
 
    // linear
    casadi_int max_nlvc_nlvo = (nlvc_ < nlvo_) ? nlvo_ : nlvc_;
    for (casadi_int j=0; j<n_var_-(max_nlvc_nlvo+niv_+nbv_); ++j) nlp_.discrete.push_back(false);
 
    // binary
    for (casadi_int j = 0; j<nbv_; ++j) nlp_.discrete.push_back(true);
 
    // other integer
    for (casadi_int j = 0; j<niv_; ++j) nlp_.discrete.push_back(true);
 
    casadi_assert(nlp_.discrete.size()==n_var_,
      "Number of variables in the header don't match");
 
    // All variables, including dependent
    v_ = nlp_.x;
 
    if (binary_) {
      std::streampos offset = s_.tellg();
      s_.close();
      s_.open(filename.c_str(), std::ifstream::binary);
      s_.seekg(offset);
    }
 
    // Read segments
    parse();
 
    // multiple the objective sign
    nlp_.f = sign_*nlp_.f;
  }

References casadi::NlpBuilder::discrete, casadi::NlpBuilder::f, casadi::filename(), casadi::NlpBuilder::g, casadi::NlpBuilder::g_lb, casadi::NlpBuilder::g_ub, casadi::inf, casadi::NlpBuilder::lambda_init, casadi::str(), casadi::GenericMatrix< MX >::sym(), casadi::NlpBuilder::x, casadi::NlpBuilder::x_init, casadi::NlpBuilder::x_lb, and casadi::NlpBuilder::x_ub.

~NlImporter()

casadi::NlImporter::~NlImporter

(

)

Definition at line 176 of file nlp_builder.cpp.

                          {
    // Close the NL file
    s_.close();
  }

---

The documentation for this class was generated from the following files:

• nlp_builder.hpp
• nlp_builder.cpp