symbol.h

Go to the documentation of this file.

 
#ifndef SYMENGINE_SYMBOL_H
#define SYMENGINE_SYMBOL_H
 
#include <symengine/basic.h>
 
namespace SymEngine
{
 
class SYMENGINE_EXPORT Symbol : public Basic
{
private:
    std::string name_;
 
public:
    IMPLEMENT_TYPEID(SYMENGINE_SYMBOL)
    explicit Symbol(const std::string &name);
    hash_t __hash__() const override;
    bool __eq__(const Basic &o) const override;
 
    int compare(const Basic &o) const override;
    inline const std::string &get_name() const
    {
        return name_;
    }
 
    vec_basic get_args() const override
    {
        return {};
    }
    RCP<const Symbol> as_dummy() const;
};
 
class SYMENGINE_EXPORT Dummy : public Symbol
{
private:
#ifdef WITH_SYMENGINE_THREAD_SAFE
    static std::atomic<size_t> count_;
#else
    static size_t count_;
#endif
    size_t dummy_index;
 
public:
    IMPLEMENT_TYPEID(SYMENGINE_DUMMY)
    explicit Dummy();
    explicit Dummy(const std::string &name);
    Dummy(const std::string &name, size_t index);
    hash_t __hash__() const override;
    bool __eq__(const Basic &o) const override;
    int compare(const Basic &o) const override;
    size_t get_index() const
    {
        return dummy_index;
    }
};
 
inline RCP<const Symbol> symbol(const std::string &name)
{
    return make_rcp<const Symbol>(name);
}
 
inline RCP<const Dummy> dummy()
{
    return make_rcp<const Dummy>();
}
 
inline RCP<const Dummy> dummy(const std::string &name)
{
    return make_rcp<const Dummy>(name);
}
 
inline RCP<const Dummy> dummy(const std::string &name, size_t dummy_index)
{
    return make_rcp<const Dummy>(name, dummy_index);
}
 
inline bool is_a_Symbol(const Basic &b)
{
    return b.get_type_code() == SYMENGINE_SYMBOL
           || b.get_type_code() == SYMENGINE_DUMMY;
}
 
} // namespace SymEngine
 
#endif