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

<refentry xml:id="function.fann-get-bit-fail-limit" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>fann_get_bit_fail_limit</refname>
  <refpurpose>Returns the bit fail limit used during training</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>float</type><methodname>fann_get_bit_fail_limit</methodname>
   <methodparam><type>resource</type><parameter>ann</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns the bit fail limit used during training.
  </para>
  <para>
   The bit fail limit is used during training where the <link linkend="constants.fann-stopfunc">stop function</link>
   is set to <constant>FANN_STOPFUNC_BIT</constant>.
  </para>
  <para>
   The limit is the maximum accepted difference between the desired output and the actual output during training.
   Each output that diverges more than this limit is counted as an error bit. This difference is divided by two
   when dealing with symmetric activation functions, so that symmetric and not symmetric activation functions
   can use the same limit.
  </para>
  <para>
   The default bit fail limit is 0.35.
  </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 bit fail limit, or &false; on error.
  </para>
 </refsect1>

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