BaseExpression.h

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <iosfwd>
#include <map>
#include <memory>
#include <set>
 
#include "storm/adapters/RationalNumberForward.h"
#include "storm/storage/expressions/Type.h"
#include "storm/utility/OsDetection.h"
 
namespace boost {
class any;
}
 
namespace storm {
namespace expressions {
// Forward-declare expression classes.
class ExpressionManager;
class Variable;
class Expression;
class Valuation;
class ExpressionVisitor;
enum struct OperatorType;
 
class IfThenElseExpression;
class BinaryBooleanFunctionExpression;
class BinaryNumericalFunctionExpression;
class BinaryRelationExpression;
class BooleanLiteralExpression;
class IntegerLiteralExpression;
class RationalLiteralExpression;
class UnaryBooleanFunctionExpression;
class UnaryNumericalFunctionExpression;
class VariableExpression;
class PredicateExpression;

class BaseExpression : public std::enable_shared_from_this<BaseExpression> {
   public:
    BaseExpression(ExpressionManager const& manager, Type const& type);
 
    // Create default versions of constructors and assignments.
    BaseExpression(BaseExpression const&) = default;
    BaseExpression& operator=(BaseExpression const&) = delete;
    BaseExpression(BaseExpression&&) = default;
    BaseExpression& operator=(BaseExpression&&) = delete;
 
    // Make the destructor virtual (to allow destruction via base class pointer) and default it.
    virtual ~BaseExpression() = default;

    Expression toExpression() const;

    virtual bool evaluateAsBool(Valuation const* valuation = nullptr) const;

    virtual int_fast64_t evaluateAsInt(Valuation const* valuation = nullptr) const;

    virtual double evaluateAsDouble(Valuation const* valuation = nullptr) const;

    virtual storm::RationalNumber evaluateAsRational() const;

    virtual uint_fast64_t getArity() const;

    virtual std::shared_ptr<BaseExpression const> getOperand(uint_fast64_t operandIndex) const;

    virtual std::string const& getIdentifier() const;

    virtual OperatorType getOperator() const;

    virtual bool containsVariables() const;

    virtual bool isLiteral() const;

    virtual bool isVariable() const;

    virtual bool isTrue() const;

    virtual bool isFalse() const;

    virtual bool isFunctionApplication() const;

    virtual void gatherVariables(std::set<storm::expressions::Variable>& variables) const = 0;

    virtual std::shared_ptr<BaseExpression const> simplify() const = 0;

    std::shared_ptr<BaseExpression const> reduceNesting() const;

    virtual boost::any accept(ExpressionVisitor& visitor, boost::any const& data) const = 0;

    bool hasNumericalType() const;

    bool hasIntegerType() const;

    bool hasBitVectorType() const;

    bool hasBooleanType() const;

    bool hasRationalType() const;

    std::shared_ptr<BaseExpression const> getSharedPointer() const;

    ExpressionManager const& getManager() const;

    Type const& getType() const;
 
    friend std::ostream& operator<<(std::ostream& stream, BaseExpression const& expression);
 
    virtual bool isIfThenElseExpression() const;
    IfThenElseExpression const& asIfThenElseExpression() const;
 
    virtual bool isBinaryBooleanFunctionExpression() const;
    BinaryBooleanFunctionExpression const& asBinaryBooleanFunctionExpression() const;
 
    virtual bool isBinaryNumericalFunctionExpression() const;
    BinaryNumericalFunctionExpression const& asBinaryNumericalFunctionExpression() const;
 
    virtual bool isBinaryRelationExpression() const;
    BinaryRelationExpression const& asBinaryRelationExpression() const;
 
    virtual bool isBooleanLiteralExpression() const;
    BooleanLiteralExpression const& asBooleanLiteralExpression() const;
 
    virtual bool isIntegerLiteralExpression() const;
    IntegerLiteralExpression const& asIntegerLiteralExpression() const;
 
    virtual bool isRationalLiteralExpression() const;
    RationalLiteralExpression const& asRationalLiteralExpression() const;
 
    virtual bool isUnaryBooleanFunctionExpression() const;
    UnaryBooleanFunctionExpression const& asUnaryBooleanFunctionExpression() const;
 
    virtual bool isUnaryNumericalFunctionExpression() const;
    UnaryNumericalFunctionExpression const& asUnaryNumericalFunctionExpression() const;
 
    virtual bool isVariableExpression() const;
    VariableExpression const& asVariableExpression() const;
 
    virtual bool isPredicateExpression() const;
    PredicateExpression const& asPredicateExpression() const;
 
   protected:
    virtual void printToStream(std::ostream& stream) const = 0;
 
   private:
    // The manager responsible for this expression.
    ExpressionManager const& manager;
 
    // The return type of this expression.
    Type type;
};
}  // namespace expressions
}  // namespace storm