external_impl.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_EXTERNAL_IMPL_HPP
#define CASADI_EXTERNAL_IMPL_HPP
 
#include "external.hpp"
#include "function_internal.hpp"
 
#ifdef WITH_DL
#ifdef _WIN32 // also for 64-bit
#ifndef NOMINMAX
#define NOMINMAX
#endif
#ifndef _WIN32_WINNT
#define _WIN32_WINNT 0x0502
#endif
#include <windows.h>
#else // _WIN32
#include <dlfcn.h>
#endif // _WIN32
#endif // WITH_DL
 
 
namespace casadi {
 
class CASADI_EXPORT External : public FunctionInternal {
 protected:
  config_t config_;
 
  getint_t get_n_in_, get_n_out_;
 
  name_t get_name_in_, get_name_out_;
 
  default_t get_default_in_;
 
  work_t work_;
 
 
  std::vector<casadi_int> int_data_;
  std::vector<double> real_data_;
  std::string string_data_;
 
  std::vector<std::string> config_args_;
  std::vector<const char*> args_;
 public:
 
  External(const std::string& name, const Importer& li,
    const std::vector<std::string> config_args=std::vector<std::string>());
 
  ~External() override = 0;
 
  virtual bool any_symbol_found() const;
 
  // Factory
  Function factory(const std::string& name,
                           const std::vector<std::string>& s_in,
                           const std::vector<std::string>& s_out,
                           const Function::AuxOut& aux,
                           const Dict& opts) const override;
 
  std::string class_name() const override { return "External";}
 
  virtual void init_external();
 
  void init(const Dict& opts) override;
 
  void codegen_declarations(CodeGenerator& g) const override;
 
  void codegen_body(CodeGenerator& g) const override;
 
  bool codegen_needs_mem() const override { return true; }
 
  bool codegen_mem_is_opaque() const override { return true; }
 
  void codegen_incref(CodeGenerator& g) const override;
 
  void codegen_decref(CodeGenerator& g) const override;
 
  void codegen_checkout(CodeGenerator& g) const override;
 
  void codegen_release(CodeGenerator& g) const override;
 
  void codegen_alloc_mem(CodeGenerator& g) const override;
 
  void codegen_init_mem(CodeGenerator& g) const override;
 
  void codegen_free_mem(CodeGenerator& g) const override;
 
 
  size_t get_n_in() override;
  size_t get_n_out() override;
 
  double get_default_in(casadi_int i) const override;
 
 
  std::string get_name_in(casadi_int i) override;
  std::string get_name_out(casadi_int i) override;
 
 
  Function get_forward(casadi_int nfwd, const std::string& name,
                               const std::vector<std::string>& inames,
                               const std::vector<std::string>& onames,
                               const Dict& opts) const override;
  bool has_forward(casadi_int nfwd) const override;
 
 
  Function get_reverse(casadi_int nadj, const std::string& name,
                               const std::vector<std::string>& inames,
                               const std::vector<std::string>& onames,
                               const Dict& opts) const override;
  bool has_reverse(casadi_int nadj) const override;
 
 
  bool has_jacobian() const override;
  Function get_jacobian(const std::string& name,
                                   const std::vector<std::string>& inames,
                                   const std::vector<std::string>& onames,
                                   const Dict& opts) const override;
 
  void serialize_body(SerializingStream &s) const override;
 
  static ProtoFunction* deserialize(DeserializingStream& s);
 
  std::string serialize_base_function() const override { return "External"; }
 
 protected:
  explicit External(DeserializingStream& s);
};
 
class CASADI_EXPORT GenericExternal : public External {
  // Sparsities
  sparsity_t get_sparsity_in_, get_sparsity_out_, get_jac_sparsity_;
  // Differentiability
  diff_t get_diff_in_, get_diff_out_;
 
 public:
  GenericExternal(const std::string& name, const Importer& li,
    const std::vector<std::string> config_args=std::vector<std::string>());
 
  ~GenericExternal() override { this->clear_mem();}
 
  bool any_symbol_found() const override;
 
  void init_external() override;
 
  void init(const Dict& opts) override;
 
 
  Sparsity get_sparsity_in(casadi_int i) override;
  Sparsity get_sparsity_out(casadi_int i) override;
 
 
  bool has_jac_sparsity(casadi_int oind, casadi_int iind) const override;
  Sparsity get_jac_sparsity(casadi_int oind, casadi_int iind, bool symmetric) const override;
 
 
  bool get_diff_in(casadi_int i) override;
  bool get_diff_out(casadi_int i) override;
 
  void serialize_type(SerializingStream &s) const override;
 
  explicit GenericExternal(DeserializingStream& s);
 
};
 
} // namespace casadi
 
#endif // CASADI_EXTERNAL_IMPL_HPP