Improve / shorten the section on types.
[matthijs/master-project/dsd-paper.git] / cλash.lhs
1
2 %% bare_conf.tex
3 %% V1.3
4 %% 2007/01/11
5 %% by Michael Shell
6 %% See:
7 %% http://www.michaelshell.org/
8 %% for current contact information.
9 %%
10 %% This is a skeleton file demonstrating the use of IEEEtran.cls
11 %% (requires IEEEtran.cls version 1.7 or later) with an IEEE conference paper.
12 %%
13 %% Support sites:
14 %% http://www.michaelshell.org/tex/ieeetran/
15 %% http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/
16 %% and
17 %% http://www.ieee.org/
18
19 %%*************************************************************************
20 %% Legal Notice:
21 %% This code is offered as-is without any warranty either expressed or
22 %% implied; without even the implied warranty of MERCHANTABILITY or
23 %% FITNESS FOR A PARTICULAR PURPOSE! 
24 %% User assumes all risk.
25 %% In no event shall IEEE or any contributor to this code be liable for
26 %% any damages or losses, including, but not limited to, incidental,
27 %% consequential, or any other damages, resulting from the use or misuse
28 %% of any information contained here.
29 %%
30 %% All comments are the opinions of their respective authors and are not
31 %% necessarily endorsed by the IEEE.
32 %%
33 %% This work is distributed under the LaTeX Project Public License (LPPL)
34 %% ( http://www.latex-project.org/ ) version 1.3, and may be freely used,
35 %% distributed and modified. A copy of the LPPL, version 1.3, is included
36 %% in the base LaTeX documentation of all distributions of LaTeX released
37 %% 2003/12/01 or later.
38 %% Retain all contribution notices and credits.
39 %% ** Modified files should be clearly indicated as such, including  **
40 %% ** renaming them and changing author support contact information. **
41 %%
42 %% File list of work: IEEEtran.cls, IEEEtran_HOWTO.pdf, bare_adv.tex,
43 %%                    bare_conf.tex, bare_jrnl.tex, bare_jrnl_compsoc.tex
44 %%*************************************************************************
45
46 % *** Authors should verify (and, if needed, correct) their LaTeX system  ***
47 % *** with the testflow diagnostic prior to trusting their LaTeX platform ***
48 % *** with production work. IEEE's font choices can trigger bugs that do  ***
49 % *** not appear when using other class files.                            ***
50 % The testflow support page is at:
51 % http://www.michaelshell.org/tex/testflow/
52
53
54
55 % Note that the a4paper option is mainly intended so that authors in
56 % countries using A4 can easily print to A4 and see how their papers will
57 % look in print - the typesetting of the document will not typically be
58 % affected with changes in paper size (but the bottom and side margins will).
59 % Use the testflow package mentioned above to verify correct handling of
60 % both paper sizes by the user's LaTeX system.
61 %
62 % Also note that the "draftcls" or "draftclsnofoot", not "draft", option
63 % should be used if it is desired that the figures are to be displayed in
64 % draft mode.
65 %
66 \documentclass[conference,pdf,a4paper,10pt,final,twoside,twocolumn]{IEEEtran}
67 % Add the compsoc option for Computer Society conferences.
68 %
69 % If IEEEtran.cls has not been installed into the LaTeX system files,
70 % manually specify the path to it like:
71 % \documentclass[conference]{../sty/IEEEtran}
72
73 % Some very useful LaTeX packages include:
74 % (uncomment the ones you want to load)
75
76 % *** MISC UTILITY PACKAGES ***
77 %
78 %\usepackage{ifpdf}
79 % Heiko Oberdiek's ifpdf.sty is very useful if you need conditional
80 % compilation based on whether the output is pdf or dvi.
81 % usage:
82 % \ifpdf
83 %   % pdf code
84 % \else
85 %   % dvi code
86 % \fi
87 % The latest version of ifpdf.sty can be obtained from:
88 % http://www.ctan.org/tex-archive/macros/latex/contrib/oberdiek/
89 % Also, note that IEEEtran.cls V1.7 and later provides a builtin
90 % \ifCLASSINFOpdf conditional that works the same way.
91 % When switching from latex to pdflatex and vice-versa, the compiler may
92 % have to be run twice to clear warning/error messages.
93
94
95
96
97
98
99 % *** CITATION PACKAGES ***
100 %
101 \usepackage{cite}
102 % cite.sty was written by Donald Arseneau
103 % V1.6 and later of IEEEtran pre-defines the format of the cite.sty package
104 % \cite{} output to follow that of IEEE. Loading the cite package will
105 % result in citation numbers being automatically sorted and properly
106 % "compressed/ranged". e.g., [1], [9], [2], [7], [5], [6] without using
107 % cite.sty will become [1], [2], [5]--[7], [9] using cite.sty. cite.sty's
108 % \cite will automatically add leading space, if needed. Use cite.sty's
109 % noadjust option (cite.sty V3.8 and later) if you want to turn this off.
110 % cite.sty is already installed on most LaTeX systems. Be sure and use
111 % version 4.0 (2003-05-27) and later if using hyperref.sty. cite.sty does
112 % not currently provide for hyperlinked citations.
113 % The latest version can be obtained at:
114 % http://www.ctan.org/tex-archive/macros/latex/contrib/cite/
115 % The documentation is contained in the cite.sty file itself.
116
117
118
119
120
121
122 % *** GRAPHICS RELATED PACKAGES ***
123 %
124 \ifCLASSINFOpdf
125   % \usepackage[pdftex]{graphicx}
126   % declare the path(s) where your graphic files are
127   % \graphicspath{{../pdf/}{../jpeg/}}
128   % and their extensions so you won't have to specify these with
129   % every instance of \includegraphics
130   % \DeclareGraphicsExtensions{.pdf,.jpeg,.png}
131 \else
132   % or other class option (dvipsone, dvipdf, if not using dvips). graphicx
133   % will default to the driver specified in the system graphics.cfg if no
134   % driver is specified.
135   % \usepackage[dvips]{graphicx}
136   % declare the path(s) where your graphic files are
137   % \graphicspath{{../eps/}}
138   % and their extensions so you won't have to specify these with
139   % every instance of \includegraphics
140   % \DeclareGraphicsExtensions{.eps}
141 \fi
142 % graphicx was written by David Carlisle and Sebastian Rahtz. It is
143 % required if you want graphics, photos, etc. graphicx.sty is already
144 % installed on most LaTeX systems. The latest version and documentation can
145 % be obtained at: 
146 % http://www.ctan.org/tex-archive/macros/latex/required/graphics/
147 % Another good source of documentation is "Using Imported Graphics in
148 % LaTeX2e" by Keith Reckdahl which can be found as epslatex.ps or
149 % epslatex.pdf at: http://www.ctan.org/tex-archive/info/
150 %
151 % latex, and pdflatex in dvi mode, support graphics in encapsulated
152 % postscript (.eps) format. pdflatex in pdf mode supports graphics
153 % in .pdf, .jpeg, .png and .mps (metapost) formats. Users should ensure
154 % that all non-photo figures use a vector format (.eps, .pdf, .mps) and
155 % not a bitmapped formats (.jpeg, .png). IEEE frowns on bitmapped formats
156 % which can result in "jaggedy"/blurry rendering of lines and letters as
157 % well as large increases in file sizes.
158 %
159 % You can find documentation about the pdfTeX application at:
160 % http://www.tug.org/applications/pdftex
161
162
163
164
165
166 % *** MATH PACKAGES ***
167 %
168 %\usepackage[cmex10]{amsmath}
169 % A popular package from the American Mathematical Society that provides
170 % many useful and powerful commands for dealing with mathematics. If using
171 % it, be sure to load this package with the cmex10 option to ensure that
172 % only type 1 fonts will utilized at all point sizes. Without this option,
173 % it is possible that some math symbols, particularly those within
174 % footnotes, will be rendered in bitmap form which will result in a
175 % document that can not be IEEE Xplore compliant!
176 %
177 % Also, note that the amsmath package sets \interdisplaylinepenalty to 10000
178 % thus preventing page breaks from occurring within multiline equations. Use:
179 %\interdisplaylinepenalty=2500
180 % after loading amsmath to restore such page breaks as IEEEtran.cls normally
181 % does. amsmath.sty is already installed on most LaTeX systems. The latest
182 % version and documentation can be obtained at:
183 % http://www.ctan.org/tex-archive/macros/latex/required/amslatex/math/
184
185
186
187
188
189 % *** SPECIALIZED LIST PACKAGES ***
190 %
191 %\usepackage{algorithmic}
192 % algorithmic.sty was written by Peter Williams and Rogerio Brito.
193 % This package provides an algorithmic environment fo describing algorithms.
194 % You can use the algorithmic environment in-text or within a figure
195 % environment to provide for a floating algorithm. Do NOT use the algorithm
196 % floating environment provided by algorithm.sty (by the same authors) or
197 % algorithm2e.sty (by Christophe Fiorio) as IEEE does not use dedicated
198 % algorithm float types and packages that provide these will not provide
199 % correct IEEE style captions. The latest version and documentation of
200 % algorithmic.sty can be obtained at:
201 % http://www.ctan.org/tex-archive/macros/latex/contrib/algorithms/
202 % There is also a support site at:
203 % http://algorithms.berlios.de/index.html
204 % Also of interest may be the (relatively newer and more customizable)
205 % algorithmicx.sty package by Szasz Janos:
206 % http://www.ctan.org/tex-archive/macros/latex/contrib/algorithmicx/
207
208
209
210
211 % *** ALIGNMENT PACKAGES ***
212 %
213 %\usepackage{array}
214 % Frank Mittelbach's and David Carlisle's array.sty patches and improves
215 % the standard LaTeX2e array and tabular environments to provide better
216 % appearance and additional user controls. As the default LaTeX2e table
217 % generation code is lacking to the point of almost being broken with
218 % respect to the quality of the end results, all users are strongly
219 % advised to use an enhanced (at the very least that provided by array.sty)
220 % set of table tools. array.sty is already installed on most systems. The
221 % latest version and documentation can be obtained at:
222 % http://www.ctan.org/tex-archive/macros/latex/required/tools/
223
224
225 %\usepackage{mdwmath}
226 %\usepackage{mdwtab}
227 % Also highly recommended is Mark Wooding's extremely powerful MDW tools,
228 % especially mdwmath.sty and mdwtab.sty which are used to format equations
229 % and tables, respectively. The MDWtools set is already installed on most
230 % LaTeX systems. The lastest version and documentation is available at:
231 % http://www.ctan.org/tex-archive/macros/latex/contrib/mdwtools/
232
233
234 % IEEEtran contains the IEEEeqnarray family of commands that can be used to
235 % generate multiline equations as well as matrices, tables, etc., of high
236 % quality.
237
238
239 %\usepackage{eqparbox}
240 % Also of notable interest is Scott Pakin's eqparbox package for creating
241 % (automatically sized) equal width boxes - aka "natural width parboxes".
242 % Available at:
243 % http://www.ctan.org/tex-archive/macros/latex/contrib/eqparbox/
244
245
246
247
248
249 % *** SUBFIGURE PACKAGES ***
250 %\usepackage[tight,footnotesize]{subfigure}
251 % subfigure.sty was written by Steven Douglas Cochran. This package makes it
252 % easy to put subfigures in your figures. e.g., "Figure 1a and 1b". For IEEE
253 % work, it is a good idea to load it with the tight package option to reduce
254 % the amount of white space around the subfigures. subfigure.sty is already
255 % installed on most LaTeX systems. The latest version and documentation can
256 % be obtained at:
257 % http://www.ctan.org/tex-archive/obsolete/macros/latex/contrib/subfigure/
258 % subfigure.sty has been superceeded by subfig.sty.
259
260
261
262 %\usepackage[caption=false]{caption}
263 %\usepackage[font=footnotesize]{subfig}
264 % subfig.sty, also written by Steven Douglas Cochran, is the modern
265 % replacement for subfigure.sty. However, subfig.sty requires and
266 % automatically loads Axel Sommerfeldt's caption.sty which will override
267 % IEEEtran.cls handling of captions and this will result in nonIEEE style
268 % figure/table captions. To prevent this problem, be sure and preload
269 % caption.sty with its "caption=false" package option. This is will preserve
270 % IEEEtran.cls handing of captions. Version 1.3 (2005/06/28) and later 
271 % (recommended due to many improvements over 1.2) of subfig.sty supports
272 % the caption=false option directly:
273 %\usepackage[caption=false,font=footnotesize]{subfig}
274 %
275 % The latest version and documentation can be obtained at:
276 % http://www.ctan.org/tex-archive/macros/latex/contrib/subfig/
277 % The latest version and documentation of caption.sty can be obtained at:
278 % http://www.ctan.org/tex-archive/macros/latex/contrib/caption/
279
280
281
282
283 % *** FLOAT PACKAGES ***
284 %
285 %\usepackage{fixltx2e}
286 % fixltx2e, the successor to the earlier fix2col.sty, was written by
287 % Frank Mittelbach and David Carlisle. This package corrects a few problems
288 % in the LaTeX2e kernel, the most notable of which is that in current
289 % LaTeX2e releases, the ordering of single and double column floats is not
290 % guaranteed to be preserved. Thus, an unpatched LaTeX2e can allow a
291 % single column figure to be placed prior to an earlier double column
292 % figure. The latest version and documentation can be found at:
293 % http://www.ctan.org/tex-archive/macros/latex/base/
294
295
296
297 %\usepackage{stfloats}
298 % stfloats.sty was written by Sigitas Tolusis. This package gives LaTeX2e
299 % the ability to do double column floats at the bottom of the page as well
300 % as the top. (e.g., "\begin{figure*}[!b]" is not normally possible in
301 % LaTeX2e). It also provides a command:
302 %\fnbelowfloat
303 % to enable the placement of footnotes below bottom floats (the standard
304 % LaTeX2e kernel puts them above bottom floats). This is an invasive package
305 % which rewrites many portions of the LaTeX2e float routines. It may not work
306 % with other packages that modify the LaTeX2e float routines. The latest
307 % version and documentation can be obtained at:
308 % http://www.ctan.org/tex-archive/macros/latex/contrib/sttools/
309 % Documentation is contained in the stfloats.sty comments as well as in the
310 % presfull.pdf file. Do not use the stfloats baselinefloat ability as IEEE
311 % does not allow \baselineskip to stretch. Authors submitting work to the
312 % IEEE should note that IEEE rarely uses double column equations and
313 % that authors should try to avoid such use. Do not be tempted to use the
314 % cuted.sty or midfloat.sty packages (also by Sigitas Tolusis) as IEEE does
315 % not format its papers in such ways.
316
317
318
319
320
321 % *** PDF, URL AND HYPERLINK PACKAGES ***
322 %
323 %\usepackage{url}
324 % url.sty was written by Donald Arseneau. It provides better support for
325 % handling and breaking URLs. url.sty is already installed on most LaTeX
326 % systems. The latest version can be obtained at:
327 % http://www.ctan.org/tex-archive/macros/latex/contrib/misc/
328 % Read the url.sty source comments for usage information. Basically,
329 % \url{my_url_here}.
330
331
332
333
334
335 % *** Do not adjust lengths that control margins, column widths, etc. ***
336 % *** Do not use packages that alter fonts (such as pslatex).         ***
337 % There should be no need to do such things with IEEEtran.cls V1.6 and later.
338 % (Unless specifically asked to do so by the journal or conference you plan
339 % to submit to, of course. )
340
341 % correct bad hyphenation here
342 \hyphenation{op-tical net-works semi-conduc-tor}
343
344 % Macro for certain acronyms in small caps. Doesn't work with the
345 % default font, though (it contains no smallcaps it seems).
346 \def\VHDL{{\small{VHDL}}}
347 \def\GHC{{\small{GHC}}}
348 \def\CLaSH{\textsc{C$\lambda$aSH}}
349
350 % Macro for pretty printing haskell snippets. Just monospaced for now, perhaps
351 % we'll get something more complex later on.
352 \def\hs#1{\texttt{#1}}
353 \def\quote#1{``{#1}"}
354
355 \newenvironment{xlist}[1][\rule{0em}{0em}]{%
356   \begin{list}{}{%
357     \settowidth{\labelwidth}{#1:}
358     \setlength{\labelsep}{0.5cm}
359     \setlength{\leftmargin}{\labelwidth}
360     \addtolength{\leftmargin}{\labelsep}
361     \setlength{\rightmargin}{0pt}
362     \setlength{\parsep}{0.5ex plus 0.2ex minus 0.1ex}
363     \setlength{\itemsep}{0 ex plus 0.2ex}
364     \renewcommand{\makelabel}[1]{##1:\hfil}
365     }
366   }
367 {\end{list}}
368
369 %include polycode.fmt
370
371 \begin{document}
372 %
373 % paper title
374 % can use linebreaks \\ within to get better formatting as desired
375 \title{\CLaSH: Structural Descriptions \\ of Synchronous Hardware using Haskell}
376
377
378 % author names and affiliations
379 % use a multiple column layout for up to three different
380 % affiliations
381 \author{\IEEEauthorblockN{Christiaan P.R. Baaij, Matthijs Kooijman, Jan Kuper, Marco E.T. Gerards, Bert Molenkamp, Sabih H. Gerez}
382 \IEEEauthorblockA{University of Twente, Department of EEMCS\\
383 P.O. Box 217, 7500 AE, Enschede, The Netherlands\\
384 c.p.r.baaij@utwente.nl, matthijs@stdin.nl}}
385 % \and
386 % \IEEEauthorblockN{Homer Simpson}
387 % \IEEEauthorblockA{Twentieth Century Fox\\
388 % Springfield, USA\\
389 % Email: homer@thesimpsons.com}
390 % \and
391 % \IEEEauthorblockN{James Kirk\\ and Montgomery Scott}
392 % \IEEEauthorblockA{Starfleet Academy\\
393 % San Francisco, California 96678-2391\\
394 % Telephone: (800) 555--1212\\
395 % Fax: (888) 555--1212}}
396
397 % conference papers do not typically use \thanks and this command
398 % is locked out in conference mode. If really needed, such as for
399 % the acknowledgment of grants, issue a \IEEEoverridecommandlockouts
400 % after \documentclass
401
402 % for over three affiliations, or if they all won't fit within the width
403 % of the page, use this alternative format:
404
405 %\author{\IEEEauthorblockN{Michael Shell\IEEEauthorrefmark{1},
406 %Homer Simpson\IEEEauthorrefmark{2},
407 %James Kirk\IEEEauthorrefmark{3}, 
408 %Montgomery Scott\IEEEauthorrefmark{3} and
409 %Eldon Tyrell\IEEEauthorrefmark{4}}
410 %\IEEEauthorblockA{\IEEEauthorrefmark{1}School of Electrical and Computer Engineering\\
411 %Georgia Institute of Technology,
412 %Atlanta, Georgia 30332--0250\\ Email: see http://www.michaelshell.org/contact.html}
413 %\IEEEauthorblockA{\IEEEauthorrefmark{2}Twentieth Century Fox, Springfield, USA\\
414 %Email: homer@thesimpsons.com}
415 %\IEEEauthorblockA{\IEEEauthorrefmark{3}Starfleet Academy, San Francisco, California 96678-2391\\
416 %Telephone: (800) 555--1212, Fax: (888) 555--1212}
417 %\IEEEauthorblockA{\IEEEauthorrefmark{4}Tyrell Inc., 123 Replicant Street, Los Angeles, California 90210--4321}}
418
419
420
421
422 % use for special paper notices
423 %\IEEEspecialpapernotice{(Invited Paper)}
424
425
426
427
428 % make the title area
429 \maketitle
430
431
432 \begin{abstract}
433 %\boldmath
434 The abstract goes here.
435 \end{abstract}
436 % IEEEtran.cls defaults to using nonbold math in the Abstract.
437 % This preserves the distinction between vectors and scalars. However,
438 % if the conference you are submitting to favors bold math in the abstract,
439 % then you can use LaTeX's standard command \boldmath at the very start
440 % of the abstract to achieve this. Many IEEE journals/conferences frown on
441 % math in the abstract anyway.
442
443 % no keywords
444
445
446
447
448 % For peer review papers, you can put extra information on the cover
449 % page as needed:
450 % \ifCLASSOPTIONpeerreview
451 % \begin{center} \bfseries EDICS Category: 3-BBND \end{center}
452 % \fi
453 %
454 % For peerreview papers, this IEEEtran command inserts a page break and
455 % creates the second title. It will be ignored for other modes.
456 \IEEEpeerreviewmaketitle
457
458
459 \section{Introduction}
460 Hardware description languages has allowed the productivity of hardware 
461 engineers to keep pace with the development of chip technology. Standard 
462 Hardware description languages, like \VHDL\ and Verilog, allowed an engineer 
463 to describe circuits using a programming language. These standard languages 
464 are very good at describing detailed hardware properties such as timing 
465 behavior, but are generally cumbersome in expressing higher-level 
466 abstractions. These languages also tend to have a complex syntax and a lack of 
467 formal semantics. To overcome these complexities, and raise the abstraction 
468 level, a great number of approaches based on functional languages has been 
469 proposed \cite{T-Ruby,Hydra,HML2,Hawk1,Lava,ForSyDe1,Wired,reFLect}. The idea 
470 of using functional languages started in the early 1980s \cite{Cardelli1981,
471 muFP,DAISY,FHDL}, a time which also saw the birth of the currently popular 
472 hardware description languages such as \VHDL.
473
474 What gives functional languages as hardware description languages their merits 
475 is the fact that basic combinatorial circuits are equivalent to mathematical 
476 function, and that functional languages lend themselves very well to describe 
477 and compose these mathematical functions.
478 \section{Hardware description in Haskell}
479
480   \subsection{Function application}
481     The basic syntactic elements of a functional program are functions
482     and function application. These have a single obvious \VHDL\
483     translation: each top level function becomes a hardware component,
484     where each argument is an input port and the result value is the
485     (single) output port. This output port can have a complex type (such
486     as a tuple), so having just a single output port does not create a
487     limitation.
488
489     Each function application in turn becomes component instantiation.
490     Here, the result of each argument expression is assigned to a
491     signal, which is mapped to the corresponding input port. The output
492     port of the function is also mapped to a signal, which is used as
493     the result of the application itself.
494
495     Since every top level function generates its own component, the
496     hierarchy of of function calls is reflected in the final \VHDL\
497     output as well, creating a hierarchical \VHDL\ description of the
498     hardware.  This separation in different components makes the
499     resulting \VHDL\ output easier to read and debug.
500
501     Example that defines the \texttt{mac} function by applying the
502     \texttt{add} and \texttt{mul} functions to calculate $a * b + c$:
503
504 \begin{verbatim}
505 mac a b c = add (mul a b) c
506 \end{verbatim}
507
508     TODO: Pretty picture
509
510   \subsection{Choices }
511     Although describing components and connections allows describing a
512     lot of hardware designs already, there is an obvious thing missing:
513     choice. We need some way to be able to choose between values based
514     on another value.  In Haskell, choice is achieved by \hs{case}
515     expressions, \hs{if} expressions, pattern matching and guards.
516
517     The easiest of these are of course case expressions (and \hs{if}
518     expressions, which can be very directly translated to \hs{case}
519     expressions). A \hs{case} expression can in turn simply be
520     translated to a conditional assignment in \VHDL, where the
521     conditions use equality comparisons against the constructors in the
522     \hs{case} expressions.
523
524     A slightly more complex (but very powerful) form of choice is
525     pattern matching. A function can be defined in multiple clauses,
526     where each clause specifies a pattern. When the arguments match the
527     pattern, the corresponding clause will be used.
528
529     A pattern match (with optional guards) can also be implemented using
530     conditional assignments in \VHDL, where the condition is the logical
531     and of comparison results of each part of the pattern as well as the
532     guard.
533
534     Contrived example that sums two values when they are equal or
535     non-equal (depending on the predicate given) and returns 0
536     otherwise. This shows three implementations, one using and if
537     expression, one using only case expressions and one using pattern
538     matching and guards.
539
540 \begin{verbatim}
541 sumif pred a b = if pred == Eq && a == b || pred == Neq && a != b
542                  then a + b
543                  else 0
544 \end{verbatim}
545
546 \begin{verbatim}
547 sumif pred a b = case pred of
548   Eq -> case a == b of
549     True -> a + b
550     False -> 0
551   Neq -> case a != b of
552     True -> a + b
553     False -> 0
554 \end{verbatim}
555
556 \begin{verbatim}
557 sumif Eq a b | a == b = a + b
558 sumif Neq a b | a != b = a + b
559 sumif _ _ _ = 0
560 \end{verbatim}
561
562   TODO: Pretty picture
563
564   \subsection{Types}
565     Translation of two most basic functional concepts has been
566     discussed: function application and choice. Before looking further
567     into less obvious concepts like higher-order expressions and
568     polymorphism, the possible types that can be used in hardware
569     descriptions will be discussed.
570
571     Some way is needed to translate every value used to its hardware
572     equivalents. In particular, this means a hardware equivalent for
573     every \emph{type} used in a hardware description is needed.
574
575     The following types are \emph{built-in}, meaning that their hardware
576     translation is fixed into the \CLaSH compiler. A designer can also
577     define his own types, which will be translated into hardware types
578     using translation rules that are discussed later on.
579
580   \subsection{Built-in types}
581     \begin{xlist}
582       \item[\hs{Bit}]
583         This is the most basic type available. It can have two values:
584         \hs{Low} and \hs{High}. It is mapped directly onto the
585         \texttt{std\_logic} \VHDL\ type. 
586       \item[\hs{Bool}]
587         This is a basic logic type. It can have two values: \hs{True}
588         and \hs{False}. It is translated to \texttt{std\_logic} exactly
589         like the \hs{Bit} type (where a value of \hs{True} corresponds
590         to a value of \hs{High}). Supporting the Bool type is
591         particularly useful to support \hs{if ... then ... else ...}
592         expressions, which always have a \hs{Bool} value for the
593         condition.
594       \item[\hs{SizedWord}, \hs{SizedInt}]
595         These are types to represent integers. A \hs{SizedWord} is unsigned,
596         while a \hs{SizedInt} is signed. These types are parametrized by a
597         length type, so you can define an unsigned word of 32 bits wide as
598         follows:
599
600 \begin{verbatim}
601 type Word32 = SizedWord D32
602 \end{verbatim}
603
604         Here, a type synonym \hs{Word32} is defined that is equal to the
605         \hs{SizedWord} type constructor applied to the type \hs{D32}. \hs{D32}
606         is the \emph{type level representation} of the decimal number 32,
607         making the \hs{Word32} type a 32-bit unsigned word.
608
609         These types are translated to the \VHDL\ \texttt{unsigned} and
610         \texttt{signed} respectively.
611       \item[\hs{Vector}]
612         This is a vector type, that can contain elements of any other type and
613         has a fixed length.
614
615         The \hs{Vector} type constructor takes two type arguments: the length
616         of the vector and the type of the elements contained in it. The state
617         type of an 8 element register bank would then for example be:
618
619 \begin{verbatim}
620 type RegisterState = Vector D8 Word32
621 \end{verbatim}
622
623         Here, a type synonym \hs{RegisterState} is defined that is equal to
624         the \hs{Vector} type constructor applied to the types \hs{D8} (The type
625         level representation of the decimal number 8) and \hs{Word32} (The 32
626         bit word type as defined above). In other words, the
627         \hs{RegisterState} type is a vector of 8 32-bit words.
628
629         A fixed size vector is translated to a \VHDL\ array type.
630       \item[\hs{RangedWord}]
631         This is another type to describe integers, but unlike the previous
632         two it has no specific bit-width, but an upper bound. This means that
633         its range is not limited to powers of two, but can be any number.
634         A \hs{RangedWord} only has an upper bound, its lower bound is
635         implicitly zero.
636
637         The main purpose of the \hs{RangedWord} type is to be used as an
638         index to a \hs{Vector}.
639
640         TODO: Perhaps remove this example?
641
642         To define an index for the 8 element vector above, we would do:
643
644 \begin{verbatim}
645 type RegisterIndex = RangedWord D7
646 \end{verbatim}
647
648         Here, a type synonym \hs{RegisterIndex} is defined that is equal to
649         the \hs{RangedWord} type constructor applied to the type \hs{D7}. In
650         other words, this defines an unsigned word with values from
651         0 to 7 (inclusive). This word can be be used to index the
652         8 element vector \hs{RegisterState} above.
653
654         This type is translated to the \texttt{unsigned} \VHDL type.
655     \end{xlist}
656
657   \subsection{User-defined types}
658     There are three ways to define new types in Haskell: algebraic
659     data-types with the \hs{data} keyword, type synonyms with the \hs{type}
660     keyword and type renamings with the \hs{newtype} keyword. \GHC\
661     offers a few more advanced ways to introduce types (type families,
662     existential typing, {\small{GADT}}s, etc.) which are not standard
663     Haskell. These are not currently supported.
664
665     Only an algebraic datatype declaration actually introduces a
666     completely new type, for which we provide the \VHDL\ translation
667     below. Type synonyms and renamings only define new names for
668     existing types (where synonyms are completely interchangeable and
669     renamings need explicit conversion). Therefore, these do not need
670     any particular \VHDL\ translation, a synonym or renamed type will
671     just use the same representation as the original type. The
672     distinction between a renaming and a synonym does no longer matter
673     in hardware and can be disregarded in the generated \VHDL.
674
675     For algebraic types, we can make the following distinction: 
676
677     \begin{xlist}
678       \item[\bf{Single constructor}]
679         Algebraic datatypes with a single constructor with one or more
680         fields, are essentially a way to pack a few values together in a
681         record-like structure.
682
683         An example of such a type is the following pair of integers:
684
685 \begin{verbatim}
686 data IntPair = IntPair Int Int
687 \end{verbatim}
688
689         Haskell's builtin tuple types are also defined as single
690         constructor algebraic types and are translated according to this
691         rule by the \CLaSH compiler.
692
693         These types are translated to \VHDL\ record types, with one field for
694         every field in the constructor.
695       \item[\bf{No fields}]
696         Algebraic datatypes with multiple constructors, but without any
697         fields are essentially a way to get an enumeration-like type
698         containing alternatives.
699
700         Note that Haskell's \hs{Bool} type is also defined as an
701         enumeration type, but we have a fixed translation for that.
702
703         These types are translated to \VHDL\ enumerations, with one value for
704         each constructor. This allows references to these constructors to be
705         translated to the corresponding enumeration value.
706       \item[\bf{Multiple constructors with fields}]
707         Algebraic datatypes with multiple constructors, where at least
708         one of these constructors has one or more fields are not
709         currently supported.
710       \end{xlist}
711
712
713 \section{\CLaSH\ prototype}
714
715 foo\par bar
716
717 \section{Related work}
718 Many functional hardware description languages have been developed over the 
719 years. Early work includes such languages as \textsc{$\mu$fp}~\cite{muFP}, an 
720 extension of Backus' \textsc{fp} language to synchronous streams, designed 
721 particularly for describing and reasoning about regular circuits. The 
722 Ruby~\cite{Ruby} language uses relations, instead of functions, to describe 
723 circuits, and has a particular focus on layout. \textsc{hml}~\cite{HML2} is a 
724 hardware modeling language based on the strict functional language 
725 \textsc{ml}, and has support for polymorphic types and higher-order functions. 
726 Published work suggests that there is no direct simulation support for 
727 \textsc{hml}, and that the translation to \VHDL\ is only partial.
728
729 Like this work, many functional hardware description languages have some sort 
730 of foundation in the functional programming language Haskell. 
731 Hawk~\cite{Hawk1} uses Haskell to describe system-level executable 
732 specifications used to model the behavior of superscalar microprocessors. Hawk 
733 specifications can be simulated, but there seems to be no support for 
734 automated circuit synthesis. The ForSyDe~\cite{ForSyDe2} system uses Haskell 
735 to specify abstract system models, which can (manually) be transformed into an 
736 implementation model using semantic preserving transformations. ForSyDe has 
737 several simulation and synthesis backends, though synthesis is restricted to 
738 the synchronous subset of the ForSyDe language.
739
740 Lava~\cite{Lava} is a hardware description language that focuses on the 
741 structural representation of hardware. Besides support for simulation and 
742 circuit synthesis, Lava descriptions can be interfaced with formal method 
743 tools for formal verification. Lava descriptions are actually circuit 
744 generators when viewed from a synthesis viewpoint, in that the language 
745 elements of Haskell, such as choice, can be used to guide the circuit 
746 generation. If a developer wants to insert a choice element inside an actual 
747 circuit he will have to specify this explicitly as a component. In this 
748 respect \CLaSH\ differs from Lava, in that all the choice elements, such as 
749 case-statements and patter matching, are synthesized to choice elements in the 
750 eventual circuit. As such, richer control structures can both be specified and 
751 synthesized in \CLaSH\ compared to any of the languages mentioned in this 
752 section.
753
754 The merits of polymorphic typing, combined with higher-order functions, are 
755 now also recognized in the `main-stream' hardware description languages, 
756 exemplified by the new \VHDL\ 2008 standard~\cite{VHDL2008}. \VHDL-2008 has 
757 support to specify types as generics, thus allowing a developer to describe 
758 polymorphic components. Note that those types still require an explicit 
759 generic map, whereas type-inference and type-specialization are implicit in 
760 \CLaSH.
761
762 Wired~\cite{Wired},, T-Ruby~\cite{T-Ruby}, Hydra~\cite{Hydra}. 
763
764 A functional language designed specifically for hardware design is 
765 $re{\mathit{FL}}^{ect}$~\cite{reFLect}, which draws experience from earlier 
766 language called \textsc{fl}~\cite{FL} to la
767
768 % An example of a floating figure using the graphicx package.
769 % Note that \label must occur AFTER (or within) \caption.
770 % For figures, \caption should occur after the \includegraphics.
771 % Note that IEEEtran v1.7 and later has special internal code that
772 % is designed to preserve the operation of \label within \caption
773 % even when the captionsoff option is in effect. However, because
774 % of issues like this, it may be the safest practice to put all your
775 % \label just after \caption rather than within \caption{}.
776 %
777 % Reminder: the "draftcls" or "draftclsnofoot", not "draft", class
778 % option should be used if it is desired that the figures are to be
779 % displayed while in draft mode.
780 %
781 %\begin{figure}[!t]
782 %\centering
783 %\includegraphics[width=2.5in]{myfigure}
784 % where an .eps filename suffix will be assumed under latex, 
785 % and a .pdf suffix will be assumed for pdflatex; or what has been declared
786 % via \DeclareGraphicsExtensions.
787 %\caption{Simulation Results}
788 %\label{fig_sim}
789 %\end{figure}
790
791 % Note that IEEE typically puts floats only at the top, even when this
792 % results in a large percentage of a column being occupied by floats.
793
794
795 % An example of a double column floating figure using two subfigures.
796 % (The subfig.sty package must be loaded for this to work.)
797 % The subfigure \label commands are set within each subfloat command, the
798 % \label for the overall figure must come after \caption.
799 % \hfil must be used as a separator to get equal spacing.
800 % The subfigure.sty package works much the same way, except \subfigure is
801 % used instead of \subfloat.
802 %
803 %\begin{figure*}[!t]
804 %\centerline{\subfloat[Case I]\includegraphics[width=2.5in]{subfigcase1}%
805 %\label{fig_first_case}}
806 %\hfil
807 %\subfloat[Case II]{\includegraphics[width=2.5in]{subfigcase2}%
808 %\label{fig_second_case}}}
809 %\caption{Simulation results}
810 %\label{fig_sim}
811 %\end{figure*}
812 %
813 % Note that often IEEE papers with subfigures do not employ subfigure
814 % captions (using the optional argument to \subfloat), but instead will
815 % reference/describe all of them (a), (b), etc., within the main caption.
816
817
818 % An example of a floating table. Note that, for IEEE style tables, the 
819 % \caption command should come BEFORE the table. Table text will default to
820 % \footnotesize as IEEE normally uses this smaller font for tables.
821 % The \label must come after \caption as always.
822 %
823 %\begin{table}[!t]
824 %% increase table row spacing, adjust to taste
825 %\renewcommand{\arraystretch}{1.3}
826 % if using array.sty, it might be a good idea to tweak the value of
827 % \extrarowheight as needed to properly center the text within the cells
828 %\caption{An Example of a Table}
829 %\label{table_example}
830 %\centering
831 %% Some packages, such as MDW tools, offer better commands for making tables
832 %% than the plain LaTeX2e tabular which is used here.
833 %\begin{tabular}{|c||c|}
834 %\hline
835 %One & Two\\
836 %\hline
837 %Three & Four\\
838 %\hline
839 %\end{tabular}
840 %\end{table}
841
842
843 % Note that IEEE does not put floats in the very first column - or typically
844 % anywhere on the first page for that matter. Also, in-text middle ("here")
845 % positioning is not used. Most IEEE journals/conferences use top floats
846 % exclusively. Note that, LaTeX2e, unlike IEEE journals/conferences, places
847 % footnotes above bottom floats. This can be corrected via the \fnbelowfloat
848 % command of the stfloats package.
849
850
851
852 \section{Conclusion}
853 The conclusion goes here.
854
855
856
857
858 % conference papers do not normally have an appendix
859
860
861 % use section* for acknowledgement
862 \section*{Acknowledgment}
863
864
865 The authors would like to thank...
866
867
868
869
870
871 % trigger a \newpage just before the given reference
872 % number - used to balance the columns on the last page
873 % adjust value as needed - may need to be readjusted if
874 % the document is modified later
875 %\IEEEtriggeratref{8}
876 % The "triggered" command can be changed if desired:
877 %\IEEEtriggercmd{\enlargethispage{-5in}}
878
879 % references section
880
881 % can use a bibliography generated by BibTeX as a .bbl file
882 % BibTeX documentation can be easily obtained at:
883 % http://www.ctan.org/tex-archive/biblio/bibtex/contrib/doc/
884 % The IEEEtran BibTeX style support page is at:
885 % http://www.michaelshell.org/tex/ieeetran/bibtex/
886 \bibliographystyle{IEEEtran}
887 % argument is your BibTeX string definitions and bibliography database(s)
888 \bibliography{IEEEabrv,clash.bib}
889 %
890 % <OR> manually copy in the resultant .bbl file
891 % set second argument of \begin to the number of references
892 % (used to reserve space for the reference number labels box)
893 % \begin{thebibliography}{1}
894
895 % \bibitem{IEEEhowto:kopka}
896 % H.~Kopka and P.~W. Daly, \emph{A Guide to \LaTeX}, 3rd~ed.\hskip 1em plus
897 %   0.5em minus 0.4em\relax Harlow, England: Addison-Wesley, 1999.
898
899 % \end{thebibliography}
900
901
902
903
904 % that's all folks
905 \end{document}
906
907 % vim: set ai sw=2 sts=2 expandtab: