getnonzeros_param.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_PARAM_HPP
#define CASADI_GETNONZEROS_PARAM_HPP
 
#include "mx_node.hpp"
#include <map>
#include <stack>
 
 
namespace casadi {
  class CASADI_EXPORT GetNonzerosParam : public MXNode {
  public:
 
    static MX create(const MX& x, const MX& nz);
    static MX create(const MX& x, const MX& inner, const Slice& outer);
    static MX create(const MX& x, const Slice& inner, const MX& outer);
    static MX create(const MX& x, const MX& inner, const MX& outer);
 
    GetNonzerosParam(const Sparsity& sp, const MX& y, const MX& nz);
    GetNonzerosParam(const Sparsity& sp, const MX& y, const MX& nz, const MX& nz_extra);
 
    ~GetNonzerosParam() 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;
 
    casadi_int op() const override { return OP_GETNONZEROS_PARAM;}
 
    static MXNode* deserialize(DeserializingStream& s);
 
  protected:
    explicit GetNonzerosParam(DeserializingStream& s) : MXNode(s) {}
  };
 
 
  class CASADI_EXPORT GetNonzerosParamVector : public GetNonzerosParam {
  public:
    GetNonzerosParamVector(const MX& x,
                      const MX& nz) : GetNonzerosParam(nz.sparsity(), x, nz) {}
 
    ~GetNonzerosParamVector() 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 eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res,
        const std::vector<bool>& unique={}) 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;
 
    void serialize_body(SerializingStream& s) const override;
    void serialize_type(SerializingStream& s) const override;
 
    explicit GetNonzerosParamVector(DeserializingStream& s);
  };
 
  // Specialization of the above when nz_ is a nested Slice
  class CASADI_EXPORT GetNonzerosSliceParam : public GetNonzerosParam {
  public:
 
    GetNonzerosSliceParam(const Sparsity& sp, const MX& x, const Slice& inner,
                      const MX& outer) :
                      GetNonzerosParam(sp, x, outer), inner_(inner) {}
 
    ~GetNonzerosSliceParam() override {}
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res,
        const std::vector<bool>& unique={}) 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;
 
    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;
 
    Dict info() const override { return {{"inner", inner_.info()}}; }
 
    // Data members
    Slice inner_;
 
    void serialize_body(SerializingStream& s) const override;
    void serialize_type(SerializingStream& s) const override;
 
    explicit GetNonzerosSliceParam(DeserializingStream& s);
  };
 
  // Specialization of the above when nz_ is a nested Slice
  class CASADI_EXPORT GetNonzerosParamSlice : public GetNonzerosParam {
  public:
 
    GetNonzerosParamSlice(const Sparsity& sp, const MX& x, const MX& inner,
                      const Slice& outer) :
                      GetNonzerosParam(sp, x, inner), outer_(outer) {}
 
    ~GetNonzerosParamSlice() override {}
 
    size_t sz_iw() const override;
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res,
        const std::vector<bool>& unique={}) 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;
 
    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;
 
    Dict info() const override { return {{"outer", outer_.info()}}; }
 
    // Data members
    Slice outer_;
 
    void serialize_body(SerializingStream& s) const override;
    void serialize_type(SerializingStream& s) const override;
 
    explicit GetNonzerosParamSlice(DeserializingStream& s);
  };
 
 
  // Specialization of the above when nz_ is a nested Slice
  class CASADI_EXPORT GetNonzerosParamParam : public GetNonzerosParam {
  public:
 
    GetNonzerosParamParam(const Sparsity& sp, const MX& x, const MX& inner,
                      const MX& outer) :
                      GetNonzerosParam(sp, x, inner, outer) {}
 
    ~GetNonzerosParamParam() override {}
 
    size_t sz_iw() const override;
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res,
        const std::vector<bool>& unique={}) 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;
 
    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;
 
    Dict info() const override { return {}; }
 
 
    void serialize_type(SerializingStream& s) const override;
 
    explicit GetNonzerosParamParam(DeserializingStream& s);
  };
 
} // namespace casadi
 
#endif // CASADI_GETNONZEROS_HPP