[50d8d4d] | 1 | %====================================================================== |
---|
| 2 | % University of Waterloo Thesis Template for LaTeX |
---|
| 3 | % Last Updated November, 2020 |
---|
| 4 | % by Stephen Carr, IST Client Services, |
---|
| 5 | % University of Waterloo, 200 University Ave. W., Waterloo, Ontario, Canada |
---|
| 6 | % FOR ASSISTANCE, please send mail to request@uwaterloo.ca |
---|
| 7 | |
---|
| 8 | % DISCLAIMER |
---|
| 9 | % To the best of our knowledge, this template satisfies the current uWaterloo thesis requirements. |
---|
| 10 | % However, it is your responsibility to assure that you have met all requirements of the University and your particular department. |
---|
| 11 | |
---|
| 12 | % Many thanks for the feedback from many graduates who assisted the development of this template. |
---|
| 13 | % Also note that there are explanatory comments and tips throughout this template. |
---|
| 14 | %====================================================================== |
---|
| 15 | % Some important notes on using this template and making it your own... |
---|
| 16 | |
---|
| 17 | % The University of Waterloo has required electronic thesis submission since October 2006. |
---|
| 18 | % See the uWaterloo thesis regulations at |
---|
| 19 | % https://uwaterloo.ca/graduate-studies/thesis. |
---|
| 20 | % This thesis template is geared towards generating a PDF version optimized for viewing on an electronic display, including hyperlinks within the PDF. |
---|
| 21 | |
---|
| 22 | % DON'T FORGET TO ADD YOUR OWN NAME AND TITLE in the "hyperref" package configuration below. |
---|
| 23 | % THIS INFORMATION GETS EMBEDDED IN THE PDF FINAL PDF DOCUMENT. |
---|
| 24 | % You can view the information if you view properties of the PDF document. |
---|
| 25 | |
---|
| 26 | % Many faculties/departments also require one or more printed copies. |
---|
| 27 | % This template attempts to satisfy both types of output. |
---|
| 28 | % See additional notes below. |
---|
| 29 | % It is based on the standard "book" document class which provides all necessary sectioning structures and allows multi-part theses. |
---|
| 30 | |
---|
| 31 | % If you are using this template in Overleaf (cloud-based collaboration service), then it is automatically processed and previewed for you as you edit. |
---|
| 32 | |
---|
| 33 | % For people who prefer to install their own LaTeX distributions on their own computers, and process the source files manually, the following notes provide the sequence of tasks: |
---|
| 34 | |
---|
| 35 | % E.g. to process a thesis called "mythesis.tex" based on this template, run: |
---|
| 36 | |
---|
| 37 | % pdflatex mythesis -- first pass of the pdflatex processor |
---|
| 38 | % bibtex mythesis -- generates bibliography from .bib data file(s) |
---|
| 39 | % makeindex -- should be run only if an index is used |
---|
| 40 | % pdflatex mythesis -- fixes numbering in cross-references, bibliographic references, glossaries, index, etc. |
---|
| 41 | % pdflatex mythesis -- it takes a couple of passes to completely process all cross-references |
---|
| 42 | |
---|
| 43 | % If you use the recommended LaTeX editor, Texmaker, you would open the mythesis.tex file, then click the PDFLaTeX button. Then run BibTeX (under the Tools menu). |
---|
| 44 | % Then click the PDFLaTeX button two more times. |
---|
| 45 | % If you have an index as well,you'll need to run MakeIndex from the Tools menu as well, before running pdflatex |
---|
| 46 | % the last two times. |
---|
| 47 | |
---|
| 48 | % N.B. The "pdftex" program allows graphics in the following formats to be included with the "\includegraphics" command: PNG, PDF, JPEG, TIFF |
---|
| 49 | % Tip: Generate your figures and photos in the size you want them to appear in your thesis, rather than scaling them with \includegraphics options. |
---|
| 50 | % Tip: Any drawings you do should be in scalable vector graphic formats: SVG, PNG, WMF, EPS and then converted to PNG or PDF, so they are scalable in the final PDF as well. |
---|
| 51 | % Tip: Photographs should be cropped and compressed so as not to be too large. |
---|
| 52 | |
---|
| 53 | % To create a PDF output that is optimized for double-sided printing: |
---|
| 54 | % 1) comment-out the \documentclass statement in the preamble below, and un-comment the second \documentclass line. |
---|
| 55 | % 2) change the value assigned below to the boolean variable "PrintVersion" from " false" to "true". |
---|
| 56 | |
---|
| 57 | %====================================================================== |
---|
| 58 | % D O C U M E N T P R E A M B L E |
---|
| 59 | % Specify the document class, default style attributes, and page dimensions, etc. |
---|
| 60 | % For hyperlinked PDF, suitable for viewing on a computer, use this: |
---|
| 61 | \documentclass[letterpaper,12pt,titlepage,oneside,final]{book} |
---|
| 62 | |
---|
| 63 | % For PDF, suitable for double-sided printing, change the PrintVersion variable below to "true" and use this \documentclass line instead of the one above: |
---|
| 64 | %\documentclass[letterpaper,12pt,titlepage,openright,twoside,final]{book} |
---|
| 65 | |
---|
| 66 | % Some LaTeX commands I define for my own nomenclature. |
---|
| 67 | % If you have to, it's easier to make changes to nomenclature once here than in a million places throughout your thesis! |
---|
| 68 | \newcommand{\package}[1]{\textbf{#1}} % package names in bold text |
---|
| 69 | \newcommand{\cmmd}[1]{\textbackslash\texttt{#1}} % command name in tt font |
---|
| 70 | \newcommand{\href}[1]{#1} % does nothing, but defines the command so the print-optimized version will ignore \href tags (redefined by hyperref pkg). |
---|
| 71 | %\newcommand{\texorpdfstring}[2]{#1} % does nothing, but defines the command |
---|
| 72 | % Anything defined here may be redefined by packages added below... |
---|
| 73 | |
---|
| 74 | % This package allows if-then-else control structures. |
---|
| 75 | \usepackage{ifthen} |
---|
| 76 | \newboolean{PrintVersion} |
---|
| 77 | \setboolean{PrintVersion}{false} |
---|
| 78 | % CHANGE THIS VALUE TO "true" as necessary, to improve printed results for hard copies by overriding some options of the hyperref package, called below. |
---|
| 79 | |
---|
| 80 | %\usepackage{nomencl} % For a nomenclature (optional; available from ctan.org) |
---|
| 81 | \usepackage{amsmath,amssymb,amstext} % Lots of math symbols and environments |
---|
| 82 | \usepackage{xcolor} |
---|
[d0e80f61] | 83 | \usepackage{epic,eepic} |
---|
| 84 | \usepackage{graphicx} |
---|
[50d8d4d] | 85 | \usepackage{comment} % Removes large sections of the document. |
---|
| 86 | |
---|
| 87 | % Hyperlinks make it very easy to navigate an electronic document. |
---|
| 88 | % In addition, this is where you should specify the thesis title and author as they appear in the properties of the PDF document. |
---|
| 89 | % Use the "hyperref" package |
---|
| 90 | % N.B. HYPERREF MUST BE THE LAST PACKAGE LOADED; ADD ADDITIONAL PKGS ABOVE |
---|
[d0e80f61] | 91 | \usepackage[pagebackref=true]{hyperref} % with basic options |
---|
[50d8d4d] | 92 | %\usepackage[pdftex,pagebackref=true]{hyperref} |
---|
| 93 | % N.B. pagebackref=true provides links back from the References to the body text. This can cause trouble for printing. |
---|
| 94 | \hypersetup{ |
---|
| 95 | plainpages=false, % needed if Roman numbers in frontpages |
---|
| 96 | unicode=false, % non-Latin characters in Acrobat's bookmarks |
---|
| 97 | pdftoolbar=true, % show Acrobat's toolbar? |
---|
| 98 | pdfmenubar=true, % show Acrobat's menu? |
---|
| 99 | pdffitwindow=false, % window fit to page when opened |
---|
| 100 | pdfstartview={FitH}, % fits the width of the page to the window |
---|
| 101 | pdftitle={Cforall Memory Allocation}, % title: CHANGE THIS TEXT! |
---|
| 102 | pdfauthor={Mubeen Zulfiqar}, % author: CHANGE THIS TEXT! and uncomment this line |
---|
| 103 | pdfsubject={Cforall}, % subject: CHANGE THIS TEXT! and uncomment this line |
---|
| 104 | pdfkeywords={Cforall} {storage allocation} {C language}, % optional list of keywords |
---|
| 105 | pdfnewwindow=true, % links in new window |
---|
| 106 | colorlinks=true, % false: boxed links; true: colored links |
---|
| 107 | linkcolor=blue, % color of internal links |
---|
[d286e94d] | 108 | citecolor=blue, % color of links to bibliography |
---|
[50d8d4d] | 109 | filecolor=magenta, % color of file links |
---|
[d286e94d] | 110 | urlcolor=blue % color of external links |
---|
[50d8d4d] | 111 | } |
---|
| 112 | \ifthenelse{\boolean{PrintVersion}}{ % for improved print quality, change some hyperref options |
---|
| 113 | \hypersetup{ % override some previously defined hyperref options |
---|
| 114 | citecolor=black,% |
---|
| 115 | filecolor=black,% |
---|
| 116 | linkcolor=black,% |
---|
| 117 | urlcolor=black |
---|
| 118 | }}{} % end of ifthenelse (no else) |
---|
| 119 | |
---|
| 120 | %\usepackage[automake,toc,abbreviations]{glossaries-extra} % Exception to the rule of hyperref being the last add-on package |
---|
| 121 | % If glossaries-extra is not in your LaTeX distribution, get it from CTAN (http://ctan.org/pkg/glossaries-extra), |
---|
| 122 | % although it's supposed to be in both the TeX Live and MikTeX distributions. There are also documentation and |
---|
| 123 | % installation instructions there. |
---|
| 124 | |
---|
| 125 | % Setting up the page margins... |
---|
| 126 | \setlength{\textheight}{9in} |
---|
| 127 | \setlength{\topmargin}{-0.45in} |
---|
| 128 | \setlength{\headsep}{0.25in} |
---|
| 129 | % uWaterloo thesis requirements specify a minimum of 1 inch (72pt) margin at the |
---|
| 130 | % top, bottom, and outside page edges and a 1.125 in. (81pt) gutter margin (on binding side). |
---|
| 131 | % While this is not an issue for electronic viewing, a PDF may be printed, and so we have the same page layout for both printed and electronic versions, we leave the gutter margin in. |
---|
| 132 | % Set margins to minimum permitted by uWaterloo thesis regulations: |
---|
| 133 | \setlength{\marginparwidth}{0pt} % width of margin notes |
---|
| 134 | % N.B. If margin notes are used, you must adjust \textwidth, \marginparwidth |
---|
| 135 | % and \marginparsep so that the space left between the margin notes and page |
---|
| 136 | % edge is less than 15 mm (0.6 in.) |
---|
| 137 | \setlength{\marginparsep}{0pt} % width of space between body text and margin notes |
---|
| 138 | \setlength{\evensidemargin}{0.125in} % Adds 1/8 in. to binding side of all |
---|
| 139 | % even-numbered pages when the "twoside" printing option is selected |
---|
| 140 | \setlength{\oddsidemargin}{0.125in} % Adds 1/8 in. to the left of all pages when "oneside" printing is selected, and to the left of all odd-numbered pages when "twoside" printing is selected |
---|
| 141 | \setlength{\textwidth}{6.375in} % assuming US letter paper (8.5 in. x 11 in.) and side margins as above |
---|
| 142 | \raggedbottom |
---|
| 143 | |
---|
| 144 | % The following statement specifies the amount of space between paragraphs. Other reasonable specifications are \bigskipamount and \smallskipamount. |
---|
| 145 | \setlength{\parskip}{\medskipamount} |
---|
| 146 | |
---|
| 147 | % The following statement controls the line spacing. |
---|
| 148 | % The default spacing corresponds to good typographic conventions and only slight changes (e.g., perhaps "1.2"), if any, should be made. |
---|
| 149 | \renewcommand{\baselinestretch}{1} % this is the default line space setting |
---|
| 150 | |
---|
| 151 | % By default, each chapter will start on a recto (right-hand side) page. |
---|
| 152 | % We also force each section of the front pages to start on a recto page by inserting \cleardoublepage commands. |
---|
| 153 | % In many cases, this will require that the verso (left-hand) page be blank, and while it should be counted, a page number should not be printed. |
---|
| 154 | % The following statements ensure a page number is not printed on an otherwise blank verso page. |
---|
| 155 | \let\origdoublepage\cleardoublepage |
---|
| 156 | \newcommand{\clearemptydoublepage}{% |
---|
| 157 | \clearpage{\pagestyle{empty}\origdoublepage}} |
---|
| 158 | \let\cleardoublepage\clearemptydoublepage |
---|
| 159 | |
---|
| 160 | % Define Glossary terms (This is properly done here, in the preamble and |
---|
| 161 | % could also be \input{} from a separate file...) |
---|
| 162 | %\input{glossaries} |
---|
| 163 | %\makeglossaries |
---|
| 164 | |
---|
| 165 | % cfa macros used in the document |
---|
| 166 | \input{common} |
---|
[26da2a0] | 167 | %\usepackageinput{common} |
---|
[50d8d4d] | 168 | \CFAStyle % CFA code-style for all languages |
---|
[26da2a0] | 169 | \lstset{basicstyle=\linespread{0.9}\tt} % CFA typewriter font |
---|
[d286e94d] | 170 | \newcommand{\PAB}[1]{{\color{red}PAB: #1}} |
---|
[50d8d4d] | 171 | |
---|
| 172 | %====================================================================== |
---|
| 173 | % L O G I C A L D O C U M E N T |
---|
| 174 | % The logical document contains the main content of your thesis. |
---|
| 175 | % Being a large document, it is a good idea to divide your thesis into several files, each one containing one chapter or other significant chunk of content, so you can easily shuffle things around later if desired. |
---|
| 176 | %====================================================================== |
---|
| 177 | \begin{document} |
---|
| 178 | |
---|
| 179 | %---------------------------------------------------------------------- |
---|
| 180 | % FRONT MATERIAL |
---|
| 181 | % title page,declaration, borrowers' page, abstract, acknowledgements, |
---|
| 182 | % dedication, table of contents, list of tables, list of figures, nomenclature, etc. |
---|
| 183 | %---------------------------------------------------------------------- |
---|
| 184 | \input{uw-ethesis-frontpgs} |
---|
| 185 | |
---|
| 186 | %---------------------------------------------------------------------- |
---|
| 187 | % MAIN BODY |
---|
| 188 | % We suggest using a separate file for each chapter of your thesis. |
---|
| 189 | % Start each chapter file with the \chapter command. |
---|
| 190 | % Only use \documentclass or \begin{document} and \end{document} commands in this master document. |
---|
| 191 | % Tip: Putting each sentence on a new line is a way to simplify later editing. |
---|
| 192 | %---------------------------------------------------------------------- |
---|
| 193 | \input{intro} |
---|
| 194 | \input{background} |
---|
| 195 | \input{allocator} |
---|
| 196 | \input{benchmarks} |
---|
[d286e94d] | 197 | \input{performance} |
---|
[50d8d4d] | 198 | \input{conclusion} |
---|
| 199 | |
---|
| 200 | %---------------------------------------------------------------------- |
---|
| 201 | % END MATERIAL |
---|
| 202 | % Bibliography, Appendices, Index, etc. |
---|
| 203 | %---------------------------------------------------------------------- |
---|
| 204 | |
---|
| 205 | % Bibliography |
---|
| 206 | |
---|
| 207 | % The following statement selects the style to use for references. |
---|
| 208 | % It controls the sort order of the entries in the bibliography and also the formatting for the in-text labels. |
---|
| 209 | \bibliographystyle{plain} |
---|
| 210 | % This specifies the location of the file containing the bibliographic information. |
---|
| 211 | % It assumes you're using BibTeX to manage your references (if not, why not?). |
---|
| 212 | \cleardoublepage % This is needed if the "book" document class is used, to place the anchor in the correct page, because the bibliography will start on its own page. |
---|
| 213 | % Use \clearpage instead if the document class uses the "oneside" argument |
---|
| 214 | \phantomsection % With hyperref package, enables hyperlinking from the table of contents to bibliography |
---|
| 215 | % The following statement causes the title "References" to be used for the bibliography section: |
---|
| 216 | \renewcommand*{\bibname}{References} |
---|
| 217 | |
---|
| 218 | % Add the References to the Table of Contents |
---|
| 219 | \addcontentsline{toc}{chapter}{\textbf{References}} |
---|
| 220 | |
---|
| 221 | \bibliography{uw-ethesis,pl} |
---|
| 222 | % Tip: You can create multiple .bib files to organize your references. |
---|
| 223 | % Just list them all in the \bibliogaphy command, separated by commas (no spaces). |
---|
| 224 | |
---|
| 225 | % The following statement causes the specified references to be added to the bibliography even if they were not cited in the text. |
---|
| 226 | % The asterisk is a wildcard that causes all entries in the bibliographic database to be included (optional). |
---|
| 227 | % \nocite{*} |
---|
| 228 | %---------------------------------------------------------------------- |
---|
| 229 | |
---|
| 230 | % Appendices |
---|
| 231 | |
---|
| 232 | % The \appendix statement indicates the beginning of the appendices. |
---|
| 233 | \appendix |
---|
| 234 | % Add an un-numbered title page before the appendices and a line in the Table of Contents |
---|
| 235 | % \chapter*{APPENDICES} |
---|
| 236 | % \addcontentsline{toc}{chapter}{APPENDICES} |
---|
| 237 | % Appendices are just more chapters, with different labeling (letters instead of numbers). |
---|
| 238 | % \input{appendix-matlab_plots.tex} |
---|
| 239 | |
---|
| 240 | % GLOSSARIES (Lists of definitions, abbreviations, symbols, etc. |
---|
| 241 | % provided by the glossaries-extra package) |
---|
| 242 | % ----------------------------- |
---|
| 243 | %\printglossaries |
---|
| 244 | %\cleardoublepage |
---|
| 245 | %\phantomsection % allows hyperref to link to the correct page |
---|
| 246 | |
---|
| 247 | %---------------------------------------------------------------------- |
---|
| 248 | \end{document} % end of logical document |
---|