kron.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_KRON_HPP
#define CASADI_KRON_HPP
 
#include "mx_node.hpp"
 
 
namespace casadi {
 
  class CASADI_EXPORT Kron : public MXNode {
  public:
 
    static MX create(const MX& a, const MX& b);
 
    Kron(const MX& a, const MX& b);
 
    ~Kron() override {}
 
    virtual void eval_kernel(const double** arg, double** res) const;
    virtual void eval_kernel(const SXElem** arg, SXElem** res) const;
 
    template<typename T>
    int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const {
      eval_kernel(arg, res);
      return 0;
    }
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w) const override {
      return eval_gen<double>(arg, res, iw, w);
    }
 
    int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override {
      return eval_gen<SXElem>(arg, res, iw, w);
    }
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res,
        const std::vector<bool>& unique={}) 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;
 
    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;
 
    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;
 
    std::string disp(const std::vector<std::string>& arg) const override;
 
    casadi_int op() const override { return OP_KRON;}
 
    void serialize_type(SerializingStream& s) const override;
 
    static MXNode* deserialize(DeserializingStream& s);
 
  protected:
 
    explicit Kron(DeserializingStream& s) : MXNode(s) {}
  };
 
 
  class CASADI_EXPORT DenseKron : public Kron {
  public:
    static MXNode* try_create(const MX& a, const MX& b);
 
    DenseKron(const MX& a, const MX& b) : Kron(a, b) {}
    ~DenseKron() override {}
 
    void eval_kernel(const double** arg, double** res) const override;
    void eval_kernel(const SXElem** arg, SXElem** res) 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;
 
    void serialize_type(SerializingStream& s) const override;
    explicit DenseKron(DeserializingStream& s) : Kron(s) {}
  };
 
 
  class CASADI_EXPORT DenseSparseKron : public Kron {
  public:
    static MXNode* try_create(const MX& a, const MX& b);
 
    DenseSparseKron(const MX& a, const MX& b) : Kron(a, b) {}
    ~DenseSparseKron() override {}
 
    void eval_kernel(const double** arg, double** res) const override;
    void eval_kernel(const SXElem** arg, SXElem** res) 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;
 
    void serialize_type(SerializingStream& s) const override;
    explicit DenseSparseKron(DeserializingStream& s) : Kron(s) {}
  };
 
 
  class CASADI_EXPORT SparseDenseKron : public Kron {
  public:
    static MXNode* try_create(const MX& a, const MX& b);
 
    SparseDenseKron(const MX& a, const MX& b) : Kron(a, b) {}
    ~SparseDenseKron() override {}
 
    void eval_kernel(const double** arg, double** res) const override;
    void eval_kernel(const SXElem** arg, SXElem** res) 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;
 
    void serialize_type(SerializingStream& s) const override;
    explicit SparseDenseKron(DeserializingStream& s) : Kron(s) {}
  };
 
 
  class CASADI_EXPORT KronContract : public MXNode {
  public:
 
    static MX create(const MX& m, const MX& x, bool inner);
 
    KronContract(const MX& m, const MX& x, bool inner);
 
    ~KronContract() override {}
 
    virtual void eval_kernel(const double** arg, double** res, double* w) const;
    virtual void eval_kernel(const SXElem** arg, SXElem** res, SXElem* w) const;
 
    template<typename T>
    int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const {
      eval_kernel(arg, res, w);
      return 0;
    }
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w) const override {
      return eval_gen<double>(arg, res, iw, w);
    }
 
    int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override {
      return eval_gen<SXElem>(arg, res, iw, w);
    }
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res,
        const std::vector<bool>& unique={}) 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;
 
    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;
 
    size_t sz_w() 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;
 
    std::string disp(const std::vector<std::string>& arg) const override;
 
    casadi_int op() const override { return OP_KRON_CONTRACT;}
 
    void serialize_body(SerializingStream& s) const override;
 
    void serialize_type(SerializingStream& s) const override;
 
    static MXNode* deserialize(DeserializingStream& s);
 
    bool inner_;
 
  protected:
 
    explicit KronContract(DeserializingStream& s);
  };
 
 
  class CASADI_EXPORT DenseKronContract : public KronContract {
  public:
    static MXNode* try_create(const MX& m, const MX& x, bool inner);
 
    DenseKronContract(const MX& m, const MX& x, bool inner) : KronContract(m, x, inner) {}
    ~DenseKronContract() override {}
 
    void eval_kernel(const double** arg, double** res, double* w) const override;
    void eval_kernel(const SXElem** arg, SXElem** res, SXElem* w) const override;
 
    // sz_w stays at base size (dep(1).numel()) because sp_forward uses it
    // even though our specialized eval_kernel doesn't.
 
    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;
 
    void serialize_type(SerializingStream& s) const override;
    explicit DenseKronContract(DeserializingStream& s) : KronContract(s) {}
  };
 
 
  class CASADI_EXPORT DenseSparseKronContract : public KronContract {
  public:
    static MXNode* try_create(const MX& m, const MX& x, bool inner);
 
    DenseSparseKronContract(const MX& m, const MX& x, bool inner) : KronContract(m, x, inner) {}
    ~DenseSparseKronContract() override {}
 
    void eval_kernel(const double** arg, double** res, double* w) const override;
    void eval_kernel(const SXElem** arg, SXElem** res, SXElem* w) const override;
 
    // sz_w stays at base size for sp_forward's densify step.
 
    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;
 
    void serialize_type(SerializingStream& s) const override;
    explicit DenseSparseKronContract(DeserializingStream& s) : KronContract(s) {}
  };
 
 
  class CASADI_EXPORT SparseDenseKronContract : public KronContract {
  public:
    static MXNode* try_create(const MX& m, const MX& x, bool inner);
 
    SparseDenseKronContract(const MX& m, const MX& x, bool inner) : KronContract(m, x, inner) {}
    ~SparseDenseKronContract() override {}
 
    void eval_kernel(const double** arg, double** res, double* w) const override;
    void eval_kernel(const SXElem** arg, SXElem** res, SXElem* w) const override;
 
    // sz_w stays at base size for sp_forward's densify step.
 
    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;
 
    void serialize_type(SerializingStream& s) const override;
    explicit SparseDenseKronContract(DeserializingStream& s) : KronContract(s) {}
  };
 
} // namespace casadi
 
#endif // CASADI_KRON_HPP