fann-get-training-algorithm.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.fann-get-training-algorithm" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>fann_get_training_algorithm</refname>
  <refpurpose>Returns the training algorithm</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>fann_get_training_algorithm</methodname>
   <methodparam><type>resource</type><parameter>ann</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns the training algorithm. This training algorithm is used by <function>fann_train_on_data</function> and associated functions.
  </para>
  <para>
   Note that this algorithm is also used during <function>fann_cascadetrain_on_data</function>, although only
   <constant>FANN_TRAIN_RPROP</constant> and <constant>FANN_TRAIN_QUICKPROP</constant> is allowed during cascade training.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>ann</parameter></term>
    <listitem>
     &fann.ann.description;
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <link linkend="constants.fann-train">Training algorithm</link> constant, or &false; on error.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fann_set_training_algorithm</function></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
-->