yap-6.3/packages/gecode/dev/extractor/xml/classGecode_1_1ViewSelRnd.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_1ViewSelRnd" kind="class" prot="public">
    <compoundname>Gecode::ViewSelRnd</compoundname>
    <basecompoundref refid="classGecode_1_1ViewSel" prot="public" virt="non-virtual">Gecode::ViewSel&lt; View &gt;</basecompoundref>
    <includes refid="brancher-view-sel_8hpp" local="no">brancher-view-sel.hpp</includes>
    <templateparamlist>
      <param>
        <type>class</type>
        <declname>View</declname>
        <defname>View</defname>
      </param>
    </templateparamlist>
      <sectiondef kind="user-defined">
      <header>Initialization</header>
      <memberdef kind="function" id="classGecode_1_1ViewSelRnd_1a2554224881b80ae7a05a72ee0856324c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::ViewSelRnd&lt; View &gt;::ViewSelRnd</definition>
        <argsstring>(Space &amp;home, const VarBranch &amp;vb)</argsstring>
        <name>ViewSelRnd</name>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type>const <ref refid="classGecode_1_1VarBranch" kindref="compound">VarBranch</ref> &amp;</type>
          <declname>vb</declname>
        </param>
        <briefdescription>
<para>Constructor for creation. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="151" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="448" bodyend="449"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ViewSelRnd_1a46a5de272eb8840efd63b0e706be4f97" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::ViewSelRnd&lt; View &gt;::ViewSelRnd</definition>
        <argsstring>(Space &amp;home, bool shared, ViewSelRnd&lt; View &gt; &amp;vs)</argsstring>
        <name>ViewSelRnd</name>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type>bool</type>
          <declname>shared</declname>
        </param>
        <param>
          <type><ref refid="classGecode_1_1ViewSelRnd" kindref="compound">ViewSelRnd</ref>&lt; <ref refid="classGecode_1_1ViewSel_1a0eb9229cfcbb6ee09a155263d9de256d" kindref="member">View</ref> &gt; &amp;</type>
          <declname>vs</declname>
        </param>
        <briefdescription>
<para>Constructor for copying during cloning. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="153" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="452" bodyend="453"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="user-defined">
      <header>View selection and tie breaking</header>
      <memberdef kind="function" id="classGecode_1_1ViewSelRnd_1afaea52c72de4fbd3886be8c1e5fc550f" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>int Gecode::ViewSelRnd&lt; View &gt;::select</definition>
        <argsstring>(Space &amp;home, ViewArray&lt; View &gt; &amp;x, int s)</argsstring>
        <name>select</name>
        <reimplements refid="classGecode_1_1ViewSel_1abed47f1213c16665446f77deb49575d0">select</reimplements>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type><ref refid="classGecode_1_1ViewArray" kindref="compound">ViewArray</ref>&lt; <ref refid="classGecode_1_1ViewSel_1a0eb9229cfcbb6ee09a155263d9de256d" kindref="member">View</ref> &gt; &amp;</type>
          <declname>x</declname>
        </param>
        <param>
          <type>int</type>
          <declname>s</declname>
        </param>
        <briefdescription>
<para>Select a view from <emphasis>x</emphasis> starting from <emphasis>s</emphasis> and return its position. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="158" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="456" bodyend="466"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ViewSelRnd_1a7a9608049e7c64108cca72ebd53a1f6d" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>int Gecode::ViewSelRnd&lt; View &gt;::select</definition>
        <argsstring>(Space &amp;home, ViewArray&lt; View &gt; &amp;x, int s, BranchFilter bf)</argsstring>
        <name>select</name>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type><ref refid="classGecode_1_1ViewArray" kindref="compound">ViewArray</ref>&lt; <ref refid="classGecode_1_1ViewSel_1a0eb9229cfcbb6ee09a155263d9de256d" kindref="member">View</ref> &gt; &amp;</type>
          <declname>x</declname>
        </param>
        <param>
          <type>int</type>
          <declname>s</declname>
        </param>
        <param>
          <type>BranchFilter</type>
          <declname>bf</declname>
        </param>
        <briefdescription>
<para>Select a view from <emphasis>x</emphasis> starting from <emphasis>s</emphasis> and return its position. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="160" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="468" bodyend="481"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ViewSelRnd_1a01ceb70d96b212ad8af26974332916b0" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void Gecode::ViewSelRnd&lt; View &gt;::ties</definition>
        <argsstring>(Space &amp;home, ViewArray&lt; View &gt; &amp;x, int s, int *ties, int &amp;n)</argsstring>
        <name>ties</name>
        <reimplements refid="classGecode_1_1ViewSel_1a0ed58be60b51512bf3b7d4c1d18fad46">ties</reimplements>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type><ref refid="classGecode_1_1ViewArray" kindref="compound">ViewArray</ref>&lt; <ref refid="classGecode_1_1ViewSel_1a0eb9229cfcbb6ee09a155263d9de256d" kindref="member">View</ref> &gt; &amp;</type>
          <declname>x</declname>
        </param>
        <param>
          <type>int</type>
          <declname>s</declname>
        </param>
        <param>
          <type>int *</type>
          <declname>ties</declname>
        </param>
        <param>
          <type>int &amp;</type>
          <declname>n</declname>
        </param>
        <briefdescription>
<para>Select ties from <emphasis>x</emphasis> starting from <emphasis>s</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="163" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="484" bodyend="487"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ViewSelRnd_1a6e6423c1fbe47ad61ad87ad1209699bb" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void Gecode::ViewSelRnd&lt; View &gt;::ties</definition>
        <argsstring>(Space &amp;home, ViewArray&lt; View &gt; &amp;x, int s, int *ties, int &amp;n, BranchFilter bf)</argsstring>
        <name>ties</name>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type><ref refid="classGecode_1_1ViewArray" kindref="compound">ViewArray</ref>&lt; <ref refid="classGecode_1_1ViewSel_1a0eb9229cfcbb6ee09a155263d9de256d" kindref="member">View</ref> &gt; &amp;</type>
          <declname>x</declname>
        </param>
        <param>
          <type>int</type>
          <declname>s</declname>
        </param>
        <param>
          <type>int *</type>
          <declname>ties</declname>
        </param>
        <param>
          <type>int &amp;</type>
          <declname>n</declname>
        </param>
        <param>
          <type>BranchFilter</type>
          <declname>bf</declname>
        </param>
        <briefdescription>
<para>Select ties from <emphasis>x</emphasis> starting from <emphasis>s</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="166" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="490" bodyend="493"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ViewSelRnd_1afd5abf714d7d77f6882f3ca6f0da364b" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void Gecode::ViewSelRnd&lt; View &gt;::brk</definition>
        <argsstring>(Space &amp;home, ViewArray&lt; View &gt; &amp;x, int *ties, int &amp;n)</argsstring>
        <name>brk</name>
        <reimplements refid="classGecode_1_1ViewSel_1a38990319b929ca41003103251fd8125b">brk</reimplements>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type><ref refid="classGecode_1_1ViewArray" kindref="compound">ViewArray</ref>&lt; <ref refid="classGecode_1_1ViewSel_1a0eb9229cfcbb6ee09a155263d9de256d" kindref="member">View</ref> &gt; &amp;</type>
          <declname>x</declname>
        </param>
        <param>
          <type>int *</type>
          <declname>ties</declname>
        </param>
        <param>
          <type>int &amp;</type>
          <declname>n</declname>
        </param>
        <briefdescription>
<para>Break ties in <emphasis>x</emphasis> and update to new ties. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="169" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="496" bodyend="499"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ViewSelRnd_1ae35f82547d5dca9d9281b2bdae2fe0ef" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>int Gecode::ViewSelRnd&lt; View &gt;::select</definition>
        <argsstring>(Space &amp;home, ViewArray&lt; View &gt; &amp;x, int *ties, int n)</argsstring>
        <name>select</name>
        <reimplements refid="classGecode_1_1ViewSel_1ac72786dfdedd8fa2bd1731087cec7c46">select</reimplements>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type><ref refid="classGecode_1_1ViewArray" kindref="compound">ViewArray</ref>&lt; <ref refid="classGecode_1_1ViewSel_1a0eb9229cfcbb6ee09a155263d9de256d" kindref="member">View</ref> &gt; &amp;</type>
          <declname>x</declname>
        </param>
        <param>
          <type>int *</type>
          <declname>ties</declname>
        </param>
        <param>
          <type>int</type>
          <declname>n</declname>
        </param>
        <briefdescription>
<para>Select a view from <emphasis>x</emphasis> considering view with positions in <emphasis>ties</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="171" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="502" bodyend="504"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="user-defined">
      <header>Resource management and cloning</header>
      <memberdef kind="function" id="classGecode_1_1ViewSelRnd_1aa33bd9bfa14220e3b4a45a5423bc6e2c" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type><ref refid="classGecode_1_1ViewSel" kindref="compound">ViewSel</ref>&lt; <ref refid="classGecode_1_1ViewSel_1a0eb9229cfcbb6ee09a155263d9de256d" kindref="member">View</ref> &gt; *</type>
        <definition>ViewSel&lt; View &gt; * Gecode::ViewSelRnd&lt; View &gt;::copy</definition>
        <argsstring>(Space &amp;home, bool shared)</argsstring>
        <name>copy</name>
        <reimplements refid="classGecode_1_1ViewSel_1a67747297fd08692609d43b1970a9e616">copy</reimplements>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type>bool</type>
          <declname>shared</declname>
        </param>
        <briefdescription>
<para>Create copy during cloning. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="176" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="507" bodyend="509"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-type">
      <memberdef kind="typedef" id="classGecode_1_1ViewSelRnd_1a5068e5302cb0c195da1eff98ddc307f6" prot="private" static="no">
        <type><ref refid="classGecode_1_1ViewSel" kindref="compound">ViewSel</ref>&lt; <ref refid="classGecode_1_1ViewSel_1a0eb9229cfcbb6ee09a155263d9de256d" kindref="member">View</ref> &gt;::BranchFilter</type>
        <definition>typedef ViewSel&lt;View&gt;::BranchFilter Gecode::ViewSelRnd&lt; View &gt;::BranchFilter</definition>
        <argsstring></argsstring>
        <name>BranchFilter</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="143" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="143" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classGecode_1_1ViewSelRnd_1a1fce99c8e9b6595a6344ee24e8cf245f" prot="protected" static="no" mutable="no">
        <type><ref refid="classGecode_1_1Rnd" kindref="compound">Rnd</ref></type>
        <definition>Rnd Gecode::ViewSelRnd&lt; View &gt;::r</definition>
        <argsstring></argsstring>
        <name>r</name>
        <briefdescription>
<para>The random number generator used. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="146" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="146" bodyend="-1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Select a view randomly. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="7971">
        <label>Gecode::ViewSelRnd&lt; View &gt;</label>
        <link refid="classGecode_1_1ViewSelRnd"/>
        <childnode refid="7972" relation="public-inheritance">
        </childnode>
      </node>
      <node id="7972">
        <label>Gecode::ViewSel&lt; View &gt;</label>
        <link refid="classGecode_1_1ViewSel"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="7973">
        <label>Gecode::ViewSelRnd&lt; View &gt;</label>
        <link refid="classGecode_1_1ViewSelRnd"/>
        <childnode refid="7974" relation="public-inheritance">
        </childnode>
        <childnode refid="7975" relation="usage">
          <edgelabel>r</edgelabel>
        </childnode>
      </node>
      <node id="7975">
        <label>Gecode::Rnd</label>
        <link refid="classGecode_1_1Rnd"/>
        <childnode refid="7976" relation="public-inheritance">
        </childnode>
      </node>
      <node id="7974">
        <label>Gecode::ViewSel&lt; View &gt;</label>
        <link refid="classGecode_1_1ViewSel"/>
      </node>
      <node id="7976">
        <label>Gecode::SharedHandle</label>
        <link refid="classGecode_1_1SharedHandle"/>
      </node>
    </collaborationgraph>
    <location file="/usr/include/gecode/kernel/brancher-view-sel.hpp" line="142" column="1" bodyfile="/usr/include/gecode/kernel/brancher-view-sel.hpp" bodystart="142" bodyend="178"/>
    <listofallmembers>
      <member refid="classGecode_1_1ViewSelRnd_1a5068e5302cb0c195da1eff98ddc307f6" prot="private" virt="non-virtual"><scope>Gecode::ViewSelRnd</scope><name>BranchFilter</name></member>
      <member refid="classGecode_1_1ViewSelRnd_1afd5abf714d7d77f6882f3ca6f0da364b" prot="public" virt="virtual"><scope>Gecode::ViewSelRnd</scope><name>brk</name></member>
      <member refid="classGecode_1_1ViewSelRnd_1aa33bd9bfa14220e3b4a45a5423bc6e2c" prot="public" virt="virtual"><scope>Gecode::ViewSelRnd</scope><name>copy</name></member>
      <member refid="classGecode_1_1ViewSel_1a6e95fa0da4f0a75340943adaa3715e63" prot="public" virt="virtual"><scope>Gecode::ViewSelRnd</scope><name>dispose</name></member>
      <member refid="classGecode_1_1ViewSel_1ad8f324b8b4de58dde702b45940c5f062" prot="public" virt="virtual"><scope>Gecode::ViewSelRnd</scope><name>notice</name></member>
      <member refid="classGecode_1_1ViewSel_1a69d8f83ed5f3a52160524060ccb7b834" prot="public" virt="non-virtual"><scope>Gecode::ViewSelRnd</scope><name>operator delete</name></member>
      <member refid="classGecode_1_1ViewSel_1ad332dc2aa6584a404d832715598a0ecd" prot="public" virt="non-virtual"><scope>Gecode::ViewSelRnd</scope><name>operator delete</name></member>
      <member refid="classGecode_1_1ViewSel_1ac843be459641c947da1acb3d8a1b635f" prot="public" virt="non-virtual"><scope>Gecode::ViewSelRnd</scope><name>operator new</name></member>
      <member refid="classGecode_1_1ViewSelRnd_1a1fce99c8e9b6595a6344ee24e8cf245f" prot="protected" virt="non-virtual"><scope>Gecode::ViewSelRnd</scope><name>r</name></member>
      <member refid="classGecode_1_1ViewSelRnd_1afaea52c72de4fbd3886be8c1e5fc550f" prot="public" virt="virtual"><scope>Gecode::ViewSelRnd</scope><name>select</name></member>
      <member refid="classGecode_1_1ViewSelRnd_1a7a9608049e7c64108cca72ebd53a1f6d" prot="public" virt="virtual"><scope>Gecode::ViewSelRnd</scope><name>select</name></member>
      <member refid="classGecode_1_1ViewSelRnd_1ae35f82547d5dca9d9281b2bdae2fe0ef" prot="public" virt="virtual"><scope>Gecode::ViewSelRnd</scope><name>select</name></member>
      <member refid="classGecode_1_1ViewSel_1a7096e0882df6806c28599f65fe2c47f7" prot="public" virt="pure-virtual" ambiguityscope="ViewSel&lt; View &gt;::"><scope>Gecode::ViewSelRnd</scope><name>select</name></member>
      <member refid="classGecode_1_1ViewSelRnd_1a01ceb70d96b212ad8af26974332916b0" prot="public" virt="virtual"><scope>Gecode::ViewSelRnd</scope><name>ties</name></member>
      <member refid="classGecode_1_1ViewSelRnd_1a6e6423c1fbe47ad61ad87ad1209699bb" prot="public" virt="virtual"><scope>Gecode::ViewSelRnd</scope><name>ties</name></member>
      <member refid="classGecode_1_1ViewSel_1a8b483d5643152a39e67aeaf7df733f81" prot="public" virt="pure-virtual" ambiguityscope="ViewSel&lt; View &gt;::"><scope>Gecode::ViewSelRnd</scope><name>ties</name></member>
      <member refid="classGecode_1_1ViewSel_1a0eb9229cfcbb6ee09a155263d9de256d" prot="public" virt="non-virtual"><scope>Gecode::ViewSelRnd</scope><name>View</name></member>
      <member refid="classGecode_1_1ViewSel_1a5e6312d9ebe2a24d73cef47eab9866be" prot="public" virt="non-virtual"><scope>Gecode::ViewSelRnd</scope><name>ViewSel</name></member>
      <member refid="classGecode_1_1ViewSel_1a5459dc8a5f1a0d606819e334d384e2bc" prot="public" virt="non-virtual"><scope>Gecode::ViewSelRnd</scope><name>ViewSel</name></member>
      <member refid="classGecode_1_1ViewSelRnd_1a2554224881b80ae7a05a72ee0856324c" prot="public" virt="non-virtual"><scope>Gecode::ViewSelRnd</scope><name>ViewSelRnd</name></member>
      <member refid="classGecode_1_1ViewSelRnd_1a46a5de272eb8840efd63b0e706be4f97" prot="public" virt="non-virtual"><scope>Gecode::ViewSelRnd</scope><name>ViewSelRnd</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>