symbolic_mx.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_SYMBOLIC_MX_HPP
#define CASADI_SYMBOLIC_MX_HPP
 
#include "mx_node.hpp"
 
 
namespace casadi {
  class CASADI_EXPORT SymbolicMX : public MXNode {
  public:
 
    explicit SymbolicMX(const std::string& name, casadi_int nrow=1, casadi_int ncol=1);
 
    explicit SymbolicMX(const std::string& name, const Sparsity & sp);
 
    ~SymbolicMX() override {}
 
    std::string disp(const std::vector<std::string>& arg) const override;
 
    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_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;
 
    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;
 
    const std::string& name() const override;
 
    casadi_int op() const override { return OP_PARAMETER;}
 
    bool is_valid_input() const override { return true;}
 
    bool has_duplicates() const override;
 
    void reset_input() const override;
 
    void serialize_body(SerializingStream& s) const override;
 
    static MXNode* deserialize(DeserializingStream& s) { return new SymbolicMX(s); }
 
  protected:
    explicit SymbolicMX(DeserializingStream& s);
 
    // Name of the variable
    std::string name_;
  };
 
} // namespace casadi
 
 
#endif // CASADI_SYMBOLIC_MX_HPP