legate::SymbolicExpr#

class SymbolicExpr#

A class that symbolically represents coordinates.

A \(\mathtt{SymbolicExpr}(i, w, c)\) object denotes an expression \( w \cdot \mathit{dim}_i + c \), where \( \mathit{dim}_i \) corresponds to the coordinate of the \(i\)-th dimension. A special case is when \(i\) is \(-1\), which means the expression denotes a constant \(c\).

Public Functions

inline std::uint32_t dim() const#

Returns the dimension index of this expression.

Returns:

Dimension index

inline std::int32_t weight() const#

Returns the weight for the coordinates.

Returns:

Weight value

inline std::int32_t offset() const#

Returns the offset of the expression.

Returns:

Offset

inline bool is_identity(std::uint32_t dim) const#

Indicates if the expression denotes an identity mapping for the given dimension.

Parameters:

dim – The dimension for which the identity mapping is checked

Returns:

true The expression denotes an identity mapping

Returns:

false The expression does not denote an identity mapping

inline bool is_constant() const#

Indicates if the expression denotes a constant.

Returns:

true The expression denotes a constant

Returns:

false The expression does not denote a constant