From 062f5a69cd3f6054f05123207c5d6350c58c3a1a Mon Sep 17 00:00:00 2001
From: Ian Barber <ianb@php.net>
Date: Sat, 21 Jan 2012 23:07:07 +0000
Subject: [PATCH] Updating SVM extension documentation for 0.1.5 release

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322552 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../svm/svmmodel/checkprobabilitymodel.xml    | 55 ++++++++++++++++
 reference/svm/svmmodel/getlabels.xml          | 65 +++++++++++++++++++
 reference/svm/svmmodel/getnrclass.xml         | 55 ++++++++++++++++
 reference/svm/svmmodel/getsvmtype.xml         | 55 ++++++++++++++++
 reference/svm/svmmodel/getsvrprobability.xml  | 56 ++++++++++++++++
 reference/svm/versions.xml                    |  5 ++
 6 files changed, 291 insertions(+)
 create mode 100644 reference/svm/svmmodel/checkprobabilitymodel.xml
 create mode 100644 reference/svm/svmmodel/getlabels.xml
 create mode 100644 reference/svm/svmmodel/getnrclass.xml
 create mode 100644 reference/svm/svmmodel/getsvmtype.xml
 create mode 100644 reference/svm/svmmodel/getsvrprobability.xml

diff --git a/reference/svm/svmmodel/checkprobabilitymodel.xml b/reference/svm/svmmodel/checkprobabilitymodel.xml
new file mode 100644
index 0000000000..18a4813927
--- /dev/null
+++ b/reference/svm/svmmodel/checkprobabilitymodel.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 317663 $ -->
+
+<refentry xml:id="svmmodel.checkprobabilitymodel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SVMModel::checkProbabilityModel</refname>
+  <refpurpose>Returns true if the model has probability information</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>SVMModel::checkProbabilityModel</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Returns true if the model contains probability information.
+  </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Return a boolean value
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/svm/svmmodel/getlabels.xml b/reference/svm/svmmodel/getlabels.xml
new file mode 100644
index 0000000000..cc2cf51351
--- /dev/null
+++ b/reference/svm/svmmodel/getlabels.xml
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 317663 $ -->
+
+<refentry xml:id="svmmodel.getlabels" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SVMModel::getLabels</refname>
+  <refpurpose>Get the labels the model was trained on</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>array</type><methodname>SVMModel::getLabels</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Return an array of labels that the model was trained on. For regression and one class
+   models an empty array is returned. 
+  </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Return an array of labels
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>SVMModel::getNrClass</methodname></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/svm/svmmodel/getnrclass.xml b/reference/svm/svmmodel/getnrclass.xml
new file mode 100644
index 0000000000..60f2659012
--- /dev/null
+++ b/reference/svm/svmmodel/getnrclass.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 317663 $ -->
+
+<refentry xml:id="svmmodel.getnrclass" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SVMModel::getNrClass</refname>
+  <refpurpose>Returns the number of classes the model was trained with</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>int</type><methodname>SVMModel::getNrClass</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Returns the number of classes the model was trained with, will return 2 for one class and regression models.
+  </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Return an integer number of classes
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/svm/svmmodel/getsvmtype.xml b/reference/svm/svmmodel/getsvmtype.xml
new file mode 100644
index 0000000000..aacc53a04d
--- /dev/null
+++ b/reference/svm/svmmodel/getsvmtype.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 317663 $ -->
+
+<refentry xml:id="svmmodel.getsvmtype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SVMModel::getSvmType</refname>
+  <refpurpose>Get the SVM type the model was trained with</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>int</type><methodname>SVMModel::getSvmType</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+    Returns an integer value representing the type of the SVM model used, e.g SVM::C_SVC.
+  </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Return an integer SVM type
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/svm/svmmodel/getsvrprobability.xml b/reference/svm/svmmodel/getsvrprobability.xml
new file mode 100644
index 0000000000..22f17cea0c
--- /dev/null
+++ b/reference/svm/svmmodel/getsvrprobability.xml
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 317663 $ -->
+
+<refentry xml:id="svmmodel.getsvrprobability" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SVMModel::getSvrProbability</refname>
+  <refpurpose>Get the sigma value for regression types</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>float</type><methodname>SVMModel::getSvrProbability</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+    For regression models, returns a sigma value. If there is no probability
+  	information or the model is not SVR, 0 is returned.
+  </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns a sigma value
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/svm/versions.xml b/reference/svm/versions.xml
index f5434d6fb8..b040232e4d 100644
--- a/reference/svm/versions.xml
+++ b/reference/svm/versions.xml
@@ -16,6 +16,11 @@
  <function name='svmmodel::load' from='PECL svm &gt;= 0.1.00.1.0'/>
  <function name='svmmodel::predict' from='PECL svm &gt;= 0.1.0'/>
  <function name='svmmodel::predict_probability' from='PECL svm &gt;= 0.1.4'/>
+ <function name='svmmodel::getlabels' from='PECL svm &gt;= 0.1.5'/>
+ <function name='svmmodel::getnrclass' from='PECL svm &gt;= 0.1.5'/>  
+ <function name='svmmodel::getsvmtype' from='PECL svm &gt;= 0.1.5'/>  
+ <function name='svmmodel::getsvrprobability' from='PECL svm &gt;= 0.1.5'/>   
+ <function name='svmmodel::checkprobabilitymodel' from='PECL svm &gt;= 0.1.5'/>    
  <function name='svmexception::__clone' from='PECL svm &gt;= 0.1.0'/>
  <function name='svmexception::__construct' from='PECL svm &gt;= 0.1.0'/>
  <function name='svmexception::getmessage' from='PECL svm &gt;= 0.1.0'/>