preamble.tex

% !TEX TS-program = lualatex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Compiling this file will compile the entire document
%% from individual chapter files using `subfiles' package


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% PREAMBLE
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\documentclass[12pt,a4paper,twoside,final,british]{book}

\PassOptionsToPackage{usenames,dvipsnames}{xcolor}

\usepackage[british]{babel}
\usepackage[T1]{fontenc}
\usepackage[utf8]{luainputenc}
\usepackage{listings}
\usepackage{verbatim}
\usepackage{varioref}
\usepackage{refstyle}
\usepackage{textcomp}
\usepackage{amstext}
\usepackage[top=3cm, bottom=2cm, left=2.5cm, right=2.5cm]{geometry} % digital
% \usepackage[top=3cm, bottom=2cm, left=3cm, right=2cm]{geometry}   % printing
\usepackage[export]{adjustbox}
\usepackage{subfiles}
\usepackage{setspace}
\usepackage{caption}
\usepackage{subcaption}
\usepackage{syntax}
\usepackage{xspace}
\usepackage[disable]{todonotes}
\usepackage{fixltx2e} % \textsubscript{} etc.
\usepackage{tcolorbox} % for rounded boxes around label names
\usepackage[tikz]{bclogo} % for highlighting important info in boxes
\usepackage{hyperref} % for clickable refs
\usepackage[toc,page]{appendix}
\usepackage{makeidx} % for index
\usepackage{tikz}
\usepackage{csvsimple}
\usepackage{pdfpages}
\usepackage[backend=bibtex]{biblatex}
\addbibresource{bib.bib}
%\bibliography{bib}


%% Packages included in this distribution
\usepackage{subsections}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% D o c u m e n t   f o r m a t t i n g
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\lstset{language=Haskell, columns=fixed, basewidth=.5em}

% 1.5 Line spacing between lines
\renewcommand{\baselinestretch}{1.5}

\makeatletter

% -1 part
%  0 chapter
%  1 section
%  2 subsection
%  3 subsubsection
%  4 subsubsubsection
\setcounter{secnumdepth}{4}
\setcounter{tocdepth}{4}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% Shorthand syntax, macros, environments, etc..
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


\def\compose{$\circ$ }

\def\dol{\mathtt{\char36}}

\newcommand\sub[1]{\large\itshape\rmfamily\textsubscript{#1}\normalfont\normalsize}
\newcommand\normsub[1]{\itshape\rmfamily\textsubscript{#1}\normalfont\normalsize}

\def\halfspacing{\setstretch{0.5}} % Not sure how this works, but it's smaller than 1.0

% The font chosen in OmniGraffle is a little too big. Rescale everything here.
\def\omniscale{0.8}


% The amazing \myrulefill by Werner producing centred text like so:
% ---------- text ----------
% Source: http://tex.stackexchange.com/a/77824/61985
% Usage:  \enrule[\color{olive}]{0.95\textwidth}{text}%
\newcommand*{\enrule}[3][]{%
  \makebox[#2]{#1%
    \leaders\hrule height \dimexpr.5ex+.2pt\relax depth \dimexpr -.5ex+.2pt\relax \hfill% Left rule
    \enskip{#3}\enskip% Text (and surrounding spaces)
    \leaders\hrule height \dimexpr.5ex+.2pt\relax depth \dimexpr -.5ex+.2pt\relax \hfill\kern0pt}% Right rule
}

\providecommand\CommentsColor{\color{MidnightBlue}}
\providecommand\CommentPlusPlus[2][0.95\textwidth]{\enrule[\CommentsColor]{#1}{#2}}
% Usage:
%   %\CommentPlus[25em]{Foo}%
% OR (for almost full textwidth):
%   %\CommentPlus{Bar}% 


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Automatically make code after underscore subscripted

% \def\SubscriptWord#1 {\check#1\relax\sub{#1} }

% % Check function parses world until space/newline
% \def\check#1{%
% \ifx\relax#1%
% \else
% \ifcat a#1%
% \else
% \typeout{illegal character #1}%
% \fi
% \expandafter\check
% \fi}

% To use:
% \catcode`\_=\active
% \def_{\SubscriptWord}
% hello_world

% How to define \AutoSubscriptOn and \AutoSubscriptOff ??
%\def\AutoSubscriptOn{\def_{\SubscriptWord}}
% Hello_World will result in world subscripted World
% \_ will result in the usual underscore
%\edef\AutoSubscriptOff{\noexpand\def_{\_}}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Two part variable names
\catcode`\_=\active
\def\|#1_#2|{\texttt{#1}\sub{#2}}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Minimal syntax for supporting Markdown style \*italic*, \|fixed-width|, \$mathit$

%\def\|#1|{\texttt{#1}}
\def\*#1*{\emph{#1}}
\def\$#1${$\mathit{#1}$}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Formatting block labels using \[bracket] syntax.

\definecolor{someblue}{rgb}{0.122, 0.435, 0.698}

% \newtcbox{\roundedbox}{
%   nobeforeafter,
%   colframe=someblue!50!white,
%   colback=someblue!10!white,
%   boxrule=0.5pt,
%   arc=4pt,
%   boxsep=0pt,
%   left=5pt,
%   right=5pt,
%   top=5pt,
%   bottom=5pt,
%   tcbox raise base}

\def\[#1]{\texttt{#1}}

% A prettier :=
\makeatletter
\newcommand*{\shifttext}[2]{%
  \settowidth{\@tempdima}{#2}%
  \makebox[\@tempdima]{\hspace*{#1}#2}%
}
\newcommand*{\coleq}{\mathrel{\rlap{%
                     \shifttext{0.6ex}{\raisebox{0.3ex}{$\m@th\cdot$}}}%
                     \shifttext{0.6ex}{\raisebox{-0.2ex}{$\m@th\cdot$}}}%
                     \shifttext{-0.6ex}{\text{\ttfamily{=}}}}
\makeatother

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Emphasising stuff

% Important info
\newcommand\thesis\emph


% Important info in a coloured box
\definecolor{bgblue}{RGB}{245,243,253}
\definecolor{ttblue}{RGB}{91,194,224}
\renewcommand\bcStyleTitre[1]{\large\bfseries\textcolor{black}{#1}} % used to be ttblue
\newenvironment{important}[1]
% before
{
    \begin{bclogo}[
        couleur=bgblue,
        arrondi=0,
        logo={\ }, %\bcbombe,
        barre=none,
        noborder=true]{#1}
}
% after
{
    \end{bclogo}
}

\newenvironment{bluebox}{%
    \ \\
    \noindent
    \adjustbox{
        innerenv={varwidth}[c]{\linewidth},
        margin=\fboxsep+.15cm \fboxsep+.2cm,
        bgcolor=someblue!20!white,
        center}
    \bgroup
}{%
    \egroup\\
}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Full-page backgrounds
\newcommand{\myback}[1]{%
  \begin{tikzpicture}[remember picture,overlay]
    \node[anchor=north west,inner sep=0pt,outer sep=0pt] at (current page.north west)
        {\includegraphics[width=\paperwidth,height=\paperheight]{#1}};
  \end{tikzpicture}
}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Names and abbreviations

\newcommand\term[1]{\textbf{#1}\xspace}
\newcommand\name[1]{\textsl{#1}\xspace}

\newcommand\LiveFusion{\name{LiveFusion}}
\newcommand\Loop{\name{Loop}}
\newcommand\C{\name{C}}
\newcommand\Haskell{\name{Haskell}}
\newcommand\GHC{\name{GHC}}
\newcommand\DPH{\name{DPH}}
\newcommand\LLVM{\name{LLVM}}
\newcommand\StreamFusion{\name{Stream Fusion}}
\newcommand\QuickHull{\name{QuickHull}}
\newcommand\FilterMax{\name{FilterMax}}
\newcommand\FlowFusion{\name{Flow Fusion}}
\newcommand\Repa{\name{Repa}}
\newcommand\Accelerate{\name{Accelerate}}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Figure with caption at the bottom
\newenvironment
  {cfigure}[1]
  {
    \def\TEMPCAPTION{#1}
    \begin{figure}
  }
  {
    \caption{\TEMPCAPTION}
    \end{figure}
  }


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% C o d e   L i s t i n g s
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Credit: Much of this was borrowed from Trevor McDonell's thesis.


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Normally when specifying `literate' in multiple places, the old value is
%% overwritten.
%%
%% However, in my case `loopcode' extends `haskell'. Additionally I need to be
%% able to specify extra listing-specific literates.
%%
%% This hack was provided by Symbol 1 on TeX.SX:
%% http://tex.stackexchange.com/a/202340/61985
\makeatletter
\def\lst@Literatekey#1\@nil@{\let\lst@ifxliterate\lst@if
    \expandafter\def\expandafter\lst@literate\expandafter{\lst@literate#1}}
\makeatother


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Styles
%% TODO: Perhaps add aboveskip, belowcaptionskip and belowskip

\lstset{%
    frame=none,
    rulecolor={\color[gray]{0.7}},
    numbers=none,
    basicstyle=\singlespacing\ttfamily,
    numberstyle=\normalsize\color{gray}\ttfamily,
    commentstyle=\color{MidnightBlue},
    stringstyle=\color{Maroon},
    keywordstyle=[1],
    keywordstyle=[2]\color{ForestGreen},
    keywordstyle=[3]\color{Bittersweet},
    keywordstyle=[4]\color{RoyalPurple},
    captionpos=b,
    aboveskip=0\medskipamount,          % this overrides \singlespacing ?
%   xleftmargin=0.5\parindent,
%   xrightmargin=0.5\parindent,
    belowskip=1.5\medskipamount,
    flexiblecolumns=false,
%   basewidth={0.5em,0.45em},           % default {0.6,0.45}
    escapechar={\%},
    texcl=true,                         % tex comment lines
}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Languages

\lstloadlanguages{Haskell}

\lstdefinestyle{haskell}{%
    language=Haskell,
    upquote=true,
    deletekeywords={case,class,data,default,deriving,do,in,instance,let,of,type,where,if,then,else},
    morekeywords={[2]class,data,default,deriving,family,instance,type,where},
    morekeywords={[3]in,let,case,of,do,if,then,else},
    morekeywords={[4]newArray,readArray,writeArray,arrayLength,sliceArray},
    literate=
        {\\}{{$\lambda$}}1
        {\\\\}{{\char`\\\char`\\}}1
        {>->}{>->}3
        {>>=}{>>=}3
        {->}{{$\rightarrow$}}2
        {>=}{{$\geq$}}2
        {<-}{{$\leftarrow$}}2
        {<=}{{$\leq$}}2
        {=>}{{$\Rightarrow$}}2
        {|}{{$\mid$}}1
        {forall}{{$\forall$}}1
        {exists}{{$\exists$}}1
        {...}{{$\dots$}}3
        {/=}{{$\neq$}}2
%       {`}{{\`{}}}1
%       {\ .}{{$\circ$}}2
%       {\ .\ }{{$\circ$}}2
}

\lstdefinestyle{haskell-inline}{%
    style=haskell,
    basicstyle=\ttfamily,
    keywordstyle=[1],
    keywordstyle=[2],
    keywordstyle=[3],
    keywordstyle=[4],
    literate=
        {\\}{{$\lambda$}}1
        {\\\\}{{\char`\\\char`\\}}1
        {>->}{>->}3
        {>>=}{>>=}3
        {->}{{$\rightarrow$\space}}3    % include forced space
        {>=}{{$\geq$}}2
        {<-}{{$\leftarrow$}}2
        {<=}{{$\leq$}}2
        {=>}{{$\Rightarrow$}}2
        {|}{{$\mid$}}1
        {forall}{{$\forall$}}1
        {exists}{{$\exists$}}1
        {...}{{$\dots$}}3
        {/=}{{$\neq$}}2
        {^}{{$^\uparrow$}}1 % WARNING: lifted function, not exponent
}


\lstdefinestyle{loop}{%
    columns=fullflexible, % to get well spaced subscripts
    keepspaces,           % and keep spaces
    deletekeywords={case,class,data,default,deriving,do,in,instance,let,of,type,where,if,then,else,init,guard,unless,done,return},
    %morekeywords={[4]init,guard,body,yield,bottom,done},
    morekeywords={[3]let,goto,unless,return},
    morekeywords={[4]newArray,readArray,writeArray,arrayLength,sliceArray},
    literate=
        {\\}{{$\lambda$}}1
        {\\\\}{{\char`\\\char`\\}}1
        {->}{{$\rightarrow$}}2
        {>=}{{$\geq$}}2
        {<-}{{$\leftarrow$}}2
        {<=}{{$\leq$}}2
        {=>}{{$\Rightarrow$}}2
        {...}{{$\cdots$}}3
        {:=}{{$\coleq$}}2
        {|}{{$\mid$}}1
        {/=}{{$\neq$}}2
        {/}{{\normsub{/}}}1 % rate separator
}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Shorthand for inline code fragments

\newcommand{\code}[1]{\lstinline[style=haskell-inline];#1;}
\newcommand{\codemath}[1]{\lstinline[style=haskell-inline,mathescape];#1;}
\newcommand{\footcode}[1]{\lstinline[style=haskell-inline];#1;}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Inline code typeset as @map f [1,2,3]@ or \inlc{map f [1,2,3]}
%% for some reason must reactivate @ after \begin{document}

\newcommand{\makeatcode}{\lstMakeShortInline[style=haskell-inline]@}
\newcommand{\makeatchar}{\lstDeleteShortInline@}

\makeatcode %% From now on code wrapped in @...@ will typeset as inline.
            %% Disable with \makeatchar

\newcommand{\app}{\ensuremath{\mathbin{\texttt{\char"40}}}}

\newcommand\inlc\lstinline

%% @ character must be made active *after* \begin{document} for some reason
\AtBeginDocument{\catcode`\@=\active}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% lstlisting environments for floating and fixed Haskell, C and Loop code

%% C code block without a figure box
\lstnewenvironment{ccode}[1][]
    {
        \minipage{\linewidth}
        \lstset{
            basicstyle=\singlespacing\ttfamily,
            language=C, 
            tabsize=4,
            numberstyle=\normalsize\color{gray}\ttfamily,
            #1
        }
    }
    {
        \endminipage
    }

%% C code block with a figure box
\lstnewenvironment{ccode2}[1][]
    {
        \lstset{
            basicstyle=\singlespacing\ttfamily,
            language=C,
            tabsize=4,
            float,
            numberstyle=\normalsize\color{gray}\ttfamily,
            #1
        }
    }
    {}

%% Haskell code block without a figure box
\lstnewenvironment{hscode}[1][]
    {
        \minipage{\linewidth}
        \lstset{
            style=haskell,
            #1
        }
    }
    {
        \endminipage
    }

%% Haskell code block with a figure box
\lstnewenvironment{hscode2}[1][]
    {
        \lstset{%
            style=haskell,
            float=htpb,
            #1
        }
    }
    {}

%% Loop code block without a figure box
\lstnewenvironment{loopcode}[1][]
    {
        \minipage{\linewidth}
        \lstset{
            style=loop,
            #1
        }
    }
    {
        \endminipage
    }

%% Loop code block with a figure box
\lstnewenvironment{loopcode2}[1][]
    {
        \lstset{%
            style=loop,
            float=htpb,
            #1
        }
    }
    {}

% Sample usage of ccode2, hscode2 and loopcode2
% \begin{hscode2}{%
%  caption={The equation of everything.},%
%  label=lst:eqn-of-everythin}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% I n d e x
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\input{index}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% B i b l i o g r a p h y
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% How to conditionally insert bibliography:
% - In main.tex:
%   - put \def\CompilingAll{} after \begin{document}
%   - where appropriate put:
%     \bibliography{bib}
%
% - In chapter files put:
%   \IfNotCompilingAll{\printbibliography}
% Only BibTeX: \bibliographystyle{ieeetr}

\newcommand\IfNotCompilingAll[1]{
    \ifx\CompilingAll\undefined
        #1
    \fi
}

\begin{document}

WARNING: Compile main.tex instead.

\end{document}