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

<refentry xml:id="function.fann-get-cascade-candidate-change-fraction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>fann_get_cascade_candidate_change_fraction</refname>
  <refpurpose>Returns the cascade candidate change fraction</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>float</type><methodname>fann_get_cascade_candidate_change_fraction</methodname>
   <methodparam><type>resource</type><parameter>ann</parameter></methodparam>
  </methodsynopsis>
  <para>
   The cascade candidate change fraction is a number between 0 and 1 determining how large a fraction the <function>fann_get_MSE</function>
   value should change within <function>fann_get_cascade_candidate_stagnation_epochs</function> during training of the candidate neurons,
   in order for the training not to stagnate. If the training stagnates, the training of the candidate neurons will be ended
   and the best candidate will be selected.
  </para>
  <para>
   It means that if the MSE does not change by a fraction of <function>fann_get_cascade_candidate_change_fraction</function> during
   a period of <function>fann_get_cascade_candidate_stagnation_epochs</function>, the training of the candidate neurons is stopped
   because the training has stagnated.
  </para>
  <para>
   If the cascade candidate change fraction is low, the candidate neurons will be trained more and if the fraction is high they will be trained less.
  </para>
  <para>
   The default cascade candidate change fraction is 0.01, which is equalent to a 1% change in MSE.
  </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>
   The cascade candidate change fraction, or &false; on error.
  </para>
 </refsect1>

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