fann-scale-output-train-data.xml

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

<refentry xml:id="function.fann-scale-output-train-data" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>fann_scale_output_train_data</refname>
  <refpurpose>Scales the outputs in the training data to the specified range</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>fann_scale_output_train_data</methodname>
   <methodparam><type>resource</type><parameter>train_data</parameter></methodparam>
   <methodparam><type>float</type><parameter>new_min</parameter></methodparam>
   <methodparam><type>float</type><parameter>new_max</parameter></methodparam>
  </methodsynopsis>
  <para>
   Scales the outputs in the training data to the specified range.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>train_data</parameter></term>
    <listitem>
     &fann.train.description;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>new_min</parameter></term>
    <listitem>
     <para>
      New minimum after scaling outputs in training data.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>new_max</parameter></term>
    <listitem>
     <para>
      New maximum after scaling outputs in training data.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  &fann.return.bool;
 </refsect1>

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