fann-create-sparse-array.xml

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

<refentry xml:id="function.fann-create-sparse-array" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>fann_create_sparse_array</refname>
  <refpurpose>Creates a standard backpropagation neural network, which is not fully connected using an array of layer sizes</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>fann_create_sparse_array</methodname>
   <methodparam><type>float</type><parameter>connection_rate</parameter></methodparam>
   <methodparam><type>int</type><parameter>num_layers</parameter></methodparam>
   <methodparam><type>array</type><parameter>layers</parameter></methodparam>
  </methodsynopsis>
  <para>
   Creates a standard backpropagation neural network, which is not fully connected using an array of layer sizes.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>connection_rate</parameter></term>
    <listitem>
     <para>
      The connection rate controls how many connections there will be in the network. If the connection rate
      is set to 1, the network will be fully connected, but if it is set to 0.5 only half of the connections
      will be set. A connection rate of 1 will yield the same result as <function>fann_create_standard</function>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>num_layers</parameter></term>
    <listitem>
     <para>
      The total number of layers including the input and the output layer.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>layers</parameter></term>
    <listitem>
     <para>
       An array of layer sizes.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a neural network resource on success, or &false; on error.
  </para>
 </refsect1>

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