casadi/core/callback.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_CALLBACK_HPP
#define CASADI_CALLBACK_HPP
 
#include "function.hpp"
 
namespace casadi {
  class CallbackInternal;
 
  class CASADI_EXPORT Callback : public Function {
  public:
    static std::string type_name() {return "Callback";}
 
    Callback();
 
    Callback(const Callback& obj);
 
    virtual ~Callback();
 
    void construct(const std::string& name, const Dict& opts=Dict());
 
    virtual void init() {}
 
    virtual void finalize() {}
 
    virtual std::vector<DM> eval(const std::vector<DM>& arg) const;
 
    virtual int eval_buffer(const double **arg, const std::vector<casadi_int>& sizes_arg,
                              double **res, const std::vector<casadi_int>& sizes_res) const;
    virtual bool has_eval_buffer() const;
 
    virtual casadi_int get_n_in();
 
    virtual casadi_int get_n_out();
 
    virtual Sparsity get_sparsity_in(casadi_int i);
 
    virtual Sparsity get_sparsity_out(casadi_int i);
 
    virtual std::string get_name_in(casadi_int i);
 
    virtual std::string get_name_out(casadi_int i);
 
    virtual bool uses_output() const;
 
 
    virtual bool has_jacobian() const;
    virtual Function get_jacobian(const std::string& name,
                                  const std::vector<std::string>& inames,
                                  const std::vector<std::string>& onames,
                                  const Dict& opts) const;
 
 
    virtual bool has_forward(casadi_int nfwd) const;
    virtual 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;
 
 
    virtual bool has_reverse(casadi_int nadj) const;
    virtual 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;
 
 
    virtual bool has_jac_sparsity(casadi_int oind, casadi_int iind) const { return false; }
    virtual Sparsity get_jac_sparsity(casadi_int oind, casadi_int iind, bool symmetric) const {
      return Sparsity(); }
  };
 
} // namespace casadi
 
#endif // CASADI_CALLBACK_HPP