\doxysubsection{SVM boolean values}
\hypertarget{group__booleanvalues}{}\label{group__booleanvalues}\index{SVM boolean values@{SVM boolean values}}


This module contains API functions to handle SVM boolean values.  


\doxysubsubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}} \mbox{\hyperlink{group__booleanvalues_ga08903346745e3c8f5d30976eacbc6859}{svm\+\_\+value\+\_\+boolean\+\_\+new}} (const void \texorpdfstring{$\ast$}{*}svm, const \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} boolean)
\begin{DoxyCompactList}\small\item\em This function creates a boolean value the SVM can store in its memories from a raw boolean. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}} \mbox{\hyperlink{group__booleanvalues_ga39e9ecef85babcf88a73259ba254fe23}{svm\+\_\+value\+\_\+boolean\+\_\+new\+\_\+\+\_\+raw}} (const void \texorpdfstring{$\ast$}{*}svm, const int boolean)
\begin{DoxyCompactList}\small\item\em This function creates a boolean value the SVM can store in its memories from a C boolean. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}} \mbox{\hyperlink{group__booleanvalues_gad193d51d9ceaa42536a8108bce21ae91}{svm\+\_\+value\+\_\+boolean\+\_\+new\+\_\+null}} (const void \texorpdfstring{$\ast$}{*}svm)
\begin{DoxyCompactList}\small\item\em This function creates a boolean value the SVM can store in its memories without a value. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} \mbox{\hyperlink{group__booleanvalues_gab4968d4677b1f5a4b5a64d5c92099a94}{svm\+\_\+value\+\_\+type\+\_\+is\+\_\+boolean}} (const void \texorpdfstring{$\ast$}{*}svm, const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}} value)
\begin{DoxyCompactList}\small\item\em This function checks whether a value contains a boolean. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} \mbox{\hyperlink{group__booleanvalues_ga4b6099d2a90f14508184087515afcc68}{svm\+\_\+value\+\_\+boolean\+\_\+get}} (const void \texorpdfstring{$\ast$}{*}svm, const \mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}} boolean)
\begin{DoxyCompactList}\small\item\em This function extracts the SVM\+\_\+\+Boolean contained in a boolean value. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} void \mbox{\hyperlink{group__booleanvalues_ga1ad1281a295d7ca83e7c5f40b4bb6a6f}{svm\+\_\+value\+\_\+boolean\+\_\+set}} (const void \texorpdfstring{$\ast$}{*}svm, \mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}} value, const \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} boolean)
\begin{DoxyCompactList}\small\item\em This function replaces the raw boolean contained in a boolean value from a SVM\+\_\+\+Boolean. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} void \mbox{\hyperlink{group__booleanvalues_ga6c56d370b5991b8b00b97ccbd08be930}{svm\+\_\+value\+\_\+boolean\+\_\+set\+\_\+\+\_\+raw}} (const void \texorpdfstring{$\ast$}{*}svm, \mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}} value, const int boolean)
\begin{DoxyCompactList}\small\item\em This function replaces the raw boolean contained in a boolean value from a C boolean. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsubsection{Detailed Description}
This module contains API functions to handle SVM boolean values. 



\doxysubsubsection{Function Documentation}
\Hypertarget{group__booleanvalues_ga4b6099d2a90f14508184087515afcc68}\label{group__booleanvalues_ga4b6099d2a90f14508184087515afcc68} 
\index{SVM boolean values@{SVM boolean values}!svm\_value\_boolean\_get@{svm\_value\_boolean\_get}}
\index{svm\_value\_boolean\_get@{svm\_value\_boolean\_get}!SVM boolean values@{SVM boolean values}}
\doxysubsubsubsection{\texorpdfstring{svm\_value\_boolean\_get()}{svm\_value\_boolean\_get()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} svm\+\_\+value\+\_\+boolean\+\_\+get (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}}}]{boolean }\end{DoxyParamCaption})}



This function extracts the SVM\+\_\+\+Boolean contained in a boolean value. 


\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 boolean} & The boolean value to extract from.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The raw boolean contained in the value.
\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 boolean parameter does not contain an boolean.\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\doxylink{group__booleanvalues_gab4968d4677b1f5a4b5a64d5c92099a94}{svm\+\_\+value\+\_\+type\+\_\+is\+\_\+boolean} 

\doxylink{group__valuestypes_gac64c9dd002934821ebcf286a4f360741}{svm\+\_\+value\+\_\+type\+\_\+get} 
\end{DoxySeeAlso}
\Hypertarget{group__booleanvalues_ga08903346745e3c8f5d30976eacbc6859}\label{group__booleanvalues_ga08903346745e3c8f5d30976eacbc6859} 
\index{SVM boolean values@{SVM boolean values}!svm\_value\_boolean\_new@{svm\_value\_boolean\_new}}
\index{svm\_value\_boolean\_new@{svm\_value\_boolean\_new}!SVM boolean values@{SVM boolean values}}
\doxysubsubsubsection{\texorpdfstring{svm\_value\_boolean\_new()}{svm\_value\_boolean\_new()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}} svm\+\_\+value\+\_\+boolean\+\_\+new (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}}}]{boolean }\end{DoxyParamCaption})}



This function creates a boolean value the SVM can store in its memories from a raw boolean. 


\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 boolean} & The boolean to initiate the boolean value.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The boolean value.
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
\end{DoxyExceptions}
\Hypertarget{group__booleanvalues_ga39e9ecef85babcf88a73259ba254fe23}\label{group__booleanvalues_ga39e9ecef85babcf88a73259ba254fe23} 
\index{SVM boolean values@{SVM boolean values}!svm\_value\_boolean\_new\_\_raw@{svm\_value\_boolean\_new\_\_raw}}
\index{svm\_value\_boolean\_new\_\_raw@{svm\_value\_boolean\_new\_\_raw}!SVM boolean values@{SVM boolean values}}
\doxysubsubsubsection{\texorpdfstring{svm\_value\_boolean\_new\_\_raw()}{svm\_value\_boolean\_new\_\_raw()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}} svm\+\_\+value\+\_\+boolean\+\_\+new\+\_\+\+\_\+raw (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{const int}]{boolean }\end{DoxyParamCaption})}



This function creates a boolean value the SVM can store in its memories from a C boolean. 


\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 boolean} & The boolean to initiate the boolean value.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The boolean value.
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
\end{DoxyExceptions}
\Hypertarget{group__booleanvalues_gad193d51d9ceaa42536a8108bce21ae91}\label{group__booleanvalues_gad193d51d9ceaa42536a8108bce21ae91} 
\index{SVM boolean values@{SVM boolean values}!svm\_value\_boolean\_new\_null@{svm\_value\_boolean\_new\_null}}
\index{svm\_value\_boolean\_new\_null@{svm\_value\_boolean\_new\_null}!SVM boolean values@{SVM boolean values}}
\doxysubsubsubsection{\texorpdfstring{svm\_value\_boolean\_new\_null()}{svm\_value\_boolean\_new\_null()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}} svm\+\_\+value\+\_\+boolean\+\_\+new\+\_\+null (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm }\end{DoxyParamCaption})}



This function creates a boolean value the SVM can store in its memories without a value. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em svm} & The SVM pointer passed as first argument of the callback function.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A non initialised boolean value.
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em FAILURE} & interruption when a parameter is incorrect. (Please refer to the main description page of this API.) \\
\hline
\end{DoxyExceptions}
\Hypertarget{group__booleanvalues_ga1ad1281a295d7ca83e7c5f40b4bb6a6f}\label{group__booleanvalues_ga1ad1281a295d7ca83e7c5f40b4bb6a6f} 
\index{SVM boolean values@{SVM boolean values}!svm\_value\_boolean\_set@{svm\_value\_boolean\_set}}
\index{svm\_value\_boolean\_set@{svm\_value\_boolean\_set}!SVM boolean values@{SVM boolean values}}
\doxysubsubsubsection{\texorpdfstring{svm\_value\_boolean\_set()}{svm\_value\_boolean\_set()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} void svm\+\_\+value\+\_\+boolean\+\_\+set (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{\mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}}}]{value,  }\item[{const \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}}}]{boolean }\end{DoxyParamCaption})}



This function replaces the raw boolean contained in a boolean value from a SVM\+\_\+\+Boolean. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em svm} & The SVM pointer passed as first argument of the callback function. \\
\hline
\mbox{\texttt{ in,out}}  & {\em value} & The boolean value to update. \\
\hline
\mbox{\texttt{ in}}  & {\em boolean} & The new boolean value.\\
\hline
\end{DoxyParams}

\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 boolean parameter does not contain an boolean. \\
\hline
{\em FAILURE} & interruption when the value is a constant.\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\doxylink{group__booleanvalues_gab4968d4677b1f5a4b5a64d5c92099a94}{svm\+\_\+value\+\_\+type\+\_\+is\+\_\+boolean} 

\doxylink{group__valuestypes_gac64c9dd002934821ebcf286a4f360741}{svm\+\_\+value\+\_\+type\+\_\+get} 
\end{DoxySeeAlso}
\Hypertarget{group__booleanvalues_ga6c56d370b5991b8b00b97ccbd08be930}\label{group__booleanvalues_ga6c56d370b5991b8b00b97ccbd08be930} 
\index{SVM boolean values@{SVM boolean values}!svm\_value\_boolean\_set\_\_raw@{svm\_value\_boolean\_set\_\_raw}}
\index{svm\_value\_boolean\_set\_\_raw@{svm\_value\_boolean\_set\_\_raw}!SVM boolean values@{SVM boolean values}}
\doxysubsubsubsection{\texorpdfstring{svm\_value\_boolean\_set\_\_raw()}{svm\_value\_boolean\_set\_\_raw()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} void svm\+\_\+value\+\_\+boolean\+\_\+set\+\_\+\+\_\+raw (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{\mbox{\hyperlink{group__api__types_gadb4e3d3f8c78ef0d286510ef9361bd56}{SVM\+\_\+\+Value\+\_\+\+Boolean}}}]{value,  }\item[{const int}]{boolean }\end{DoxyParamCaption})}



This function replaces the raw boolean contained in a boolean value from a C boolean. 


\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 value} & The boolean value to update. \\
\hline
\mbox{\texttt{ in}}  & {\em boolean} & The new boolean value.\\
\hline
\end{DoxyParams}

\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 value parameter does not contain an boolean. \\
\hline
{\em FAILURE} & interruption when the value is a constant.\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\doxylink{group__booleanvalues_gab4968d4677b1f5a4b5a64d5c92099a94}{svm\+\_\+value\+\_\+type\+\_\+is\+\_\+boolean} 

\doxylink{group__valuestypes_gac64c9dd002934821ebcf286a4f360741}{svm\+\_\+value\+\_\+type\+\_\+get} 
\end{DoxySeeAlso}
\Hypertarget{group__booleanvalues_gab4968d4677b1f5a4b5a64d5c92099a94}\label{group__booleanvalues_gab4968d4677b1f5a4b5a64d5c92099a94} 
\index{SVM boolean values@{SVM boolean values}!svm\_value\_type\_is\_boolean@{svm\_value\_type\_is\_boolean}}
\index{svm\_value\_type\_is\_boolean@{svm\_value\_type\_is\_boolean}!SVM boolean values@{SVM boolean values}}
\doxysubsubsubsection{\texorpdfstring{svm\_value\_type\_is\_boolean()}{svm\_value\_type\_is\_boolean()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__apimacros_ga0d0dae93534c2ba22499a92705a4e391}{SVM\+\_\+\+FUNCTION}} \mbox{\hyperlink{group__api__types_ga872facc2eea0e7296e689134f568b804}{SVM\+\_\+\+Boolean}} svm\+\_\+value\+\_\+type\+\_\+is\+\_\+boolean (\begin{DoxyParamCaption}\item[{const void \texorpdfstring{$\ast$}{*}}]{svm,  }\item[{const \mbox{\hyperlink{group__api__types_gaf37a7c40972a9dabfa18b14127c34fb1}{SVM\+\_\+\+Value}}}]{value }\end{DoxyParamCaption})}



This function checks whether a value contains a boolean. 


\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 value} & The value to be diagnosed.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
TRUE if the value contains a boolean, 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
\end{DoxyExceptions}
