yap-6.3/packages/gecode/dev/extractor/xml/classGecode_1_1RBS.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
  <compounddef id="classGecode_1_1RBS" kind="class" prot="public">
    <compoundname>Gecode::RBS</compoundname>
    <basecompoundref refid="classGecode_1_1EngineBase" prot="public" virt="non-virtual">Gecode::EngineBase</basecompoundref>
    <includes refid="search_8hh" local="no">search.hh</includes>
    <templateparamlist>
      <param>
        <type>template&lt; class &gt; class</type>
        <declname>E</declname>
        <defname>E</defname>
      </param>
      <param>
        <type>class</type>
        <declname>T</declname>
        <defname>T</defname>
      </param>
    </templateparamlist>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classGecode_1_1RBS_1a8c8952903d745be55149a09d2fbdce9a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::RBS&lt; E, T &gt;::RBS</definition>
        <argsstring>(T *s, const Search::Options &amp;o)</argsstring>
        <name>RBS</name>
        <param>
          <type>T *</type>
          <declname>s</declname>
        </param>
        <param>
          <type>const <ref refid="classGecode_1_1Search_1_1Options" kindref="compound">Search::Options</ref> &amp;</type>
          <declname>o</declname>
        </param>
        <briefdescription>
<para>Initialize engine for space <emphasis>s</emphasis> and options <emphasis>o</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/search.hh" line="582" column="1" bodyfile="/usr/include/gecode/search/rbs.hpp" bodystart="52" bodyend="75"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1RBS_1ae3267bde778acd4aaf42d9d9c1a75718" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>T *</type>
        <definition>forceinline T * Gecode::RBS&lt; E, T &gt;::next</definition>
        <argsstring>(void)</argsstring>
        <name>next</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Return next solution (NULL, if non exists or search has been stopped) </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/search.hh" line="584" column="1" bodyfile="/usr/include/gecode/search/rbs.hpp" bodystart="79" bodyend="81"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1RBS_1a68353155f9a5cb615329dea9f3e94575" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classGecode_1_1Search_1_1Statistics" kindref="compound">Search::Statistics</ref></type>
        <definition>forceinline Search::Statistics Gecode::RBS&lt; E, T &gt;::statistics</definition>
        <argsstring>(void) const </argsstring>
        <name>statistics</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Return statistics. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/search.hh" line="586" column="1" bodyfile="/usr/include/gecode/search/rbs.hpp" bodystart="85" bodyend="87"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1RBS_1ae6e8b80a58d1df94f4d6c13c079fe12a" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type>bool</type>
        <definition>forceinline bool Gecode::RBS&lt; E, T &gt;::stopped</definition>
        <argsstring>(void) const </argsstring>
        <name>stopped</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Check whether engine has been stopped. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/search.hh" line="588" column="1" bodyfile="/usr/include/gecode/search/rbs.hpp" bodystart="91" bodyend="93"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Meta-engine performing restart-based search. </para>    </briefdescription>
    <detaileddescription>
<para>The engine uses the Cutoff sequence supplied in the options <emphasis>o</emphasis> to periodically restart the search of engine <emphasis>E</emphasis>.</para><para>The class <emphasis>T</emphasis> can implement member functions <programlisting><codeline><highlight class="keyword">virtual</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>master(</highlight><highlight class="keywordtype">unsigned</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">long</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>i,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>Space*<sp/>s)<sp/></highlight></codeline>
</programlisting> and <programlisting><codeline><highlight class="keyword">virtual</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>slave(</highlight><highlight class="keywordtype">unsigned</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">long</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>i,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>Space*<sp/>s)<sp/></highlight></codeline>
</programlisting></para><para>Whenever exploration restarts or a solution is found, the engine executes the functions on the master and slave space. For more details, consult &quot;Modeling and Programming
with Gecode&quot;. </para>    </detaileddescription>
    <inheritancegraph>
      <node id="5693">
        <label>Gecode::EngineBase</label>
        <link refid="classGecode_1_1EngineBase"/>
      </node>
      <node id="5692">
        <label>Gecode::RBS&lt; E, T &gt;</label>
        <link refid="classGecode_1_1RBS"/>
        <childnode refid="5693" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="5695">
        <label>Gecode::EngineBase</label>
        <link refid="classGecode_1_1EngineBase"/>
        <childnode refid="5696" relation="usage">
          <edgelabel>e</edgelabel>
        </childnode>
      </node>
      <node id="5694">
        <label>Gecode::RBS&lt; E, T &gt;</label>
        <link refid="classGecode_1_1RBS"/>
        <childnode refid="5695" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5696">
        <label>Gecode::Search::Engine</label>
        <link refid="classGecode_1_1Search_1_1Engine"/>
      </node>
    </collaborationgraph>
    <location file="/usr/include/gecode/search.hh" line="236" column="1" bodyfile="/usr/include/gecode/search.hh" bodystart="236" bodyend="-1"/>
    <listofallmembers>
      <member refid="classGecode_1_1EngineBase_1aad42a01412e5ed2623cfeb52c4b09e82" prot="protected" virt="non-virtual"><scope>Gecode::RBS</scope><name>e</name></member>
      <member refid="classGecode_1_1EngineBase_1af4d765d70c5acafc444eaae03bcc658f" prot="protected" virt="non-virtual"><scope>Gecode::RBS</scope><name>EngineBase</name></member>
      <member refid="classGecode_1_1RBS_1ae3267bde778acd4aaf42d9d9c1a75718" prot="public" virt="non-virtual"><scope>Gecode::RBS</scope><name>next</name></member>
      <member refid="classGecode_1_1RBS_1a8c8952903d745be55149a09d2fbdce9a" prot="public" virt="non-virtual"><scope>Gecode::RBS</scope><name>RBS</name></member>
      <member refid="classGecode_1_1RBS_1a68353155f9a5cb615329dea9f3e94575" prot="public" virt="non-virtual"><scope>Gecode::RBS</scope><name>statistics</name></member>
      <member refid="classGecode_1_1RBS_1ae6e8b80a58d1df94f4d6c13c079fe12a" prot="public" virt="non-virtual"><scope>Gecode::RBS</scope><name>stopped</name></member>
      <member refid="classGecode_1_1EngineBase_1a81e38a477373df7e3d2c9afa26443614" prot="protected" virt="non-virtual"><scope>Gecode::RBS</scope><name>~EngineBase</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>