refman.tex 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. \documentclass{book}
  2. \usepackage[a4paper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry}
  3. \usepackage{makeidx}
  4. \usepackage{natbib}
  5. \usepackage{graphicx}
  6. \usepackage{multicol}
  7. \usepackage{float}
  8. \usepackage{listings}
  9. \usepackage{color}
  10. \usepackage{ifthen}
  11. \usepackage[table]{xcolor}
  12. \usepackage{textcomp}
  13. \usepackage{alltt}
  14. \usepackage{ifpdf}
  15. \usepackage{../version}
  16. \ifpdf
  17. \usepackage[pdftex,
  18. pagebackref=true,
  19. colorlinks=true,
  20. linkcolor=blue,
  21. unicode
  22. ]{hyperref}
  23. \else
  24. \usepackage[ps2pdf,
  25. pagebackref=true,
  26. colorlinks=true,
  27. linkcolor=blue,
  28. unicode
  29. ]{hyperref}
  30. \usepackage{pspicture}
  31. \fi
  32. \usepackage[utf8]{inputenc}
  33. \usepackage{mathptmx}
  34. \usepackage[scaled=.90]{helvet}
  35. \usepackage{courier}
  36. \usepackage{sectsty}
  37. \usepackage{amssymb}
  38. \usepackage[titles]{tocloft}
  39. \usepackage{doxygen}
  40. \lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=8,numbers=left }
  41. \makeindex
  42. \setcounter{tocdepth}{3}
  43. \renewcommand{\footrulewidth}{0.4pt}
  44. \renewcommand{\familydefault}{\sfdefault}
  45. \hfuzz=15pt
  46. \setlength{\emergencystretch}{15pt}
  47. \hbadness=750
  48. \tolerance=750
  49. \begin{document}
  50. \hypersetup{pageanchor=false,citecolor=blue}
  51. \begin{titlepage}
  52. \vspace*{4cm}
  53. {\Huge \textbf{StarPU Handbook}}\\
  54. \rule{\textwidth}{1.5mm}
  55. \begin{flushright}
  56. {\Large for StarPU \STARPUVERSION}
  57. \end{flushright}
  58. \rule{\textwidth}{1mm}
  59. ~\\
  60. \vspace*{15cm}
  61. \begin{flushright}
  62. Generated by Doxygen $doxygenversion on $datetime
  63. \end{flushright}
  64. \end{titlepage}
  65. \begin{figure}[p]
  66. This manual documents the usage of StarPU version \STARPUVERSION. Its contents
  67. was last updated on \STARPUUPDATED.\\
  68. Copyright © 2009–2013 Université de Bordeaux 1\\
  69. Copyright © 2010-2013 Centre National de la Recherche Scientifique\\
  70. Copyright © 2011, 2012 Institut National de Recherche en Informatique et Automatique\\
  71. \medskip
  72. \begin{quote}
  73. Permission is granted to copy, distribute and/or modify this document
  74. under the terms of the GNU Free Documentation License, Version 1.3 or
  75. any later version published by the Free Software Foundation; with no
  76. Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
  77. copy of the license is included in the section entitled “GNU Free
  78. Documentation License”.
  79. \end{quote}
  80. \end{figure}
  81. \clearemptydoublepage
  82. \pagenumbering{roman}
  83. \tableofcontents
  84. \clearemptydoublepage
  85. \pagenumbering{arabic}
  86. \hypersetup{pageanchor=true,citecolor=blue}
  87. \part{Using StarPU}
  88. \chapter{Introduction}
  89. \label{index}
  90. \hypertarget{index}{}
  91. \input{index}
  92. \chapter{Building and Installing Star\-P\-U}
  93. \label{buildingAndInstalling}
  94. \hypertarget{buildingAndInstalling}{}
  95. \input{buildingAndInstalling}
  96. \chapter{Basic Examples}
  97. \label{basicExamples}
  98. \hypertarget{basicExamples}{}
  99. \input{basicExamples}
  100. \chapter{Advanced Examples}
  101. \label{advancedExamples}
  102. \hypertarget{advancedExamples}{}
  103. \input{advancedExamples}
  104. \chapter{How to optimize performance with StarPU}
  105. \label{optimizePerformance}
  106. \hypertarget{optimizePerformance}{}
  107. \input{optimizePerformance}
  108. \chapter{Performance Feedback}
  109. \label{performanceFeedback}
  110. \hypertarget{performanceFeedback}{}
  111. \input{performanceFeedback}
  112. \chapter{Tips and Tricks to know about}
  113. \label{tipsTricks}
  114. \hypertarget{tipsTricks}{}
  115. \input{tipsTricks}
  116. \chapter{StarPU MPI Support}
  117. \label{mpiSupport}
  118. \hypertarget{mpiSupport}{}
  119. \input{mpiSupport}
  120. \chapter{StarPU FFT Support}
  121. \label{fftSupport}
  122. \hypertarget{fftSupport}{}
  123. \input{fftSupport}
  124. \chapter{C Extensions}
  125. \label{cExtensions}
  126. \hypertarget{cExtensions}{}
  127. \input{cExtensions}
  128. \chapter{SOCL OpenCL Extensions}
  129. \label{soclOpenclExtensions}
  130. \hypertarget{soclOpenclExtensions}{}
  131. \input{soclOpenclExtensions}
  132. \chapter{Scheduling Contexts in StarPU}
  133. \label{schedulingContexts}
  134. \hypertarget{schedulingContexts}{}
  135. \input{schedulingContexts}
  136. \chapter{Scheduling Context Hypervisor}
  137. \label{schedulingContextHypervisor}
  138. \hypertarget{schedulingContextHypervisor}{}
  139. \input{schedulingContextHypervisor}
  140. \part{Inside StarPU}
  141. \chapter{Module Index}
  142. \input{modules}
  143. \chapter{Module Documentation a.k.a StarPU's API}
  144. \input{group__Versioning}
  145. \input{group__Initialization__and__Termination}
  146. \input{group__Standard__Memory__Library}
  147. \input{group__Workers__Properties}
  148. \input{group__Data__Management}
  149. \input{group__Data__Interfaces}
  150. \input{group__Data__Partition}
  151. \input{group__Multiformat__Data__Interface}
  152. \input{group__Codelet__And__Tasks}
  153. \input{group__Insert__Task}
  154. \input{group__Explicit__Dependencies}
  155. \input{group__Implicit__Data__Dependencies}
  156. \input{group__Performance__Model}
  157. \input{group__Profiling}
  158. \input{group__Theoretical__lower__bound__on__execution__time}
  159. \input{group__CUDA__Extensions}
  160. \input{group__OpenCL__Extensions}
  161. %\input{group__MIC__Extensions}
  162. %\input{group__SCC__Extensions}
  163. \input{group__Miscellaneous__helpers}
  164. \input{group__FxT__Support}
  165. \input{group__FFT__Support}
  166. \input{group__MPI__Support}
  167. \input{group__Task__Bundles}
  168. \input{group__Task__Lists}
  169. \input{group__Parallel__Tasks}
  170. \input{group__Running__Drivers}
  171. \input{group__Expert__Mode}
  172. \input{group__StarPU-Top__Interface}
  173. \input{group__Scheduling__Contexts}
  174. \input{group__Scheduling__Policy}
  175. \input{group__Scheduling__Context__Hypervisor}
  176. \chapter{Deprecated List}
  177. \label{deprecated}
  178. \hypertarget{deprecated}{}
  179. \input{deprecated}
  180. \printindex
  181. \end{document}
  182. \chapter{}
  183. \label{}
  184. \hypertarget{}{}
  185. \input{}