sx_node.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_SX_NODE_HPP
#define CASADI_SX_NODE_HPP
 
#include <iostream>
#include <math.h>
#include <sstream>
#include <string>
 
#include "sx_elem.hpp"
 
 
namespace casadi {
 
  class SXNode {
    friend class SXElem;
    friend class Matrix<SXElem>;
    friend class UniversalNodeOwner;
  public:
 
    SXNode();
 
    virtual ~SXNode();
 
 
    virtual bool is_constant() const { return false; }
    virtual bool is_integer() const { return false; }
    virtual bool is_symbolic() const { return false; }
    virtual bool is_zero() const { return false; }
    virtual bool is_op(casadi_int op) const { return false; }
    virtual bool is_almost_zero(double tol) const { return false; }
    virtual bool is_one() const { return false; }
    virtual bool is_minus_one() const { return false; }
    virtual bool is_half() const { return false; }
    virtual bool is_value(double val) const { return false; }
    virtual bool is_nan() const { return false; }
    virtual bool is_inf() const { return false; }
    virtual bool is_minus_inf() const { return false; }
    virtual bool is_call() const { return false; }
    virtual bool is_output() const { return false; }
    virtual bool has_output() const { return false; }
 
 
    virtual double to_double() const;  // only works for constant nodes
    virtual casadi_int to_int() const;  // only works for integer nodes
 
    // get the name
    virtual const std::string& name() const;
 
    virtual std::string class_name() const = 0;
 
    virtual casadi_int op() const=0;
 
    virtual Function which_function() const;
 
    virtual casadi_int which_output() const;
 
    virtual bool is_equal(const SXNode* node, casadi_int depth) const;
 
    virtual casadi_int n_dep() const { return 0;}
 
    virtual SXElem get_output(casadi_int oind) const;
 
    virtual std::vector<SXElem> get_output(const std::vector<casadi_int>& oind) const;
 
    virtual const SXElem& dep(casadi_int i) const;
 
    virtual SXElem& dep(casadi_int i);
 
    virtual bool is_smooth() const { return true; }
 
    virtual void disp(std::ostream& stream, bool more) const;
 
    void can_inline(std::map<const SXNode*, casadi_int>& nodeind) const;
 
    std::string print_compact(std::map<const SXNode*, casadi_int>& nodeind,
                             std::vector<std::string>& intermed) const;
 
    virtual std::string print(const std::string& arg1, const std::string& arg2) const = 0;
 
    // Check if marked (i.e. temporary is negative)
    bool marked() const;
 
    // Mark by flipping the sign of the temporary and decreasing by one
    void mark() const;
 
    static void safe_delete(SXNode* n);
 
    // Depth when checking equalities
    static casadi_int eq_depth_;
 
    SXElem shared_from_this();
 
    const SXElem shared_from_this() const;
 
    mutable int temp;
 
    // Reference counter -- counts the number of parents of the node
#ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
    std::atomic<unsigned int> count;
#else
    unsigned int count;
#endif // CASADI_WITH_THREADSAFE_SYMBOLICS
 
    void serialize(SerializingStream& s) const;
 
    virtual void serialize_node(SerializingStream& s) const;
 
    static SXNode* deserialize(DeserializingStream& s);
 
    static std::map<casadi_int, SXNode* (*)(DeserializingStream&)> deserialize_map;
 
 
  };
 
} // namespace casadi
#endif // CASADI_SX_NODE_HPP