This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
yap-6.3/packages/gecode/dev/extractor/xml/classGecode_1_1SetValBranch.xml

245 lines
16 KiB
XML
Raw Normal View History

2014-01-22 09:41:47 +00:00
<?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_1SetValBranch" kind="class" prot="public">
<compoundname>Gecode::SetValBranch</compoundname>
<basecompoundref refid="classGecode_1_1ValBranch" prot="public" virt="non-virtual">Gecode::ValBranch</basecompoundref>
<includes refid="set_8hh" local="no">set.hh</includes>
<sectiondef kind="public-type">
<memberdef kind="enum" id="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1" prot="public" static="no">
<name>Select</name>
<enumvalue id="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1aa06221f63e6b78cddb6540555a90d81c" prot="public">
<name>SEL_MIN_INC</name>
<briefdescription>
<para>Include smallest element. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1a59622acd14b87b456e2d1554fea11685" prot="public">
<name>SEL_MIN_EXC</name>
<briefdescription>
<para>Exclude smallest element. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1af2f438749ad82120bfbf95161f773211" prot="public">
<name>SEL_MED_INC</name>
<briefdescription>
<para>Include median element (rounding downwards) </para> </briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1abb22c813f41c9573b987e6ed9a99151c" prot="public">
<name>SEL_MED_EXC</name>
<briefdescription>
<para>Exclude median element (rounding downwards) </para> </briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1a1a76589ba5db27e0230cd30eecc3fe1b" prot="public">
<name>SEL_MAX_INC</name>
<briefdescription>
<para>Include largest element. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1aa69973042c237021a5e52123fc5ccc7a" prot="public">
<name>SEL_MAX_EXC</name>
<briefdescription>
<para>Exclude largest element. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1adcf3e730147d1b8fdb42fee407d6d789" prot="public">
<name>SEL_RND_INC</name>
<briefdescription>
<para>Include random element. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1a7a7d8041c9fef57e38039e337034b52d" prot="public">
<name>SEL_RND_EXC</name>
<briefdescription>
<para>Exclude random element. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1a18049fd7a14d94fa72efc12122acddd9" prot="public">
<name>SEL_VAL_COMMIT</name>
<briefdescription>
<para>Select value according to user-defined functions. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<briefdescription>
<para>Which value selection. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/set.hh" line="1385" column="1" bodyfile="/usr/include/gecode/set.hh" bodystart="1385" bodyend="1395"/>
</memberdef>
</sectiondef>
<sectiondef kind="protected-attrib">
<memberdef kind="variable" id="classGecode_1_1SetValBranch_1aa62b3986c1bf35b8da54ce3eaeced411" prot="protected" static="no" mutable="no">
<type><ref refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1" kindref="member">Select</ref></type>
<definition>Select Gecode::SetValBranch::s</definition>
<argsstring></argsstring>
<name>s</name>
<briefdescription>
<para>Which value to select. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/set.hh" line="1398" column="1" bodyfile="/usr/include/gecode/set.hh" bodystart="1398" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
<memberdef kind="function" id="classGecode_1_1SetValBranch_1a88cf703b81490e7eeaf615a9dcc1995d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>forceinline Gecode::SetValBranch::SetValBranch</definition>
<argsstring>(Select s=SEL_MIN_INC)</argsstring>
<name>SetValBranch</name>
<param>
<type><ref refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1" kindref="member">Select</ref></type>
<declname>s</declname>
<defval><ref refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1aa06221f63e6b78cddb6540555a90d81c" kindref="member">SEL_MIN_INC</ref></defval>
</param>
<briefdescription>
<para>Initialize with selection strategy <emphasis>s</emphasis>. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/set.hh" line="1401" column="1" bodyfile="/usr/include/gecode/set/branch/val.hpp" bodystart="41" bodyend="42"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1SetValBranch_1a16505cbff30f1d578ac0175db81c4e4b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>forceinline Gecode::SetValBranch::SetValBranch</definition>
<argsstring>(Select s, Rnd r)</argsstring>
<name>SetValBranch</name>
<param>
<type><ref refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1" kindref="member">Select</ref></type>
<declname>s</declname>
</param>
<param>
<type><ref refid="classGecode_1_1Rnd" kindref="compound">Rnd</ref></type>
<declname>r</declname>
</param>
<briefdescription>
<para>Initialize with random number generator <emphasis>r</emphasis>. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/set.hh" line="1403" column="1" bodyfile="/usr/include/gecode/set/branch/val.hpp" bodystart="45" bodyend="46"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1SetValBranch_1a61a96f9634b03fbaa614211f621ed31b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>forceinline Gecode::SetValBranch::SetValBranch</definition>
<argsstring>(VoidFunction v, VoidFunction c)</argsstring>
<name>SetValBranch</name>
<param>
<type><ref refid="namespaceGecode_1a6e982f1b655011d8c781cd9f38cfb907" kindref="member">VoidFunction</ref></type>
<declname>v</declname>
</param>
<param>
<type><ref refid="namespaceGecode_1a6e982f1b655011d8c781cd9f38cfb907" kindref="member">VoidFunction</ref></type>
<declname>c</declname>
</param>
<briefdescription>
<para>Initialize with value function <emphasis>f</emphasis> and commit function <emphasis>c</emphasis>. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/set.hh" line="1405" column="1" bodyfile="/usr/include/gecode/set/branch/val.hpp" bodystart="49" bodyend="50"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1SetValBranch_1a09778bb88c8eb9b973a00d1cceb1fc8b" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1" kindref="member">Select</ref></type>
<definition>forceinline SetValBranch::Select Gecode::SetValBranch::select</definition>
<argsstring>(void) const </argsstring>
<name>select</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Return selection strategy. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/set.hh" line="1407" column="1" bodyfile="/usr/include/gecode/set/branch/val.hpp" bodystart="53" bodyend="55"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>Which values to select for branching first. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inheritancegraph>
<node id="6389">
<label>Gecode::ValBranch</label>
<link refid="classGecode_1_1ValBranch"/>
</node>
<node id="6388">
<label>Gecode::SetValBranch</label>
<link refid="classGecode_1_1SetValBranch"/>
<childnode refid="6389" relation="public-inheritance">
</childnode>
</node>
</inheritancegraph>
<collaborationgraph>
<node id="6391">
<label>Gecode::ValBranch</label>
<link refid="classGecode_1_1ValBranch"/>
<childnode refid="6392" relation="usage">
<edgelabel>r</edgelabel>
</childnode>
</node>
<node id="6392">
<label>Gecode::Rnd</label>
<link refid="classGecode_1_1Rnd"/>
<childnode refid="6393" relation="public-inheritance">
</childnode>
</node>
<node id="6393">
<label>Gecode::SharedHandle</label>
<link refid="classGecode_1_1SharedHandle"/>
</node>
<node id="6390">
<label>Gecode::SetValBranch</label>
<link refid="classGecode_1_1SetValBranch"/>
<childnode refid="6391" relation="public-inheritance">
</childnode>
</node>
</collaborationgraph>
<location file="/usr/include/gecode/set.hh" line="1382" column="1" bodyfile="/usr/include/gecode/set.hh" bodystart="1382" bodyend="1408"/>
<listofallmembers>
<member refid="classGecode_1_1ValBranch_1a3f210c407c95b73613c588a9ccad63de" prot="protected" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>cf</name></member>
<member refid="classGecode_1_1ValBranch_1a4e8a56a907d7d9a9bd71f5762b994407" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>commit</name></member>
<member refid="classGecode_1_1ValBranch_1a3e83e74c785cf1a2224abfa67de186fc" prot="protected" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>r</name></member>
<member refid="classGecode_1_1ValBranch_1acfc0a641a55ee13ab778ff5fbb5327ce" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>rnd</name></member>
<member refid="classGecode_1_1SetValBranch_1aa62b3986c1bf35b8da54ce3eaeced411" prot="protected" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>s</name></member>
<member refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1aa69973042c237021a5e52123fc5ccc7a" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SEL_MAX_EXC</name></member>
<member refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1a1a76589ba5db27e0230cd30eecc3fe1b" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SEL_MAX_INC</name></member>
<member refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1abb22c813f41c9573b987e6ed9a99151c" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SEL_MED_EXC</name></member>
<member refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1af2f438749ad82120bfbf95161f773211" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SEL_MED_INC</name></member>
<member refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1a59622acd14b87b456e2d1554fea11685" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SEL_MIN_EXC</name></member>
<member refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1aa06221f63e6b78cddb6540555a90d81c" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SEL_MIN_INC</name></member>
<member refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1a7a7d8041c9fef57e38039e337034b52d" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SEL_RND_EXC</name></member>
<member refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1adcf3e730147d1b8fdb42fee407d6d789" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SEL_RND_INC</name></member>
<member refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1a18049fd7a14d94fa72efc12122acddd9" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SEL_VAL_COMMIT</name></member>
<member refid="classGecode_1_1SetValBranch_1a77ce304c556537e3ed68d0fd025985f1" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>Select</name></member>
<member refid="classGecode_1_1SetValBranch_1a09778bb88c8eb9b973a00d1cceb1fc8b" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>select</name></member>
<member refid="classGecode_1_1SetValBranch_1a88cf703b81490e7eeaf615a9dcc1995d" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SetValBranch</name></member>
<member refid="classGecode_1_1SetValBranch_1a16505cbff30f1d578ac0175db81c4e4b" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SetValBranch</name></member>
<member refid="classGecode_1_1SetValBranch_1a61a96f9634b03fbaa614211f621ed31b" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>SetValBranch</name></member>
<member refid="classGecode_1_1ValBranch_1a0359f6d8d698d621f2b04f1e099f6a91" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>val</name></member>
<member refid="classGecode_1_1ValBranch_1aee3d20ec60e0914116719487eab754cc" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>ValBranch</name></member>
<member refid="classGecode_1_1ValBranch_1acbef5d412d3065c6b868e54f96954a96" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>ValBranch</name></member>
<member refid="classGecode_1_1ValBranch_1ab7f529dafc943daf32e482aa95bda06b" prot="public" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>ValBranch</name></member>
<member refid="classGecode_1_1ValBranch_1a777978a1be672670ef25af6f3a4ef135" prot="protected" virt="non-virtual"><scope>Gecode::SetValBranch</scope><name>vf</name></member>
</listofallmembers>
</compounddef>
</doxygen>