yap-6.3/packages/gecode/dev/extractor/xml/classGecode_1_1ValSelCommit.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_1ValSelCommit" kind="class" prot="public">
    <compoundname>Gecode::ValSelCommit</compoundname>
    <basecompoundref refid="classGecode_1_1ValSelCommitBase" prot="public" virt="non-virtual">Gecode::ValSelCommitBase&lt; ValSel::View, ValSel::Val &gt;</basecompoundref>
    <includes refid="brancher-val-sel-commit_8hpp" local="no">brancher-val-sel-commit.hpp</includes>
    <templateparamlist>
      <param>
        <type>class</type>
        <declname>ValSel</declname>
        <defname>ValSel</defname>
      </param>
      <param>
        <type>class</type>
        <declname>ValCommit</declname>
        <defname>ValCommit</defname>
      </param>
    </templateparamlist>
      <sectiondef kind="protected-type">
      <memberdef kind="typedef" id="classGecode_1_1ValSelCommit_1a19316d237bd2b31fe50fb3fbaccb917f" prot="protected" static="no">
        <type><ref refid="classGecode_1_1ValSelCommitBase" kindref="compound">ValSelCommitBase</ref>&lt; typename <ref refid="classGecode_1_1ValSel_1a505b0292df0aa0f8ec84940c6d99973d" kindref="member">ValSel::View</ref>, typename <ref refid="classGecode_1_1ValSel_1a1ab3056f51deae75a156bc1fa7d1b993" kindref="member">ValSel::Val</ref> &gt;::Val</type>
        <definition>typedef ValSelCommitBase&lt;typename ValSel::View, typename ValSel::Val&gt;::Val Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::Val</definition>
        <argsstring></argsstring>
        <name>Val</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="95" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="95" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="classGecode_1_1ValSelCommit_1a85452559133c4d571e13aaa71933618e" prot="protected" static="no">
        <type><ref refid="classGecode_1_1ValSelCommitBase" kindref="compound">ValSelCommitBase</ref>&lt; typename <ref refid="classGecode_1_1ValSel_1a505b0292df0aa0f8ec84940c6d99973d" kindref="member">ValSel::View</ref>, typename <ref refid="classGecode_1_1ValSel_1a1ab3056f51deae75a156bc1fa7d1b993" kindref="member">ValSel::Val</ref> &gt;::View</type>
        <definition>typedef ValSelCommitBase&lt;typename ValSel::View, typename ValSel::Val&gt;::View Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::View</definition>
        <argsstring></argsstring>
        <name>View</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="97" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="97" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classGecode_1_1ValSelCommit_1a4576358c91622677d2824cec299e3d8b" prot="protected" static="no" mutable="no">
        <type><ref refid="classGecode_1_1ValSel" kindref="compound">ValSel</ref></type>
        <definition>ValSel Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::s</definition>
        <argsstring></argsstring>
        <name>s</name>
        <briefdescription>
<para>The value selection object used. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="99" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="99" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classGecode_1_1ValSelCommit_1a41cf21f0fa21ec80f28fd94a0f09ad27" prot="protected" static="no" mutable="no">
        <type><ref refid="classGecode_1_1ValCommit" kindref="compound">ValCommit</ref></type>
        <definition>ValCommit Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::c</definition>
        <argsstring></argsstring>
        <name>c</name>
        <briefdescription>
<para>The commit object used. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="101" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="101" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classGecode_1_1ValSelCommit_1add6ce08783cb7cf259f2deea45ef4e15" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::ValSelCommit</definition>
        <argsstring>(Space &amp;home, const ValBranch &amp;vb)</argsstring>
        <name>ValSelCommit</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_1ValBranch" kindref="compound">ValBranch</ref> &amp;</type>
          <declname>vb</declname>
        </param>
        <briefdescription>
<para>Constructor for initialization. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="104" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="154" bodyend="156"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ValSelCommit_1a1696cad131e573147b35d5a9d21025a9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::ValSelCommit</definition>
        <argsstring>(Space &amp;home, bool shared, ValSelCommit&lt; ValSel, ValCommit &gt; &amp;vsc)</argsstring>
        <name>ValSelCommit</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_1ValSelCommit" kindref="compound">ValSelCommit</ref>&lt; <ref refid="classGecode_1_1ValSel" kindref="compound">ValSel</ref>, <ref refid="classGecode_1_1ValCommit" kindref="compound">ValCommit</ref> &gt; &amp;</type>
          <declname>vsc</declname>
        </param>
        <briefdescription>
<para>Constructor for cloning. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="106" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="160" bodyend="163"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ValSelCommit_1a9c6f3f7679c37ab4d87d1bc39645142b" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>Val</type>
        <definition>ValSelCommit&lt; ValSel, ValCommit &gt;::Val Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::val</definition>
        <argsstring>(const Space &amp;home, View x, int i)</argsstring>
        <name>val</name>
        <reimplements refid="classGecode_1_1ValSelCommitBase_1a60c87b6c54ca414f93cef96cab5910f3">val</reimplements>
        <param>
          <type>const <ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type>View</type>
          <declname>x</declname>
        </param>
        <param>
          <type>int</type>
          <declname>i</declname>
        </param>
        <briefdescription>
<para>Return value of view <emphasis>x</emphasis> at position <emphasis>i</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="109" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="167" bodyend="169"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ValSelCommit_1aaa88da2b45021b8c8889774c1219ee72" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type><ref refid="group__TaskVarMEPC_1gafa985ae465bd12df08e29252cdb7519b" kindref="member">ModEvent</ref></type>
        <definition>ModEvent Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::commit</definition>
        <argsstring>(Space &amp;home, unsigned int a, View x, int i, Val n)</argsstring>
        <name>commit</name>
        <reimplements refid="classGecode_1_1ValSelCommitBase_1a07da4a911e5ea1512ce13eaa174e9466">commit</reimplements>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type>unsigned int</type>
          <declname>a</declname>
        </param>
        <param>
          <type>View</type>
          <declname>x</declname>
        </param>
        <param>
          <type>int</type>
          <declname>i</declname>
        </param>
        <param>
          <type>Val</type>
          <declname>n</declname>
        </param>
        <briefdescription>
<para>Commit view <emphasis>x</emphasis> at position <emphasis>i</emphasis> to value <emphasis>n</emphasis> for alternative <emphasis>a</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="111" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="173" bodyend="176"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ValSelCommit_1a8e16673cd1d2e4a60056579da900a6c6" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type><ref refid="classGecode_1_1NGL" kindref="compound">NGL</ref> *</type>
        <definition>NGL * Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::ngl</definition>
        <argsstring>(Space &amp;home, unsigned int a, View x, Val n) const </argsstring>
        <name>ngl</name>
        <reimplements refid="classGecode_1_1ValSelCommitBase_1a39c438b0d8f03ce3ad0058d15b909d36">ngl</reimplements>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type>unsigned int</type>
          <declname>a</declname>
        </param>
        <param>
          <type>View</type>
          <declname>x</declname>
        </param>
        <param>
          <type>Val</type>
          <declname>n</declname>
        </param>
        <briefdescription>
<para>Create no-good literal for choice <emphasis>c</emphasis> and alternative <emphasis>a</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="113" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="180" bodyend="183"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ValSelCommit_1a45adf5057b3a8e523f785cc675559772" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::print</definition>
        <argsstring>(const Space &amp;home, unsigned int a, View x, int i, const Val &amp;n, std::ostream &amp;o) const </argsstring>
        <name>print</name>
        <reimplements refid="classGecode_1_1ValSelCommitBase_1a94cfc929da76a464e4a98251720eb007">print</reimplements>
        <param>
          <type>const <ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type>unsigned int</type>
          <declname>a</declname>
        </param>
        <param>
          <type>View</type>
          <declname>x</declname>
        </param>
        <param>
          <type>int</type>
          <declname>i</declname>
        </param>
        <param>
          <type>const Val &amp;</type>
          <declname>n</declname>
        </param>
        <param>
          <type>std::ostream &amp;</type>
          <declname>o</declname>
        </param>
        <briefdescription>
<para>Print on <emphasis>o</emphasis> branch for alternative <emphasis>a</emphasis>, view <emphasis>x</emphasis> at position <emphasis>i</emphasis>, and value <emphasis>n</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="116" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="187" bodyend="191"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ValSelCommit_1a14a40b3b2acc04506a4af17a865bfc2c" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type><ref refid="classGecode_1_1ValSelCommit" kindref="compound">ValSelCommit</ref>&lt; <ref refid="classGecode_1_1ValSel" kindref="compound">ValSel</ref>, <ref refid="classGecode_1_1ValCommit" kindref="compound">ValCommit</ref> &gt; *</type>
        <definition>ValSelCommit&lt; ValSel, ValCommit &gt; * Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::copy</definition>
        <argsstring>(Space &amp;home, bool shared)</argsstring>
        <name>copy</name>
        <reimplements refid="classGecode_1_1ValSelCommitBase_1aacf724ce06eb5fdbf07c89b6f898268f">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>Perform cloning. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="120" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="195" bodyend="197"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ValSelCommit_1ade55ceb17f72120c27ca1730f728f471" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>bool</type>
        <definition>bool Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::notice</definition>
        <argsstring>(void) const </argsstring>
        <name>notice</name>
        <reimplements refid="classGecode_1_1ValSelCommitBase_1aabb0896e9be1dd51b09c86e7fb7a5634">notice</reimplements>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Whether dispose must always be called (that is, notice is needed) </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="122" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="201" bodyend="203"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ValSelCommit_1adcfde640fb7366091d76cffbdb86af69" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;::dispose</definition>
        <argsstring>(Space &amp;home)</argsstring>
        <name>dispose</name>
        <reimplements refid="classGecode_1_1ValSelCommitBase_1a933ce7d2e4cb215482da500c82d8da41">dispose</reimplements>
        <param>
          <type><ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <briefdescription>
<para>Delete value selection. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="124" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="207" bodyend="210"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Class for value selection and commit. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="7462">
        <label>Gecode::ValSelCommitBase&lt; ValSel::View, ValSel::Val &gt;</label>
        <link refid="classGecode_1_1ValSelCommitBase"/>
      </node>
      <node id="7461">
        <label>Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;</label>
        <link refid="classGecode_1_1ValSelCommit"/>
        <childnode refid="7462" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="7465">
        <label>Gecode::ValCommit&lt; _View, _Val &gt;</label>
        <link refid="classGecode_1_1ValCommit"/>
      </node>
      <node id="7464">
        <label>Gecode::ValSelCommitBase&lt; ValSel::View, ValSel::Val &gt;</label>
        <link refid="classGecode_1_1ValSelCommitBase"/>
      </node>
      <node id="7466">
        <label>Gecode::ValSel&lt; _View, _Val &gt;</label>
        <link refid="classGecode_1_1ValSel"/>
      </node>
      <node id="7463">
        <label>Gecode::ValSelCommit&lt; ValSel, ValCommit &gt;</label>
        <link refid="classGecode_1_1ValSelCommit"/>
        <childnode refid="7464" relation="public-inheritance">
        </childnode>
        <childnode refid="7465" relation="usage">
          <edgelabel>c</edgelabel>
        </childnode>
        <childnode refid="7466" relation="usage">
          <edgelabel>s</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" line="92" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel-commit.hpp" bodystart="91" bodyend="125"/>
    <listofallmembers>
      <member refid="classGecode_1_1ValSelCommit_1a41cf21f0fa21ec80f28fd94a0f09ad27" prot="protected" virt="non-virtual"><scope>Gecode::ValSelCommit</scope><name>c</name></member>
      <member refid="classGecode_1_1ValSelCommit_1aaa88da2b45021b8c8889774c1219ee72" prot="public" virt="virtual"><scope>Gecode::ValSelCommit</scope><name>commit</name></member>
      <member refid="classGecode_1_1ValSelCommit_1a14a40b3b2acc04506a4af17a865bfc2c" prot="public" virt="virtual"><scope>Gecode::ValSelCommit</scope><name>copy</name></member>
      <member refid="classGecode_1_1ValSelCommit_1adcfde640fb7366091d76cffbdb86af69" prot="public" virt="virtual"><scope>Gecode::ValSelCommit</scope><name>dispose</name></member>
      <member refid="classGecode_1_1ValSelCommit_1a8e16673cd1d2e4a60056579da900a6c6" prot="public" virt="virtual"><scope>Gecode::ValSelCommit</scope><name>ngl</name></member>
      <member refid="classGecode_1_1ValSelCommit_1ade55ceb17f72120c27ca1730f728f471" prot="public" virt="virtual"><scope>Gecode::ValSelCommit</scope><name>notice</name></member>
      <member refid="classGecode_1_1ValSelCommitBase_1a9aa565913196d07a049954045650f083" prot="public" virt="non-virtual"><scope>Gecode::ValSelCommit</scope><name>operator delete</name></member>
      <member refid="classGecode_1_1ValSelCommitBase_1a05ac49867bde8d48fc2acc82a3690315" prot="public" virt="non-virtual"><scope>Gecode::ValSelCommit</scope><name>operator delete</name></member>
      <member refid="classGecode_1_1ValSelCommitBase_1a0ee14246336933185a961486b0ee0069" prot="public" virt="non-virtual"><scope>Gecode::ValSelCommit</scope><name>operator new</name></member>
      <member refid="classGecode_1_1ValSelCommit_1a45adf5057b3a8e523f785cc675559772" prot="public" virt="virtual"><scope>Gecode::ValSelCommit</scope><name>print</name></member>
      <member refid="classGecode_1_1ValSelCommit_1a4576358c91622677d2824cec299e3d8b" prot="protected" virt="non-virtual"><scope>Gecode::ValSelCommit</scope><name>s</name></member>
      <member refid="classGecode_1_1ValSelCommit_1a9c6f3f7679c37ab4d87d1bc39645142b" prot="public" virt="virtual"><scope>Gecode::ValSelCommit</scope><name>val</name></member>
      <member refid="classGecode_1_1ValSelCommit_1a19316d237bd2b31fe50fb3fbaccb917f" prot="protected" virt="non-virtual"><scope>Gecode::ValSelCommit</scope><name>Val</name></member>
      <member refid="classGecode_1_1ValSelCommit_1add6ce08783cb7cf259f2deea45ef4e15" prot="public" virt="non-virtual"><scope>Gecode::ValSelCommit</scope><name>ValSelCommit</name></member>
      <member refid="classGecode_1_1ValSelCommit_1a1696cad131e573147b35d5a9d21025a9" prot="public" virt="non-virtual"><scope>Gecode::ValSelCommit</scope><name>ValSelCommit</name></member>
      <member refid="classGecode_1_1ValSelCommitBase_1a358581edaeef98017ed1f5c84dd7f878" prot="public" virt="non-virtual"><scope>Gecode::ValSelCommit</scope><name>ValSelCommitBase</name></member>
      <member refid="classGecode_1_1ValSelCommitBase_1ab8306d78f1b033a58a49d21267bcf8da" prot="public" virt="non-virtual"><scope>Gecode::ValSelCommit</scope><name>ValSelCommitBase</name></member>
      <member refid="classGecode_1_1ValSelCommit_1a85452559133c4d571e13aaa71933618e" prot="protected" virt="non-virtual"><scope>Gecode::ValSelCommit</scope><name>View</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>