From dffa5374ca560213452039fe569a70ca21b58a85 Mon Sep 17 00:00:00 2001
From: Tuowen Zhao <ztuowen@gmail.com>
Date: Sat, 17 Sep 2016 19:21:10 -0600
Subject: added file doc

---
 chill/include/dep.hh | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'chill/include/dep.hh')

diff --git a/chill/include/dep.hh b/chill/include/dep.hh
index f1cc864..6c535ce 100644
--- a/chill/include/dep.hh
+++ b/chill/include/dep.hh
@@ -1,6 +1,19 @@
 #ifndef DEP_HH
 #define DEP_HH
 
+/*!
+ * \file 
+ * \brief Data dependence vector and graph.
+ *
+ * All dependence vectors are normalized, i.e., the first non-zero distance
+ * must be positve. Thus the correct dependence meaning can be given based on
+ * source/destination pair's read/write type. Suppose for a dependence vector
+ * 1, 0~5, -3), we want to permute the first and the second dimension,
+ * the result would be two dependence vectors (0, 1, -3) and (1~5, 1, -3).
+ * All operations on dependence vectors are non-destructive, i.e., new
+ * dependence vectors are returned.
+ */
+
 #include <omega.h>
 #include "graph.hh"
 #include "ir_code.hh"
-- 
cgit v1.2.3-70-g09d2