getnonzeros.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_GETNONZEROS_HPP
#define CASADI_GETNONZEROS_HPP
 
#include "mx_node.hpp"
#include <map>
#include <stack>
 
 
namespace casadi {
  class CASADI_EXPORT GetNonzeros : public MXNode {
  public:
 
    static MX create(const Sparsity& sp, const MX& x, const std::vector<casadi_int>& nz);
    static MX create(const Sparsity& sp, const MX& x, const Slice& s);
    static MX create(const Sparsity& sp, const MX& x, const Slice& inner, const Slice& outer);
 
    GetNonzeros(const Sparsity& sp, const MX& y);
 
    ~GetNonzeros() override {}
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& 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;
 
    Matrix<casadi_int> mapping() const override;
 
    virtual std::vector<casadi_int> all() const = 0;
 
    casadi_int op() const override { return OP_GETNONZEROS;}
 
    MX get_nzref(const Sparsity& sp, const std::vector<casadi_int>& nz) const override;
 
    static MXNode* deserialize(DeserializingStream& s);
 
  protected:
    explicit GetNonzeros(DeserializingStream& s) : MXNode(s) {}
  };
 
  class CASADI_EXPORT GetNonzerosVector : public GetNonzeros {
  public:
    GetNonzerosVector(const Sparsity& sp, const MX& x,
                      const std::vector<casadi_int>& nz) : GetNonzeros(sp, x), nz_(nz) {}
 
    ~GetNonzerosVector() override {}
 
    std::vector<casadi_int> all() const override { return nz_;}
 
    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* const* arg, T* const* 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 override;
 
    bool is_equal(const MXNode* node, casadi_int depth) const override;
 
    Dict info() const override { return {{"nz", nz_}}; }
 
    std::vector<casadi_int> nz_;
 
    void serialize_body(SerializingStream& s) const override;
    void serialize_type(SerializingStream& s) const override;
 
    explicit GetNonzerosVector(DeserializingStream& s);
  };
 
  // Specialization of the above when nz_ is a Slice
  class CASADI_EXPORT GetNonzerosSlice : public GetNonzeros {
  public:
 
    GetNonzerosSlice(const Sparsity& sp, const MX& x, const Slice& s) : GetNonzeros(sp, x), s_(s) {}
 
    ~GetNonzerosSlice() 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;
 
    template<typename T>
    int eval_gen(const T* const* arg, T* const* 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 override;
 
    bool is_equal(const MXNode* node, casadi_int depth) const override;
 
    Dict info() const override { return {{"slice", s_.info()}}; }
 
    // Data member
    Slice s_;
 
    void serialize_body(SerializingStream& s) const override;
    void serialize_type(SerializingStream& s) const override;
 
    explicit GetNonzerosSlice(DeserializingStream& s);
  };
 
  // Specialization of the above when nz_ is a nested Slice
  class CASADI_EXPORT GetNonzerosSlice2 : public GetNonzeros {
  public:
 
    GetNonzerosSlice2(const Sparsity& sp, const MX& x, const Slice& inner,
                      const Slice& outer) : GetNonzeros(sp, x), inner_(inner), outer_(outer) {}
 
    ~GetNonzerosSlice2() 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;
 
    template<typename T>
    int eval_gen(const T* const* arg, T* const* 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 override;
 
    bool is_equal(const MXNode* node, casadi_int depth) const override;
 
    Dict info() const override { return {{"inner", inner_.info()}, {"outer", outer_.info()}}; }
 
    // Data members
    Slice inner_, outer_;
 
    void serialize_body(SerializingStream& s) const override;
    void serialize_type(SerializingStream& s) const override;
 
    explicit GetNonzerosSlice2(DeserializingStream& s);
  };
 
 
} // namespace casadi
 
#endif // CASADI_GETNONZEROS_HPP