oracle_function.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_ORACLE_FUNCTION_HPP
#define CASADI_ORACLE_FUNCTION_HPP
 
#include "function_internal.hpp"
 
namespace casadi {
 
  class OracleFunction;
 
  class CASADI_EXPORT OracleCallback {
    public:
      std::string name;
      OracleFunction* oracle_;
      OracleCallback(const std::string& name, OracleFunction* oracle);
      OracleCallback();
  };
 
  template<typename T1>
  int calc_function(const OracleCallback* cb, casadi_oracle_data<T1>* d);
 
  struct CASADI_EXPORT LocalOracleMemory : public FunctionMemory {
    // Work vectors
    const double** arg;
    double** res;
    casadi_int* iw;
    double* w;
  };
 
  struct CASADI_EXPORT OracleMemory : public FunctionMemory {
    // Work vector aliases for non-threaded convenience
    const double** arg;
    double** res;
    casadi_int* iw;
    double* w;
 
    casadi_oracle_data<double> d_oracle;
 
    std::vector<LocalOracleMemory*> thread_local_mem;
    ~OracleMemory();
  };
 
  class CASADI_EXPORT OracleFunction : public FunctionInternal {
  protected:
    Function oracle_;
 
    Dict common_options_;
    Dict specific_options_;
 
    bool show_eval_warnings_;
 
    // Maximum number of threads
    int max_num_threads_;
 
    // Information about one function
    struct RegFun {
      Function f;
      bool jit;
      Function f_original; // Relevant for jit
      bool monitored = false;
    };
 
    // All NLP functions
    std::map<std::string, RegFun> all_functions_;
 
    // Active monitors
    std::vector<std::string> monitor_;
 
    // Memory stride in case of multipel threads
    size_t stride_arg_, stride_res_, stride_iw_, stride_w_;
 
    // Expand after construction?
    // Only used in finalize -> no need to serialize
    bool post_expand_;
 
  public:
    OracleFunction(const std::string& name, const Function& oracle);
 
    ~OracleFunction() override = 0;
 
 
    static const Options options_;
    const Options& get_options() const override { return options_;}
 
    void init(const Dict& opts) override;
 
    void finalize() override;
 
    void join_results(OracleMemory* m) const;
 
    const Function& oracle() const override { return oracle_;}
 
    // Replace MX oracle with SX oracle?
    void expand();
 
    Function create_function(const Function& oracle, const std::string& fname,
      const std::vector<std::string>& s_in,
      const std::vector<std::string>& s_out,
      const Function::AuxOut& aux=Function::AuxOut(),
      const Dict& opts=Dict());
 
    Function create_function(const std::string& fname,
      const std::vector<std::string>& s_in,
      const std::vector<std::string>& s_out,
      const Function::AuxOut& aux=Function::AuxOut(),
      const Dict& opts=Dict());
 
    Function create_function(const std::string& fname,
      const std::vector<MX>& e_in,
      const std::vector<MX>& e_out,
      const std::vector<std::string>& s_in,
      const std::vector<std::string>& s_out,
      const Dict& opts=Dict());
 
    Function create_forward(const std::string& fname, casadi_int nfwd);
 
    void set_function(const Function& fcn, const std::string& fname, bool jit=false);
 
    void set_function(const Function& fcn) { set_function(fcn, fcn.name()); }
 
    // Calculate an oracle function
    int calc_function(OracleMemory* m, const std::string& fcn,
      const double* const* arg=nullptr, int thread_id=0) const;
 
    // Forward sparsity propagation through a function
    int calc_sp_forward(const std::string& fcn, const bvec_t** arg, bvec_t** res,
      casadi_int* iw, bvec_t* w) const;
 
    // Reverse sparsity propagation through a function
    int calc_sp_reverse(const std::string& fcn, bvec_t** arg, bvec_t** res,
      casadi_int* iw, bvec_t* w) const;
 
    std::vector<std::string> get_function() const override;
 
    // Get a dependency function
    const Function& get_function(const std::string &name) const override;
 
    // Is a function monitored?
    virtual bool monitored(const std::string &name) const;
 
    // Check if a particular dependency exists
    bool has_function(const std::string& fname) const override;
 
    std::string generate_dependencies(const std::string& fname, const Dict& opts) const override;
 
    void jit_dependencies(const std::string& fname) override;
 
    void* alloc_mem() const override { return new OracleMemory();}
 
    int local_init_mem(void* mem) const;
 
    int init_mem(void* mem) const override;
 
    void free_mem(void *mem) const override { delete static_cast<OracleMemory*>(mem);}
 
    void set_temp(void* mem, const double** arg, double** res,
                          casadi_int* iw, double* w) const override;
 
    Dict get_stats(void* mem) const override;
 
    virtual void codegen_body_enter(CodeGenerator& g) const;
 
    virtual void codegen_body_exit(CodeGenerator& g) const;
 
    void serialize_body(SerializingStream &s) const override;
 
  protected:
    explicit OracleFunction(DeserializingStream& s);
 
  };
 
  template<typename T1>
  int calc_function(const OracleCallback* cb, casadi_oracle_data<T1>* d) {
    OracleMemory* m = static_cast<OracleMemory*>(d->m);
    try {
      return cb->oracle_->calc_function(m, cb->name);
    }
    catch (const std::exception& e) {
      uerr() << e.what() << std::endl;
      return 1;
    }
  }
 
 
} // namespace casadi
 
 
#endif // CASADI_ORACLE_FUNCTION_HPP