aboutsummaryrefslogtreecommitdiffstats
path: root/src/Verismith/Verilog/Distance.hs
diff options
context:
space:
mode:
Diffstat (limited to 'src/Verismith/Verilog/Distance.hs')
-rw-r--r--src/Verismith/Verilog/Distance.hs14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/Verismith/Verilog/Distance.hs b/src/Verismith/Verilog/Distance.hs
new file mode 100644
index 0000000..caa70c5
--- /dev/null
+++ b/src/Verismith/Verilog/Distance.hs
@@ -0,0 +1,14 @@
+{-|
+Module : Verismith.Verilog.Distance
+Description : Definition of the distance function for the abstract syntax tree.
+Copyright : (c) 2020, Yann Herklotz
+License : GPL-3
+Maintainer : yann [at] yannherklotz [dot] com
+Stability : experimental
+Poratbility : POSIX
+
+Define the distance function for the abstract syntax tree, so that different
+Verilog files can be compared. This allows us to define a metric on how
+different two pieces of Verilog are. Currently, differences in expressions are
+ignored, as these are not that interesting.
+-}