Polaris: RangeDict.h Source File

RangeDict.h Go to the documentation of this file. #ifndef _RANGE_DICT_H #define _RANGE_DICT_H /// /// file RangeDict.h /// /// \class RangeDict /// \brief Collection of ranges for entire program /// \defgroup Polaris /// \ingroup Polaris /// Range /// \see RangeDict.h /// \see RangeDict.h /// \see RangeDict.cc /// /// \endcode /// \section Overview Overview /// A RangeDict object is the main repository for variable /// ranges for a program units. Range dictionaries are /// responsible for holding the variable ranges for each statement /// in the given program unit. They are also responsible for /// generating these ranges. /// /// \endcode /// \section Description Description /// A RangeDict object is a repository of the variable constraints /// for all points of a program unit. However, it does not offer any /// public interface for accessing these constraints. Instead, /// such accesses are done through RangeAccessor objects. /// RangeAccessor objects also provide methods to perform /// comparisons using the constraints in a RangeDict object. /// See RangeAccessor.h for more details. /// /// RangeDict objects are an abstract class. Subclasses must /// implement the data structures that hold these constraints, and /// provide a Constructor that determines these constraints from a /// program unit. /// /// Essentially, a RangeDict object is expected to be a mapping /// between (variable/statement) pairs and symbolic lower bound, upper /// bound pairs called ranges (see RangeExpr). If a variable V has the /// range [L:U], then the constraint L <= V <= U holds for variable V. /// A variable can have at most one range. If a variable does not have /// a range, it is assumed that there are no constraints for that /// variable. Mapping a variable V to an expression E is equivalent to /// assigning it the range [E:E]. Mapping a variable V to an omega /// expression is equivalent to assigning it to the unconstrained range /// [-Infty:Infty], which is equivalent to deleting the variable from /// the RangeDict. /// #include "../Listable.h" #include "../Symtab.h" #include "../Collection/RefSet.h" /// class Statement; class Symbol; class Expression; class StmtList; class StmtRanges; class RangeDict : public Listable { friend class RangeAccessor; friend class AbstractAccess; public: RangeDict(Symtab &symtab); RangeDict(const RangeDict &other); virtual ~RangeDict(); virtual RangeDict &operator = (const RangeDict &other); ///< Completely copy the contents of the other range dictionary ///< into myself. const Symtab &symtab() const; ///< Return the symbol table associated with myself virtual StmtRanges & _s_ranges(String & tag); ///< Return a reference to the StmtRanges object associated with ///< the given statement tag. virtual void pretty_print(ostream & out, const Statement &stmt) const = 0; virtual void pretty_print(ostream & out, const StmtList &stmts) const; ///< Print out the range dictionary in a more user-readable ///< manner. protected: virtual void _set_range(const Symbol &var, const Statement &stmt, Expression *range) = 0; ///< Set the given variable to the given range. virtual void _del_range(const Symbol &var, const Statement &stmt) = 0; ///< Delete the range associated with the given variable. virtual const Expression *_get_range_ref(const Symbol &var, const Statement &stmt) = 0; ///< Return the range associated with the given variable. If the ///< variable doesn't have an associated range, return 0; private: Symtab *_symtab_ref; ///< Symbol table of program unit. void _add_intrinsic(const char *intrin_name); }; #endif

© 1995-2005 University of Illinois, Urbana-Champaign. All rights reserved.  Fri Mar 25 23:06:04 2005