Skip to content

Commit 5bf4ee4

Browse files
committed
Update interface documentation
1 parent 9fd57f0 commit 5bf4ee4

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

doc/Interface.tex

+4-2
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,9 @@ \subsection{Initialization Operator}
107107
Colouring initOperator(const graph_access &G, const ColorCount k);
108108
\end{minted}
109109

110-
\textbf{Returns} the vector of unsigned int values \\ (\mintinline{cpp}{typedef std::vector<uint32_t> Colouring}) representing the initialized colouring.
110+
\textbf{Returns} the vector of unsigned int values \\ (\mintinline{cpp}{typedef std::vector<uint32_t> Colouring}) representing the colouring for each node.
111+
112+
Use the marko \mintinline{cpp}{UNCOLORED} to mark a node as uncolored.
111113

112114
\textbf{Parameters:}
113115
\begin{description}
@@ -143,7 +145,7 @@ \subsection{Local Search Operator}
143145
Colouring lsOperator(const Colouring &s, const graph_access &G);
144146
\end{minted}
145147

146-
\textbf{Returns} a enhanced variant of the colouring s
148+
\textbf{Returns} a enhanced variant of the colouring s.
147149

148150
\textbf{Parameters:}
149151
\begin{description}

0 commit comments

Comments
 (0)