snopt_interface.hpp

/*
 *    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
 *
 */
 
 
#ifndef CASADI_SNOPT_INTERFACE_HPP
#define CASADI_SNOPT_INTERFACE_HPP
 
#include "casadi/core/nlpsol_impl.hpp"
#include "casadi/core/im.hpp"
 
#include "casadi/interfaces/snopt/casadi_nlpsol_snopt_export.h"
extern "C" {
#include "snopt_cwrap.h" // NOLINT(build/include)
}
 
namespace casadi {
 
  // Forward declaration
  class SnoptInterface;
 
  struct  SnoptMemory : public NlpsolMemory {
    const SnoptInterface& self;
 
    // Current solution
    double *xk2, *lam_gk, *lam_xk;
 
    // Current calculated quantities
    double *gk, *jac_fk, *jac_gk;
 
    std::vector<double> bl, bu, xx;
 
    std::vector<int> hs, locJ, indJ;
 
    casadi_int n_iter; // number of major iterations
 
    std::vector<double> A_data, valJ, rc, pi;
 
    // Memory pool
    static std::vector<SnoptMemory*> mempool;
    int memind;
 
    int return_status;
 
    SnoptMemory(const SnoptInterface& self);
 
    ~SnoptMemory();
  };
 
  class  SnoptInterface : public Nlpsol {
  public:
    // NLP functions
    Sparsity jacf_sp_;
    Sparsity jacg_sp_;
 
    // Constructor
    explicit SnoptInterface(const std::string& name, const Function& nlp);
 
    // Destructor
    ~SnoptInterface() override;
 
    // Get name of the plugin
    const char* plugin_name() const override { return "snopt";}
 
    // Get name of the class
    std::string class_name() const override { return "SnoptInterface";}
 
    static Nlpsol* creator(const std::string& name, const Function& nlp) {
      return new SnoptInterface(name, nlp);
    }
 
 
    static const Options options_;
    const Options& get_options() const override { return options_;}
 
    // Initialize the solver
    void init(const Dict& opts) override;
 
    void* alloc_mem() const override { return new SnoptMemory(*this);}
 
    int init_mem(void* mem) const override;
 
    void free_mem(void *mem) const override { delete static_cast<SnoptMemory*>(mem);}
 
    void set_work(void* mem, const double**& arg, double**& res,
                          casadi_int*& iw, double*& w) const override;
 
    // Solve the NLP
    int solve(void* mem) const override;
 
    Dict get_stats(void* mem) const override;
 
    static std::map<int, std::string> status_;
    static std::map<int, std::string> secondary_status_;
 
    std::string formatStatus(int status) const;
    std::string formatSecondaryStatus(int status) const;
 
    void userfun(SnoptMemory* m, int* mode, int nnObj, int nnCon, int nnJac, int nnL, int neJac,
                 const double* x, double* fObj, double*gObj, double* fCon, double* gCon,
                 int nState, char* cu, int lencu, int* iu, int leniu, double* ru, int lenru) const;
 
    casadi_int nnJac_;
    casadi_int nnObj_;
    casadi_int nnCon_;
 
    IM A_structure_;
 
    casadi_int m_;
    casadi_int iObj_;
 
    static void userfunPtr(int * mode, int* nnObj, int * nnCon, int *nJac, int *nnL, int * neJac, // NOLINT
                           double *x, double *fObj, double *gObj, double * fCon, double* gCon, // NOLINT
                           int* nState, char* cu, int* lencu, int* iu, int* leniu, // NOLINT
                           double* ru, int *lenru); // NOLINT
 
    // Matrix A has a linear objective row
    bool jacF_row_;
    // Matrix A has a dummy row
    bool dummyrow_;
 
    static const std::string meta_doc;
 
    casadi_int Cold_;
 
    double inf_;
 
 
    void serialize_body(SerializingStream &s) const override;
 
    static ProtoFunction* deserialize(DeserializingStream& s) { return new SnoptInterface(s); }
 
  protected:
    explicit SnoptInterface(DeserializingStream& s);
 
  private:
      // options
      Dict opts_;
  };
 
} // namespace casadi
 
#endif // CASADI_SNOPT_INTERFACE_HPP