casadi_call.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_CALL_HPP
#define CASADI_CALL_HPP
 
#include "multiple_output.hpp"
#include "function.hpp"
 
 
namespace casadi {
 
  class CASADI_EXPORT Call : public MultipleOutput {
  public:
    static std::vector<MX> create(const Function& fcn, const std::vector<MX>& arg);
 
    static MX create_call(const Function& fcn, const std::vector<MX>& arg);
 
    MX get_output(casadi_int oind) const override;
 
    ~Call() override {}
 
    static MX projectArg(const MX& x, const Sparsity& sp, casadi_int i);
 
    std::string disp(const std::vector<std::string>& arg) const override;
 
    void add_dependency(CodeGenerator& g) const override;
 
    bool has_refcount() const override;
 
    void codegen_incref(CodeGenerator& g, std::set<void*>& added) const override;
 
    void codegen_decref(CodeGenerator& g, std::set<void*>& added) const override;
 
    void generate(CodeGenerator& g,
                          const std::vector<casadi_int>& arg,
                          const std::vector<casadi_int>& res,
                          const std::vector<bool>& arg_is_ref,
                          std::vector<bool>& res_is_ref) const override;
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
 
    int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override;
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
 
    void ad_forward(const std::vector<std::vector<MX> >& fseed,
                         std::vector<std::vector<MX> >& fsens) const override;
 
    void ad_reverse(const std::vector<std::vector<MX> >& aseed,
                         std::vector<std::vector<MX> >& asens) const override;
 
    int sp_forward(const bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
 
    int sp_reverse(bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
 
    const Function& which_function() const override { return fcn_;}
 
    casadi_int which_output() const override { return -1;}
 
    casadi_int nout() const override;
 
    const Sparsity& sparsity(casadi_int oind) const override;
 
    casadi_int op() const override { return OP_CALL;}
 
    size_t sz_arg() const override;
 
    size_t sz_res() const override;
 
    size_t sz_iw() const override;
 
    size_t sz_w() const override;
 
    void serialize_body(SerializingStream& s) const override;
 
    static MXNode* deserialize(DeserializingStream& s) { return new Call(s); }
 
  protected:
    explicit Call(const Function& fcn, const std::vector<MX>& arg);
 
    explicit Call(DeserializingStream& s);
 
    static MX common_cond(const std::vector<std::vector<MX>>& seed);
 
    // Function to be evaluated
    Function fcn_;
 
    mutable WeakCache<casadi_int, MX> cache_;
  };
 
} // namespace casadi
 
#endif // CASADI_CALL_HPP