\hypertarget{group__keywordparameters}{}\doxysection{SVM keyword parameters}
\label{group__keywordparameters}\index{SVM keyword parameters@{SVM keyword parameters}}


This module contains API functions to handle SVM keyword parameters.  


\doxysubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} \mbox{\hyperlink{group__keywordparameters_ga15f6847dc8e1ca4b8e61679ca0cdec86}{svm\+\_\+parameter\+\_\+type\+\_\+is\+\_\+keyword}} (const void $\ast$svm, const \mbox{\hyperlink{group__api__types_gab05a82304ba262cf3ae97b0c5f8ab707}{SVM\+\_\+\+Parameter}} parameter)
\begin{DoxyCompactList}\small\item\em This function checks whether a parameter contains a keyword. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{struct_s_v_m___string}{SVM\+\_\+\+String}} \mbox{\hyperlink{group__keywordparameters_ga24698436d6c14fc64a96f4fadb44f7f5}{svm\+\_\+parameter\+\_\+keyword\+\_\+get}} (const void $\ast$svm, const \mbox{\hyperlink{group__api__types_gab05a82304ba262cf3ae97b0c5f8ab707}{SVM\+\_\+\+Parameter}} parameter)
\begin{DoxyCompactList}\small\item\em This function converts a parameter into a keyword. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gab05a82304ba262cf3ae97b0c5f8ab707}{SVM\+\_\+\+Parameter}} \mbox{\hyperlink{group__keywordparameters_ga6f15c06726622d158a86fd8801a27e76}{svm\+\_\+parameter\+\_\+keyword\+\_\+new}} (const void $\ast$svm, const \mbox{\hyperlink{struct_s_v_m___string}{SVM\+\_\+\+String}} keyword)
\begin{DoxyCompactList}\small\item\em This function creates a parameter from a keyword string. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gab05a82304ba262cf3ae97b0c5f8ab707}{SVM\+\_\+\+Parameter}} \mbox{\hyperlink{group__keywordparameters_gaec507ef700a200a14a4b40e7f7aee6ba}{svm\+\_\+parameter\+\_\+keyword\+\_\+new\+\_\+\+\_\+raw}} (const void $\ast$svm, const char $\ast$keyword)
\begin{DoxyCompactList}\small\item\em This function creates a parameter from a keyword string. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
This module contains API functions to handle SVM keyword parameters. 



\doxysubsection{Function Documentation}
\mbox{\Hypertarget{group__keywordparameters_ga24698436d6c14fc64a96f4fadb44f7f5}\label{group__keywordparameters_ga24698436d6c14fc64a96f4fadb44f7f5}} 
\index{SVM keyword parameters@{SVM keyword parameters}!svm\_parameter\_keyword\_get@{svm\_parameter\_keyword\_get}}
\index{svm\_parameter\_keyword\_get@{svm\_parameter\_keyword\_get}!SVM keyword parameters@{SVM keyword parameters}}
\doxysubsubsection{\texorpdfstring{svm\_parameter\_keyword\_get()}{svm\_parameter\_keyword\_get()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{struct_s_v_m___string}{SVM\+\_\+\+String}} svm\+\_\+parameter\+\_\+keyword\+\_\+get (\begin{DoxyParamCaption}\item[{const void $\ast$}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_gab05a82304ba262cf3ae97b0c5f8ab707}{SVM\+\_\+\+Parameter}}}]{parameter }\end{DoxyParamCaption})}



This function converts a parameter into a keyword. 

A keyword is a word in capital letters used as a flag or constant in parameter lists.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em svm} & The SVM pointer passed as first argument of the callback function. \\
\hline
\mbox{\texttt{ in}}  & {\em parameter} & The callback parameter to convert.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The keyword as a \mbox{\hyperlink{struct_s_v_m___string}{SVM\+\_\+\+String}}.
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
{\em FAILURE} & interruption when the parameter does not contain a keyword.\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{group__keywordparameters_ga15f6847dc8e1ca4b8e61679ca0cdec86}{svm\+\_\+parameter\+\_\+type\+\_\+is\+\_\+keyword}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{group__keywordparameters_ga6f15c06726622d158a86fd8801a27e76}\label{group__keywordparameters_ga6f15c06726622d158a86fd8801a27e76}} 
\index{SVM keyword parameters@{SVM keyword parameters}!svm\_parameter\_keyword\_new@{svm\_parameter\_keyword\_new}}
\index{svm\_parameter\_keyword\_new@{svm\_parameter\_keyword\_new}!SVM keyword parameters@{SVM keyword parameters}}
\doxysubsubsection{\texorpdfstring{svm\_parameter\_keyword\_new()}{svm\_parameter\_keyword\_new()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gab05a82304ba262cf3ae97b0c5f8ab707}{SVM\+\_\+\+Parameter}} svm\+\_\+parameter\+\_\+keyword\+\_\+new (\begin{DoxyParamCaption}\item[{const void $\ast$}]{svm,  }\item[{const \mbox{\hyperlink{struct_s_v_m___string}{SVM\+\_\+\+String}}}]{keyword }\end{DoxyParamCaption})}



This function creates a parameter from a keyword string. 

A keyword is a word in capital letters used as a flag or constant in parameter lists.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em svm} & The SVM pointer passed as first argument of the callback function. \\
\hline
\mbox{\texttt{ in}}  & {\em keyword} & The keyword to be passed as a parameter.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A parameter containing the keyword.
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
{\em FAILURE} & interruption when the keyword is empty or has a non capital-\/letter character. \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{group__keywordparameters_gaec507ef700a200a14a4b40e7f7aee6ba}\label{group__keywordparameters_gaec507ef700a200a14a4b40e7f7aee6ba}} 
\index{SVM keyword parameters@{SVM keyword parameters}!svm\_parameter\_keyword\_new\_\_raw@{svm\_parameter\_keyword\_new\_\_raw}}
\index{svm\_parameter\_keyword\_new\_\_raw@{svm\_parameter\_keyword\_new\_\_raw}!SVM keyword parameters@{SVM keyword parameters}}
\doxysubsubsection{\texorpdfstring{svm\_parameter\_keyword\_new\_\_raw()}{svm\_parameter\_keyword\_new\_\_raw()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gab05a82304ba262cf3ae97b0c5f8ab707}{SVM\+\_\+\+Parameter}} svm\+\_\+parameter\+\_\+keyword\+\_\+new\+\_\+\+\_\+raw (\begin{DoxyParamCaption}\item[{const void $\ast$}]{svm,  }\item[{const char $\ast$}]{keyword }\end{DoxyParamCaption})}



This function creates a parameter from a keyword string. 

A keyword is a word in capital letters used as a flag or constant in parameter lists.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em svm} & The SVM pointer passed as first argument of the callback function. \\
\hline
\mbox{\texttt{ in}}  & {\em keyword} & The keyword to be passed as a parameter.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A parameter containing the keyword.
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
{\em FAILURE} & interruption when the keyword is empty or has a non capital-\/letter character. \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{group__keywordparameters_ga15f6847dc8e1ca4b8e61679ca0cdec86}\label{group__keywordparameters_ga15f6847dc8e1ca4b8e61679ca0cdec86}} 
\index{SVM keyword parameters@{SVM keyword parameters}!svm\_parameter\_type\_is\_keyword@{svm\_parameter\_type\_is\_keyword}}
\index{svm\_parameter\_type\_is\_keyword@{svm\_parameter\_type\_is\_keyword}!SVM keyword parameters@{SVM keyword parameters}}
\doxysubsubsection{\texorpdfstring{svm\_parameter\_type\_is\_keyword()}{svm\_parameter\_type\_is\_keyword()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} svm\+\_\+parameter\+\_\+type\+\_\+is\+\_\+keyword (\begin{DoxyParamCaption}\item[{const void $\ast$}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_gab05a82304ba262cf3ae97b0c5f8ab707}{SVM\+\_\+\+Parameter}}}]{parameter }\end{DoxyParamCaption})}



This function checks whether a parameter contains a keyword. 

A keyword is a word in capital letters used as a flag or constant in parameter lists.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em svm} & The SVM pointer passed as first argument of the callback function. \\
\hline
\mbox{\texttt{ in}}  & {\em parameter} & The callback parameter to check.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
TRUE if the parameter contains a keyword, FALSE otherwise.
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
{\em FAILURE} & interruption when the marker string does not correspond to a valid marker. \\
\hline
\end{DoxyExceptions}
