multiplication.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_MULTIPLICATION_HPP
#define CASADI_MULTIPLICATION_HPP
 
#include "mx_node.hpp"
 
 
namespace casadi {
  class CASADI_EXPORT Multiplication : public MXNode {
  public:
 
    static MX create(const MX& z, const MX& x, const MX& y,
                     const std::string& blas = "reference");
 
    Multiplication(const MX& z, const MX& x, const MX& y,
                   const std::string& blas = "reference");
 
    ~Multiplication() override {}
 
    std::string disp(const std::vector<std::string>& arg) 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;
 
    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 {
      if (arg[0]!=res[0]) std::copy(arg[0], arg[0]+dep(0).nnz(), res[0]);
      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;
 
    void eval_linear(const std::vector<std::array<MX, 3> >& arg,
                        std::vector<std::array<MX, 3> >& 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 eval_activity(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;
 
    casadi_int op() const override { return OP_MTIMES;}
 
    casadi_int n_inplace() const override { return 1;}
 
    bool is_equal(const MXNode* node, casadi_int depth) const override {
      return sameOpAndDeps(node, depth) && dynamic_cast<const Multiplication*>(node)!=nullptr;
    }
 
    size_t sz_w() const override { return sparsity().size1();}
 
    void serialize_type(SerializingStream& s) const override;
 
    void serialize_body(SerializingStream& s) const override;
 
    static MXNode* deserialize(DeserializingStream& s);
 
  protected:
    explicit Multiplication(DeserializingStream& s, bool legacy = false);
 
    casadi_int blas_shorthand_;
  };
 
 
  class CASADI_EXPORT DenseMultiplication : public Multiplication{
  public:
    static MXNode* try_create(const MX& z, const MX& x, const MX& y,
                              const std::string& blas = "reference");
 
    DenseMultiplication(const MX& z, const MX& x, const MX& y,
                        const std::string& blas = "reference")
        : Multiplication(z, x, y, blas) {}
    ~DenseMultiplication() 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;
 
    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 DenseMultiplication(DeserializingStream& s, bool legacy = false)
        : Multiplication(s, legacy) {}
  };
 
 
  class CASADI_EXPORT DenseSparseMultiplication : public Multiplication {
  public:
    static MXNode* try_create(const MX& z, const MX& x, const MX& y,
                              const std::string& blas = "reference");
 
    DenseSparseMultiplication(const MX& z, const MX& x, const MX& y,
                              const std::string& blas = "reference")
        : Multiplication(z, x, y, blas) {}
    ~DenseSparseMultiplication() 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;
 
    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 DenseSparseMultiplication(DeserializingStream& s) : Multiplication(s) {}
  };
 
 
  class CASADI_EXPORT PseudoDenseMultiplication : public Multiplication {
  public:
    static MXNode* try_create(const MX& z, const MX& x, const MX& y,
                              const std::string& blas = "reference");
 
    PseudoDenseMultiplication(const MX& z, const MX& x, const MX& y,
                              casadi_int nrow_x_compact, casadi_int ncol_x_compact,
                              casadi_int ncol_y_compact,
                              const std::string& blas = "reference");
    ~PseudoDenseMultiplication() 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;
 
    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;
    void serialize_body(SerializingStream& s) const override;
    explicit PseudoDenseMultiplication(DeserializingStream& s);
 
  private:
    // Compact (dense) dimensions seen by casadi_mtimes_dense
    casadi_int a_, b_, c_;  // x: a x b, y: b x c, z: a x c
  };
 
 
} // namespace casadi
 
#endif // CASADI_MULTIPLICATION_HPP