Skip to content

Commit 856c73f

Browse files
committed
Fix comments
1 parent fb25c1d commit 856c73f

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

include/taco/index_notation/index_notation.h

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,26 @@ class IndexStmtVisitorStrict;
7676
/// none: lhs and rhs are mutually exclusive. And lhs and rhs are not empty sets.
7777
/// lcr: rhs is a proper subset of lhs. (lhs contains rhs)
7878
/// rcl: lhs is a proper subset of rhs. (rhs contains lhs)
79-
/// inter: lhs and rhs share common elements but are not equal or empty.
79+
/// inter: lhs and rhs share common elements but are not equal or empty. Some examples:
80+
/// ```
81+
/// // equal
82+
/// ws(i1) += A(i1) // i1 is a child index node
83+
/// ws(i) = A(i) // i is a parent index node
84+
///
85+
/// // none
86+
/// ws(i1) += A(i) // i1 is a child of i
87+
/// B_new(i) = B(i1)
88+
///
89+
/// // lcr
90+
/// ws(i,k) = A(i) * B(i)
91+
///
92+
/// // rcl
93+
/// ws(i) += A(i,k) * B(i,k)
94+
///
95+
/// // inter
96+
/// ws(i,j) += A(i,k) * B(k,j)
97+
/// ```
98+
///
8099
enum IndexSetRel {
81100
equal, none, lcr, rcl, inter
82101
};

0 commit comments

Comments
 (0)