yap-6.3/packages/gecode/dev/extractor/xml/classGecode_1_1ValSelFunction.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_1ValSelFunction" kind="class" prot="public">
    <compoundname>Gecode::ValSelFunction</compoundname>
    <basecompoundref refid="classGecode_1_1ValSel" prot="public" virt="non-virtual">Gecode::ValSel&lt; View, BranchTraits&lt; View::VarType &gt;::ValType &gt;</basecompoundref>
    <includes refid="brancher-val-sel_8hpp" local="no">brancher-val-sel.hpp</includes>
    <templateparamlist>
      <param>
        <type>class</type>
        <declname>View</declname>
        <defname>View</defname>
      </param>
    </templateparamlist>
      <sectiondef kind="public-type">
      <memberdef kind="typedef" id="classGecode_1_1ValSelFunction_1a1c57a4ef183355b82607d4c575c34df8" prot="public" static="no">
        <type><ref refid="classGecode_1_1ValSel" kindref="compound">ValSel</ref>&lt; <ref refid="classGecode_1_1ValSel_1a505b0292df0aa0f8ec84940c6d99973d" kindref="member">View</ref>, typename <ref refid="classGecode_1_1BranchTraits" kindref="compound">BranchTraits</ref>&lt; typename View::VarType &gt;::ValType &gt;::<ref refid="classGecode_1_1ValSelFunction_1a1c57a4ef183355b82607d4c575c34df8" kindref="member">Val</ref></type>
        <definition>typedef ValSel&lt;View, typename BranchTraits&lt;typename View::VarType&gt;::ValType&gt;::Val Gecode::ValSelFunction&lt; View &gt;::Val</definition>
        <argsstring></argsstring>
        <name>Val</name>
        <briefdescription>
<para>The corresponding value type. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel.hpp" line="74" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel.hpp" bodystart="74" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="classGecode_1_1ValSelFunction_1ad08c0683fd319d1c312ce12a31870d54" prot="public" static="no">
        <type>View::VarType</type>
        <definition>typedef View::VarType Gecode::ValSelFunction&lt; View &gt;::Var</definition>
        <argsstring></argsstring>
        <name>Var</name>
        <briefdescription>
<para>The corresponding variable type. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel.hpp" line="76" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel.hpp" bodystart="76" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="classGecode_1_1ValSelFunction_1a23fd285075eedee9493f084db8747e24" prot="public" static="no">
        <type><ref refid="classGecode_1_1BranchTraits" kindref="compound">BranchTraits</ref>&lt; <ref refid="classGecode_1_1ValSelFunction_1ad08c0683fd319d1c312ce12a31870d54" kindref="member">Var</ref> &gt;::<ref refid="classGecode_1_1ValSelFunction_1a1c57a4ef183355b82607d4c575c34df8" kindref="member">Val</ref></type>
        <definition>typedef BranchTraits&lt;Var&gt;::Val Gecode::ValSelFunction&lt; View &gt;::ValFunction</definition>
        <argsstring></argsstring>
        <name>ValFunction</name>
        <briefdescription>
<para>The corresponding value function. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel.hpp" line="78" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel.hpp" bodystart="78" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classGecode_1_1ValSelFunction_1ae5102d5825036ff3b1a3033c9f797380" prot="protected" static="no" mutable="no">
        <type><ref refid="classGecode_1_1ValSelFunction_1a23fd285075eedee9493f084db8747e24" kindref="member">ValFunction</ref></type>
        <definition>ValFunction Gecode::ValSelFunction&lt; View &gt;::v</definition>
        <argsstring></argsstring>
        <name>v</name>
        <briefdescription>
<para>The user-defined value function. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel.hpp" line="81" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel.hpp" bodystart="81" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classGecode_1_1ValSelFunction_1a2049fad7e2d42b2cfcb03917a17ee131" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::ValSelFunction&lt; View &gt;::ValSelFunction</definition>
        <argsstring>(Space &amp;home, const ValBranch &amp;vb)</argsstring>
        <name>ValSelFunction</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.hpp" line="84" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel.hpp" bodystart="113" bodyend="115"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ValSelFunction_1a3b74921e79c6d299a0781ce1400648bc" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forceinline Gecode::ValSelFunction&lt; View &gt;::ValSelFunction</definition>
        <argsstring>(Space &amp;home, bool shared, ValSelFunction&lt; View &gt; &amp;vs)</argsstring>
        <name>ValSelFunction</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_1ValSelFunction" kindref="compound">ValSelFunction</ref>&lt; <ref refid="classGecode_1_1ValSel_1a505b0292df0aa0f8ec84940c6d99973d" kindref="member">View</ref> &gt; &amp;</type>
          <declname>vs</declname>
        </param>
        <briefdescription>
<para>Constructor for cloning. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/kernel/brancher-val-sel.hpp" line="86" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel.hpp" bodystart="118" bodyend="120"/>
      </memberdef>
      <memberdef kind="function" id="classGecode_1_1ValSelFunction_1a989dd4c69b809ecad7926d2f6745ce06" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classGecode_1_1ValSelFunction_1a1c57a4ef183355b82607d4c575c34df8" kindref="member">Val</ref></type>
        <definition>forceinline ValSelFunction&lt; View &gt;::Val Gecode::ValSelFunction&lt; View &gt;::val</definition>
        <argsstring>(const Space &amp;home, View x, int i)</argsstring>
        <name>val</name>
        <param>
          <type>const <ref refid="classGecode_1_1Space" kindref="compound">Space</ref> &amp;</type>
          <declname>home</declname>
        </param>
        <param>
          <type><ref refid="classGecode_1_1ValSel_1a505b0292df0aa0f8ec84940c6d99973d" kindref="member">View</ref></type>
          <declname>x</declname>
        </param>
        <param>
          <type>int</type>
          <declname>i</declname>
        </param>
        <briefdescription>
<para>Return user-defined 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.hpp" line="88" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel.hpp" bodystart="123" bodyend="126"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>User-defined value selection. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="7469">
        <label>Gecode::ValSelFunction&lt; View &gt;</label>
        <link refid="classGecode_1_1ValSelFunction"/>
        <childnode refid="7470" relation="public-inheritance">
        </childnode>
      </node>
      <node id="7470">
        <label>Gecode::ValSel&lt; View, BranchTraits&lt; View::VarType &gt;::ValType &gt;</label>
        <link refid="classGecode_1_1ValSel"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="7471">
        <label>Gecode::ValSelFunction&lt; View &gt;</label>
        <link refid="classGecode_1_1ValSelFunction"/>
        <childnode refid="7472" relation="public-inheritance">
        </childnode>
      </node>
      <node id="7472">
        <label>Gecode::ValSel&lt; View, BranchTraits&lt; View::VarType &gt;::ValType &gt;</label>
        <link refid="classGecode_1_1ValSel"/>
      </node>
    </collaborationgraph>
    <location file="/usr/include/gecode/kernel/brancher-val-sel.hpp" line="69" column="1" bodyfile="/usr/include/gecode/kernel/brancher-val-sel.hpp" bodystart="67" bodyend="89"/>
    <listofallmembers>
      <member refid="classGecode_1_1ValSel_1a97b5efe17b08958952219d3cf73cf980" prot="public" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>dispose</name></member>
      <member refid="classGecode_1_1ValSel_1a424857898f7ae1df27fc6cbe5ab6523a" prot="public" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>notice</name></member>
      <member refid="classGecode_1_1ValSelFunction_1ae5102d5825036ff3b1a3033c9f797380" prot="protected" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>v</name></member>
      <member refid="classGecode_1_1ValSelFunction_1a1c57a4ef183355b82607d4c575c34df8" prot="public" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>Val</name></member>
      <member refid="classGecode_1_1ValSelFunction_1a989dd4c69b809ecad7926d2f6745ce06" prot="public" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>val</name></member>
      <member refid="classGecode_1_1ValSelFunction_1a23fd285075eedee9493f084db8747e24" prot="public" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>ValFunction</name></member>
      <member refid="classGecode_1_1ValSel_1ae84207620c76b1e288ae8843dae769be" prot="public" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>ValSel</name></member>
      <member refid="classGecode_1_1ValSel_1a6658df4b1d1a10a8e61d6960a1432e77" prot="public" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>ValSel</name></member>
      <member refid="classGecode_1_1ValSelFunction_1a2049fad7e2d42b2cfcb03917a17ee131" prot="public" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>ValSelFunction</name></member>
      <member refid="classGecode_1_1ValSelFunction_1a3b74921e79c6d299a0781ce1400648bc" prot="public" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>ValSelFunction</name></member>
      <member refid="classGecode_1_1ValSelFunction_1ad08c0683fd319d1c312ce12a31870d54" prot="public" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>Var</name></member>
      <member refid="classGecode_1_1ValSel_1a505b0292df0aa0f8ec84940c6d99973d" prot="public" virt="non-virtual"><scope>Gecode::ValSelFunction</scope><name>View</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>