refman.tex 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. % Handle batch mode
  2. % to overcome problems with too many open files
  3. \let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}
  4. % Set document class depending on configuration
  5. \documentclass[twoside]{book}
  6. %% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package
  7. \usepackage{ifthen}
  8. \ifx\requestedLaTeXdate\undefined
  9. \usepackage{array}
  10. \else
  11. \usepackage{array}[=2016-10-06]
  12. \fi
  13. %%
  14. % Packages required by doxygen
  15. \usepackage{fixltx2e} % for \textsubscript
  16. \usepackage{doxygen}
  17. \usepackage{graphicx}
  18. \usepackage[utf8]{inputenc}
  19. \usepackage{makeidx}
  20. \PassOptionsToPackage{warn}{textcomp}
  21. \usepackage{textcomp}
  22. \usepackage[nointegrals]{wasysym}
  23. \usepackage{ifxetex}
  24. % NLS support packages
  25. % Define default fonts
  26. % Font selection
  27. \usepackage[T1]{fontenc}
  28. % set main and monospaced font
  29. \usepackage[scaled=.90]{helvet}
  30. \usepackage{courier}
  31. \renewcommand{\familydefault}{\sfdefault}
  32. \usepackage{sectsty}
  33. \allsectionsfont{%
  34. \fontseries{bc}\selectfont%
  35. \color{darkgray}%
  36. }
  37. \renewcommand{\DoxyLabelFont}{%
  38. \fontseries{bc}\selectfont%
  39. \color{darkgray}%
  40. }
  41. \newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
  42. % Arguments of doxygenemoji:
  43. % 1) ':<text>:' form of the emoji, already LaTeX-escaped
  44. % 2) file with the name of the emoji without the .png extension
  45. % in case image exist use this otherwise use the ':<text>:' form
  46. \newcommand{\doxygenemoji}[2]{%
  47. \IfFileExists{./#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{./#2.png}}}{#1}%
  48. }
  49. % Page & text layout
  50. \usepackage{geometry}
  51. \geometry{%
  52. a4paper,%
  53. top=2.5cm,%
  54. bottom=2.5cm,%
  55. left=2.5cm,%
  56. right=2.5cm%
  57. }
  58. % Allow a bit of overflow to go unnoticed by other means
  59. \tolerance=750
  60. \hfuzz=15pt
  61. \hbadness=750
  62. \setlength{\emergencystretch}{15pt}
  63. \setlength{\parindent}{0cm}
  64. \newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}}
  65. \newcommand{\doxytocparskip}{\setlength{\parskip}{1ex plus 0ex minus 0ex}}
  66. \doxynormalparskip
  67. % Redefine paragraph/subparagraph environments, using sectsty fonts
  68. \makeatletter
  69. \renewcommand{\paragraph}{%
  70. \@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
  71. \normalfont\normalsize\bfseries\SS@parafont%
  72. }%
  73. }
  74. \renewcommand{\subparagraph}{%
  75. \@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
  76. \normalfont\normalsize\bfseries\SS@subparafont%
  77. }%
  78. }
  79. \makeatother
  80. \makeatletter
  81. \newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@}
  82. \makeatother
  83. % Headers & footers
  84. \usepackage{fancyhdr}
  85. \pagestyle{fancyplain}
  86. \renewcommand{\footrulewidth}{0.4pt}
  87. \fancypagestyle{fancyplain}{
  88. \fancyhf{}
  89. \fancyhead[LE, RO]{\bfseries\thepage}
  90. \fancyhead[LO]{\bfseries\rightmark}
  91. \fancyhead[RE]{\bfseries\leftmark}
  92. \fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
  93. }
  94. \fancypagestyle{plain}{
  95. \fancyhf{}
  96. \fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
  97. \renewcommand{\headrulewidth}{0pt}
  98. }
  99. \pagestyle{fancyplain}
  100. \renewcommand{\chaptermark}[1]{%
  101. \markboth{#1}{}%
  102. }
  103. \renewcommand{\sectionmark}[1]{%
  104. \markright{\thesection\ #1}%
  105. }
  106. % ToC, LoF, LoT, bibliography, and index
  107. % Indices & bibliography
  108. \usepackage{natbib}
  109. \usepackage[titles]{tocloft}
  110. \setcounter{tocdepth}{3}
  111. \setcounter{secnumdepth}{5}
  112. % creating indexes
  113. \makeindex
  114. \usepackage{newunicodechar}
  115. \newunicodechar{⁻}{${}^{-}$}% Superscript minus
  116. \newunicodechar{²}{${}^{2}$}% Superscript two
  117. \newunicodechar{³}{${}^{3}$}% Superscript three
  118. % Hyperlinks
  119. % Hyperlinks (required, but should be loaded last)
  120. \ifpdf
  121. \usepackage[pdftex,pagebackref=true]{hyperref}
  122. \else
  123. \ifxetex
  124. \usepackage[pagebackref=true]{hyperref}
  125. \else
  126. \usepackage[ps2pdf,pagebackref=true]{hyperref}
  127. \fi
  128. \fi
  129. \hypersetup{%
  130. colorlinks=true,%
  131. linkcolor=blue,%
  132. citecolor=blue,%
  133. unicode,%
  134. pdftitle=Deep network,%
  135. pdfsubject=%
  136. }
  137. % Custom commands used by the header
  138. % Custom commands
  139. \newcommand{\clearemptydoublepage}{%
  140. \newpage{\pagestyle{empty}\cleardoublepage}%
  141. }
  142. % caption style definition
  143. \usepackage{caption}
  144. \captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
  145. % in page table of contents
  146. \usepackage{etoc}
  147. \etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
  148. % prevent numbers overlap the titles in toc
  149. \renewcommand{\numberline}[1]{#1~}
  150. % End of preamble, now comes the document contents
  151. %===== C O N T E N T S =====
  152. \begin{document}
  153. \raggedbottom
  154. % Titlepage & ToC
  155. % To avoid duplicate page anchors due to reuse of same numbers for
  156. % the index (be it as roman numbers)
  157. \hypersetup{pageanchor=false,
  158. bookmarksnumbered=true,
  159. pdfencoding=unicode
  160. }
  161. \pagenumbering{alph}
  162. \begin{titlepage}
  163. \vspace*{7cm}
  164. \begin{center}%
  165. {\Large Deep network}\\
  166. \vspace*{1cm}
  167. {\large Generated by Doxygen 1.9.3}\\
  168. \end{center}
  169. \end{titlepage}
  170. \clearemptydoublepage
  171. \pagenumbering{roman}
  172. \tableofcontents
  173. \clearemptydoublepage
  174. \pagenumbering{arabic}
  175. % re-enable anchors again
  176. \hypersetup{pageanchor=true}
  177. %--- Begin generated contents ---
  178. \chapter{Namespace Index}
  179. \input{namespaces}
  180. \chapter{Hierarchical Index}
  181. \input{hierarchy}
  182. \chapter{Class Index}
  183. \input{annotated}
  184. \chapter{File Index}
  185. \input{files}
  186. \chapter{Namespace Documentation}
  187. \input{namespace_layer}
  188. \input{namespace_math}
  189. \chapter{Class Documentation}
  190. \input{class_layer_1_1_activation_layer}
  191. \input{class_layer_1_1_convolution_layer}
  192. \input{class_dataset}
  193. \input{class_layer_1_1_full_connected_layer}
  194. \input{class_layer_1_1_layer}
  195. \input{class_mnist}
  196. \input{class_network}
  197. \input{class_layer_1_1_pooling}
  198. \input{class_shape}
  199. \chapter{File Documentation}
  200. \input{dataset_8hpp}
  201. \input{dataset_8hpp_source}
  202. \input{debug_8hpp}
  203. \input{debug_8hpp_source}
  204. \input{activation_8hpp}
  205. \input{activation_8hpp_source}
  206. \input{convolution_8cpp}
  207. \input{convolution_8hpp}
  208. \input{convolution_8hpp_source}
  209. \input{full__connected_8cpp}
  210. \input{full__connected_8hpp}
  211. \input{full__connected_8hpp_source}
  212. \input{layer_8hpp}
  213. \input{layer_8hpp_source}
  214. \input{layers_8hpp}
  215. \input{layers_8hpp_source}
  216. \input{pooling_8cpp}
  217. \input{pooling_8hpp}
  218. \input{pooling_8hpp_source}
  219. \input{main_8cpp}
  220. \input{math_8hpp}
  221. \input{math_8hpp_source}
  222. \input{mnist_8cpp}
  223. \input{mnist_8hpp}
  224. \input{mnist_8hpp_source}
  225. \input{network_8cpp}
  226. \input{network_8hpp}
  227. \input{network_8hpp_source}
  228. \input{shape_8hpp}
  229. \input{shape_8hpp_source}
  230. \input{vector_8hpp}
  231. \input{vector_8hpp_source}
  232. %--- End generated contents ---
  233. % Index
  234. \backmatter
  235. \newpage
  236. \phantomsection
  237. \clearemptydoublepage
  238. \addcontentsline{toc}{chapter}{\indexname}
  239. \printindex
  240. % Required for some languages (in combination with latexdocumentpre from the header)
  241. \end{document}