map.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_MAP_HPP
#define CASADI_MAP_HPP
 
#include "function_internal.hpp"
 
 
namespace casadi {
 
  class CASADI_EXPORT Map : public FunctionInternal {
  public:
    // Create function (use instead of constructor)
    static Function create(const std::string& parallelization,
                           const Function& f, casadi_int n);
 
    ~Map() override;
 
    std::string class_name() const override {return "Map";}
 
    bool is_a(const std::string& type, bool recursive) const override;
 
    // Get list of dependency functions
    virtual std::vector<std::string> get_function() const override;
 
    // Get a dependency function
    const Function& get_function(const std::string &name) const override;
 
    // Get all embedded functions, recursively
    void find(std::map<FunctionInternal*, std::pair<Function, size_t> >& all_fun,
        casadi_int max_depth) const override;
 
    // Check if a particular dependency exists
    bool has_function(const std::string& fname) const override;
 
 
    Sparsity get_sparsity_in(casadi_int i) override {
      return repmat(f_.sparsity_in(i), 1, n_);
    }
    Sparsity get_sparsity_out(casadi_int i) override {
      return repmat(f_.sparsity_out(i), 1, n_);
    }
 
    double get_default_in(casadi_int ind) const override { return f_.default_in(ind);}
 
 
    size_t get_n_in() override { return f_.n_in();}
    size_t get_n_out() override { return f_.n_out();}
 
 
    std::string get_name_in(casadi_int i) override { return f_.name_in(i);}
    std::string get_name_out(casadi_int i) override { return f_.name_out(i);}
 
    template<typename T>
    int eval_gen(const T** arg, T** res, casadi_int* iw, T* w, int mem=0) const;
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w, void* mem) const override;
 
    virtual std::string parallelization() const { return "serial"; }
 
    int eval_sx(const SXElem** arg, SXElem** res,
                casadi_int* iw, SXElem* w, void* mem,
                bool always_inline, bool never_inline) const override;
 
    int sp_forward(const bvec_t** arg, bvec_t** res,
                    casadi_int* iw, bvec_t* w, void* mem) const override;
 
    int sp_reverse(bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w, void* mem) const override;
 
    bool has_spfwd() const override { return true;}
    bool has_sprev() const override { return true;}
 
    bool has_codegen() const override { return true;}
 
    void codegen_declarations(CodeGenerator& g) const override;
 
    void codegen_body(CodeGenerator& g) const override;
 
    void init(const Dict& opts) override;
 
 
    bool has_forward(casadi_int nfwd) const override { return true;}
    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_reverse(casadi_int nadj) const override { return true;}
    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;
 
    Dict info() const override { return {{"f", f_}, {"n", n_}}; }
 
    void serialize_body(SerializingStream &s) const override;
    void serialize_type(SerializingStream &s) const override;
 
    std::string serialize_base_function() const override { return "Map"; }
 
    static ProtoFunction* deserialize(DeserializingStream& s);
 
  protected:
    explicit Map(DeserializingStream& s);
 
    // Constructor (protected, use create function)
    Map(const std::string& name, const Function& f, casadi_int n);
 
    // The function which is to be evaluated in parallel
    Function f_;
 
    // Number of times to evaluate this function
    casadi_int n_;
  };
 
  class CASADI_EXPORT OmpMap : public Map {
    friend class Map;
  public:
    // Constructor (protected, use create function in Map)
    OmpMap(const std::string& name, const Function& f, casadi_int n) : Map(name, f, n) {}
 
    ~OmpMap() override;
 
    std::string class_name() const override {return "OmpMap";}
 
    bool is_a(const std::string& type, bool recursive) const override;
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w, void* mem) const override;
 
    void init(const Dict& opts) override;
 
    std::string parallelization() const override { return "openmp"; }
 
    void codegen_body(CodeGenerator& g) const override;
 
  protected:
    explicit OmpMap(DeserializingStream& s) : Map(s) {}
  };
 
  class CASADI_EXPORT ThreadMap : public Map {
    friend class Map;
  public:
    // Constructor (protected, use create function in Map)
    ThreadMap(const std::string& name, const Function& f, casadi_int n) : Map(name, f, n) {}
 
    ~ThreadMap() override;
 
    std::string class_name() const override {return "ThreadMap";}
 
    bool is_a(const std::string& type, bool recursive) const override;
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w, void* mem) const override;
 
    void init(const Dict& opts) override;
 
    std::string parallelization() const override { return "thread"; }
 
    void codegen_declarations(CodeGenerator& g) const override;
 
    void codegen_body(CodeGenerator& g) const override;
 
  protected:
    explicit ThreadMap(DeserializingStream& s) : Map(s) {}
  };
 
} // namespace casadi
 
#endif // CASADI_MAP_HPP