setnonzeros.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_SETNONZEROS_HPP
#define CASADI_SETNONZEROS_HPP
 
#include "mx_node.hpp"
#include <map>
#include <stack>
 
 
namespace casadi {
 
  template<bool Add>
  class CASADI_EXPORT SetNonzeros : public MXNode {
  public:
 
    static MX create(const MX& y, const MX& x, const std::vector<casadi_int>& nz);
    static MX create(const MX& y, const MX& x, const Slice& s);
    static MX create(const MX& y, const MX& x, const Slice& inner, const Slice& outer);
 
    SetNonzeros(const MX& y, const MX& x);
 
    ~SetNonzeros() override = 0;
 
    virtual std::vector<casadi_int> all() const = 0;
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
 
    void eval_linear(const std::vector<std::array<MX, 3> >& arg,
        std::vector<std::array<MX, 3> >& res) const override {
        eval_linear_rearrange(arg, res);
    }
 
    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;
 
    casadi_int op() const override { return Add ? OP_ADDNONZEROS : OP_SETNONZEROS;}
 
    Matrix<casadi_int> mapping() const override;
 
    casadi_int n_inplace() const override { return 1;}
 
    static MXNode* deserialize(DeserializingStream& s);
 
  protected:
    explicit SetNonzeros(DeserializingStream& s) : MXNode(s) {}
  };
 
 
  template<bool Add>
  class CASADI_EXPORT SetNonzerosVector : public SetNonzeros<Add>{
  public:
 
    SetNonzerosVector(const MX& y, const MX& x, const std::vector<casadi_int>& nz);
 
    ~SetNonzerosVector() override {}
 
    std::vector<casadi_int> all() const override { return nz_;}
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
 
    template<typename T>
    int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const;
 
    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;
 
    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;
 
    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;
 
    bool is_equal(const MXNode* node, casadi_int depth) const override;
 
    Dict info() const override { return {{"nz", nz_}, {"add", Add}}; }
 
    std::vector<casadi_int> nz_;
 
    void serialize_body(SerializingStream& s) const override;
    void serialize_type(SerializingStream& s) const override;
 
    explicit SetNonzerosVector(DeserializingStream& s);
  };
 
  // Specialization of the above when nz_ is a Slice
  template<bool Add>
  class CASADI_EXPORT SetNonzerosSlice : public SetNonzeros<Add>{
  public:
 
    SetNonzerosSlice(const MX& y, const MX& x, const Slice& s) : SetNonzeros<Add>(y, x), s_(s) {}
 
    ~SetNonzerosSlice() override {}
 
    std::vector<casadi_int> all() const override { return s_.all(s_.stop);}
 
    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 eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
 
    template<typename T>
    int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const;
 
    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;
 
    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;
 
    bool is_equal(const MXNode* node, casadi_int depth) const override;
 
    Dict info() const override { return {{"slice", s_.info()}, {"add", Add}}; }
 
    // Data member
    Slice s_;
 
    void serialize_body(SerializingStream& s) const override;
    void serialize_type(SerializingStream& s) const override;
 
    explicit SetNonzerosSlice(DeserializingStream& s);
  };
 
  // Specialization of the above when nz_ is a nested Slice
  template<bool Add>
  class CASADI_EXPORT SetNonzerosSlice2 : public SetNonzeros<Add>{
  public:
 
    SetNonzerosSlice2(const MX& y, const MX& x, const Slice& inner, const Slice& outer) :
        SetNonzeros<Add>(y, x), inner_(inner), outer_(outer) {}
 
    ~SetNonzerosSlice2() override {}
 
    std::vector<casadi_int> all() const override { return inner_.all(outer_, outer_.stop);}
 
    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 eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
 
    template<typename T>
    int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const;
 
    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;
 
    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;
 
    bool is_equal(const MXNode* node, casadi_int depth) const override;
 
    Dict info() const override { return {{"inner", inner_.info()}, {"outer", outer_.info()},
                                        {"add", Add}}; }
 
    // Data members
    Slice inner_, outer_;
 
    void serialize_body(SerializingStream& s) const override;
    void serialize_type(SerializingStream& s) const override;
 
    explicit SetNonzerosSlice2(DeserializingStream& s);
  };
 
} // namespace casadi
 
#endif // CASADI_SETNONZEROS_HPP