starpu-max/doc/doxygen/refman.tex

\documentclass{book}
\usepackage[a4paper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry}
\usepackage{makeidx}
\usepackage{natbib}
\usepackage{graphicx}
\usepackage{multicol}
\usepackage{float}
\usepackage{listings}
\usepackage{color}
\usepackage{ifthen}
\usepackage[table]{xcolor}
\usepackage{textcomp}
\usepackage{alltt}
\usepackage{ifpdf}
\usepackage{./version}
\ifpdf
\usepackage[pdftex,
            pagebackref=true,
            colorlinks=true,
            linkcolor=blue,
            unicode
           ]{hyperref}
\else
\usepackage[ps2pdf,
            pagebackref=true,
            colorlinks=true,
            linkcolor=blue,
            unicode
           ]{hyperref}
\usepackage{pspicture}
\fi
\usepackage[utf8]{inputenc}
\usepackage{mathptmx}
\usepackage[scaled=.90]{helvet}
\usepackage{courier}
\usepackage{sectsty}
\usepackage{amssymb}
\usepackage[titles]{tocloft}
\usepackage{doxygen}
\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=8,numbers=left }
\makeindex
\setcounter{tocdepth}{3}
\renewcommand{\footrulewidth}{0.4pt}
\renewcommand{\familydefault}{\sfdefault}
\hfuzz=15pt
\setlength{\emergencystretch}{15pt}
\hbadness=750
\tolerance=750
\begin{document}
\hypersetup{pageanchor=false,citecolor=blue}
\begin{titlepage}
\vspace*{4cm}
{\Huge \textbf{StarPU Handbook}}\\
\rule{\textwidth}{1.5mm}
\begin{flushright}
{\Large for StarPU \STARPUVERSION}
\end{flushright}
\rule{\textwidth}{1mm}
~\\
\vspace*{15cm}
\begin{flushright}
Generated by Doxygen $doxygenversion on $datetime
\end{flushright}
\end{titlepage}

\begin{figure}[p]
This manual documents the usage of StarPU version \STARPUVERSION. Its contents
was last updated on \STARPUUPDATED.\\

Copyright © 2009–2013 Université de Bordeaux 1\\

Copyright © 2010-2013 Centre National de la Recherche Scientifique\\

Copyright © 2011, 2012 Institut National de Recherche en Informatique et Automatique\\

\medskip

\begin{quote}
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled “GNU Free
Documentation License”.
\end{quote}
\end{figure}

\clearemptydoublepage
\pagenumbering{roman}
\tableofcontents
\clearemptydoublepage
\pagenumbering{arabic}
\hypersetup{pageanchor=true,citecolor=blue}

\chapter{Introduction}
\label{index}
\hypertarget{index}{}
\input{index}

\part{Using StarPU}

\chapter{Building and Installing StarPU}
\label{BuildingAndInstallingStarPU}
\hypertarget{BuildingAndInstallingStarPU}{}
\input{BuildingAndInstallingStarPU}

\chapter{Basic Examples}
\label{BasicExamples}
\hypertarget{BasicExamples}{}
\input{BasicExamples}

\chapter{Advanced Examples}
\label{AdvancedExamples}
\hypertarget{AdvancedExamples}{}
\input{AdvancedExamples}

\chapter{How To Optimize Performance With StarPU}
\label{HowToOptimizePerformanceWithStarPU}
\hypertarget{HowToOptimizePerformanceWithStarPU}{}
\input{HowToOptimizePerformanceWithStarPU}

\chapter{Performance Feedback}
\label{PerformanceFeedback}
\hypertarget{PerformanceFeedback}{}
\input{PerformanceFeedback}

\chapter{Tips and Tricks To Know About}
\label{TipsAndTricksToKnowAbout}
\hypertarget{TipsAndTricksToKnowAbout}{}
\input{TipsAndTricksToKnowAbout}

\chapter{MPI Support}
\label{MPISupport}
\hypertarget{MPISupport}{}
\input{MPISupport}

\chapter{FFT Support}
\label{FFTSupport}
\hypertarget{FFTSupport}{}
\input{FFTSupport}

\chapter{MIC/SCC Support}
\label{MICSCCSupport}
\hypertarget{MICSCCSupport}{}
\input{MICSCCSupport}

\chapter{C Extensions}
\label{cExtensions}
\hypertarget{cExtensions}{}
\input{cExtensions}

\chapter{SOCL OpenCL Extensions}
\label{SOCLOpenclExtensions}
\hypertarget{SOCLOpenclExtensions}{}
\input{SOCLOpenclExtensions}

\chapter{Scheduling Contexts}
\label{SchedulingContexts}
\hypertarget{SchedulingContexts}{}
\input{SchedulingContexts}

\chapter{Scheduling Context Hypervisor}
\label{SchedulingContextHypervisor}
\hypertarget{SchedulingContextHypervisor}{}
\input{SchedulingContextHypervisor}

\part{Inside StarPU}

\chapter{Execution Configuration Through Environment Variables}
\label{ExecutionConfigurationThroughEnvironmentVariables}
\hypertarget{ExecutionConfigurationThroughEnvironmentVariables}{}
\input{ExecutionConfigurationThroughEnvironmentVariables}

\chapter{Compilation Configuration}
\label{CompilationConfiguration}
\hypertarget{CompilationConfiguration}{}
\input{CompilationConfiguration}

\chapter{Module Index}
\input{modules}

\chapter{Module Documentation a.k.a StarPU's API}
\label{ModuleDocumentation}
\hypertarget{ModuleDocumentation}{}

\input{group__API__Versioning}
\input{group__API__Initialization__and__Termination}
\input{group__API__Standard__Memory__Library}
\input{group__API__Workers__Properties}
\input{group__API__Data__Management}
\input{group__API__Data__Interfaces}
\input{group__API__Data__Partition}
\input{group__API__Multiformat__Data__Interface}
\input{group__API__Codelet__And__Tasks}
\input{group__API__Insert__Task}
\input{group__API__Explicit__Dependencies}
\input{group__API__Implicit__Data__Dependencies}
\input{group__API__Performance__Model}
\input{group__API__Profiling}
\input{group__API__Theoretical__Lower__Bound__on__Execution__Time}
\input{group__API__CUDA__Extensions}
\input{group__API__OpenCL__Extensions}
\input{group__API__MIC__Extensions}
\input{group__API__SCC__Extensions}
\input{group__API__Miscellaneous__Helpers}
\input{group__API__FxT__Support}
\input{group__API__FFT__Support}
\input{group__API__MPI__Support}
\input{group__API__Task__Bundles}
\input{group__API__Task__Lists}
\input{group__API__Parallel__Tasks}
\input{group__API__Running__Drivers}
\input{group__API__Expert__Mode}
\input{group__API__StarPUTop__Interface}
\input{group__API__Scheduling__Contexts}
\input{group__API__Scheduling__Policy}
\input{group__API__Scheduling__Context__Hypervisor}

\chapter{Deprecated List}
\label{deprecated}
\hypertarget{deprecated}{}
\input{deprecated}


\addcontentsline{toc}{chapter}{Index}
\printindex

\part{Appendix}

\chapter{Full Source Code for the ’Scaling a Vector’ Example}
\label{FullSourceCodeVectorScal}
\hypertarget{FullSourceCodeVectorScal}{}
\input{FullSourceCodeVectorScal}

\chapter{GNU Free Documentation License}
\label{GNUFreeDocumentationLicense}
\hypertarget{GNUFreeDocumentationLicense}{}
\input{GNUFreeDocumentationLicense}

\end{document}