Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 739f8fa

Browse files
Add simple interface documentation
1 parent 1cd8b58 commit 739f8fa

File tree

2 files changed

+155
-1
lines changed

2 files changed

+155
-1
lines changed

‎.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ cmake-build-release/
3939

4040

4141
### cmale internediates
42-
buil/
42+
build

‎doc/Interface.tex

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
\documentclass{scrartcl}
2+
3+
\usepackage[T1]{fontenc}
4+
\usepackage[utf8]{inputenc}
5+
\usepackage[english]{babel}
6+
\usepackage[table]{xcolor}
7+
\usepackage[labelfont=bf]{caption}
8+
\usepackage[colorinlistoftodos,%
9+
prependcaption,%
10+
textsize=tiny]{todonotes}
11+
\usepackage{hyperref}
12+
\usepackage{enumitem}
13+
\usepackage{multicol}
14+
\usepackage{multirow}
15+
\usepackage{tabularx}
16+
\usepackage{nameref}
17+
\usepackage{floatrow}
18+
\usepackage[outputdir=build]{minted}
19+
\usepackage{url}
20+
\usepackage{tikz}
21+
\usepackage{csquotes}
22+
\usepackage{pdflscape}
23+
\usepackage{environ}
24+
\usepackage{booktabs}
25+
\usepackage[citestyle=alphabetic-verb,%
26+
bibstyle=numeric,%
27+
hyperref,%
28+
backend=biber]{biblatex}
29+
\usepackage{pgfgantt}
30+
31+
%% Meta Information %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32+
33+
\newcommand{\thetitle}{Algorithm Engineering - Parallel Graph Colouring Framework}
34+
35+
\newcommand{\thekeywords}{Algorithm Engineering SS 17}
36+
37+
\renewcommand{\theauthor}{Rudolf Biczok}
38+
39+
\newcounter{myWeekNum}
40+
\stepcounter{myWeekNum}
41+
%
42+
\newcommand{\myWeek}{\themyWeekNum
43+
\stepcounter{myWeekNum}
44+
\ifnum\themyWeekNum=53
45+
\setcounter{myWeekNum}{1}
46+
\else\fi
47+
}
48+
49+
\setlength\parindent{0pt}
50+
51+
%% PDF Setup %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
52+
53+
\hypersetup{
54+
% non-Latin characters in Acrobat’s bookmarks
55+
unicode=true, %
56+
% show Acrobat’s toolbar?
57+
pdftoolbar=true, %
58+
% show Acrobat’s menu?
59+
pdfmenubar=true, %
60+
% window fit to page when opened
61+
pdffitwindow=false, %
62+
% fits the width of the page to the window
63+
pdfstartview={FitH}, %
64+
% title
65+
pdftitle={\thetitle}, %
66+
% author
67+
pdfauthor={\theauthor}, %
68+
% subject of the document
69+
pdfsubject={Industry 4.0}, %
70+
% creator of the document
71+
pdfcreator={\theauthor}, %
72+
% producer of the document
73+
pdfproducer={Producer}, %
74+
% keywords
75+
pdfkeywords={\thekeywords}, %
76+
% links in new window
77+
pdfnewwindow=false, %
78+
% false: boxed links; true: colored links
79+
colorlinks=true, %
80+
% color of internal links (change box color with linkbordercolor)
81+
linkcolor=blue, %
82+
% color of links to bibliography
83+
citecolor=green, %
84+
% color of file links
85+
filecolor=magenta, %
86+
% color of external links
87+
urlcolor=cyan %
88+
}
89+
90+
91+
%% Actual Content %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
92+
93+
\begin{document}
94+
95+
\section{Operators}
96+
97+
The operators you are going to implement should have the following signature:
98+
99+
\subsection{Initialization Operator}
100+
101+
\renewcommand{\theFancyVerbLine}{\sffamily \textcolor[rgb]{0.5,0.5,1.0}{\normalsize \oldstylenums{\arabic{FancyVerbLine}}}}
102+
103+
\begin{minted}[frame=lines,
104+
framesep=2mm,
105+
baselinestretch=1.2,
106+
linenos]{cpp}
107+
Colouring initOperator(const graph_access &G, const ColorCount k);
108+
\end{minted}
109+
110+
\textbf{Returns} the vector of unsigned int values \\ (\mintinline{cpp}{typedef std::vector<uint32_t> Colouring}) representing the initialized colouring.
111+
112+
\textbf{Parameters:}
113+
\begin{description}
114+
\item[graph\_access] The input graph used to generate the colourings
115+
\item[k] The number of colours passed from parallel algorithm. \\
116+
It can be ignored if the algorithm does not need it for initialization.
117+
\end{description}
118+
119+
\subsection{Crossover Operator}
120+
121+
\begin{minted}[frame=lines,
122+
framesep=2mm,
123+
baselinestretch=1.2,
124+
linenos]{cpp}
125+
Colouring crossoverOperator(const Colouring &s1, const Colouring &s2
126+
const graph_access &G);
127+
\end{minted}
128+
129+
\textbf{Returns} a new colouring based on two given parent colourings.
130+
131+
\textbf{Parameters:}
132+
\begin{description}
133+
\item[s1 and s2] The two parent colourings
134+
\item[G] The input graph used to generate the colourings
135+
\end{description}
136+
137+
\subsection{Local Search Operator}
138+
139+
\begin{minted}[frame=lines,
140+
framesep=2mm,
141+
baselinestretch=1.2,
142+
linenos]{cpp}
143+
Colouring lsOperator(const Colouring &s, const graph_access &G);
144+
\end{minted}
145+
146+
\textbf{Returns} a enhanced variant of the colouring s
147+
148+
\textbf{Parameters:}
149+
\begin{description}
150+
\item[s] The source colourig to mutate
151+
\item[G] The input graph used to generate the colourings
152+
\end{description}
153+
154+
\end{document}

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /