split.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_SPLIT_HPP
#define CASADI_SPLIT_HPP
 
#include "multiple_output.hpp"
#include <map>
#include <stack>
 
 
namespace casadi {
 
  class CASADI_EXPORT Split : public MultipleOutput {
  public:
    Split(const MX& x, const std::vector<casadi_int>& offset);
 
    ~Split() override = 0;
 
    casadi_int nout() const override { return output_sparsity_.size(); }
 
    const Sparsity& sparsity(casadi_int oind) const override { return output_sparsity_.at(oind);}
 
    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;
 
    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);
    }
 
    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 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;
 
    // Sparsity pattern of the outputs
    std::vector<casadi_int> offset_;
    std::vector<Sparsity> output_sparsity_;
 
    void serialize_body(SerializingStream& s) const override;
 
  protected:
    explicit Split(DeserializingStream& s);
  };
 
  class CASADI_EXPORT Horzsplit : public Split {
  public:
 
    Horzsplit(const MX& x, const std::vector<casadi_int>& offset);
 
    ~Horzsplit() 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;
 
    std::string disp(const std::vector<std::string>& arg) const override;
 
    casadi_int op() const override { return OP_HORZSPLIT;}
 
    MX get_horzcat(const std::vector<MX>& x) const override;
 
    static MXNode* deserialize(DeserializingStream& s) { return new Horzsplit(s); }
 
  protected:
    explicit Horzsplit(DeserializingStream& s) : Split(s) {}
  };
 
  class CASADI_EXPORT Diagsplit : public Split {
  public:
 
    Diagsplit(const MX& x,
      const std::vector<casadi_int>& offset1, const std::vector<casadi_int>& offset2);
 
    ~Diagsplit() 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;
 
    std::string disp(const std::vector<std::string>& arg) const override;
 
    casadi_int op() const override { return OP_DIAGSPLIT;}
 
    MX get_diagcat(const std::vector<MX>& x) const override;
 
    static MXNode* deserialize(DeserializingStream& s) { return new Diagsplit(s); }
 
  protected:
    explicit Diagsplit(DeserializingStream& s) : Split(s) {}
  };
 
  class CASADI_EXPORT Vertsplit : public Split {
  public:
 
    Vertsplit(const MX& x, const std::vector<casadi_int>& offset);
 
    ~Vertsplit() 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;
 
    std::string disp(const std::vector<std::string>& arg) const override;
 
    casadi_int op() const override { return OP_VERTSPLIT;}
 
    MX get_vertcat(const std::vector<MX>& x) const override;
 
    static MXNode* deserialize(DeserializingStream& s) { return new Vertsplit(s); }
 
  protected:
    explicit Vertsplit(DeserializingStream& s) : Split(s) {}
  };
 
} // namespace casadi
 
 
#endif // CASADI_SPLIT_HPP