261 lines
15 KiB
XML
261 lines
15 KiB
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_1Choice" kind="class" prot="public" abstract="yes">
|
|
<compoundname>Gecode::Choice</compoundname>
|
|
<derivedcompoundref refid="classGecode_1_1Gist_1_1StopChoice" prot="public" virt="non-virtual">Gecode::Gist::StopChoice</derivedcompoundref>
|
|
<derivedcompoundref refid="classGecode_1_1PosChoice" prot="public" virt="non-virtual">Gecode::PosChoice</derivedcompoundref>
|
|
<includes refid="core_8hpp" local="no">core.hpp</includes>
|
|
<sectiondef kind="friend">
|
|
<memberdef kind="friend" id="classGecode_1_1Choice_1a2129e6c0ac73536a2ac4f681dae16947" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>friend class</type>
|
|
<definition>friend class Space</definition>
|
|
<argsstring></argsstring>
|
|
<name>Space</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1037" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="1037" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="private-attrib">
|
|
<memberdef kind="variable" id="classGecode_1_1Choice_1a28aa30a8837e778aee246d52b599fa3e" prot="private" static="no" mutable="no">
|
|
<type>unsigned int</type>
|
|
<definition>unsigned int Gecode::Choice::_id</definition>
|
|
<argsstring></argsstring>
|
|
<name>_id</name>
|
|
<briefdescription>
|
|
<para>Identity to match creating brancher. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1039" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="1039" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classGecode_1_1Choice_1a9d1bfa028ab3b9593f3154524fad3004" prot="private" static="no" mutable="no">
|
|
<type>unsigned int</type>
|
|
<definition>unsigned int Gecode::Choice::_alt</definition>
|
|
<argsstring></argsstring>
|
|
<name>_alt</name>
|
|
<briefdescription>
|
|
<para>Number of alternatives. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1040" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="1040" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="private-func">
|
|
<memberdef kind="function" id="classGecode_1_1Choice_1a145f2ea2feea586e1af6563a38834488" prot="private" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
|
|
<type>unsigned int</type>
|
|
<definition>forceinline unsigned int Gecode::Choice::id</definition>
|
|
<argsstring>(void) const </argsstring>
|
|
<name>id</name>
|
|
<param>
|
|
<type>void</type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Return id of the creating brancher. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1043" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3101" bodyend="3103"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="protected-func">
|
|
<memberdef kind="function" id="classGecode_1_1Choice_1ab7f6d213ee8ba98e8ac7af0d3c22f31e" prot="protected" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type></type>
|
|
<definition>forceinline Gecode::Choice::Choice</definition>
|
|
<argsstring>(const Brancher &b, const unsigned int a)</argsstring>
|
|
<name>Choice</name>
|
|
<param>
|
|
<type>const <ref refid="classGecode_1_1Brancher" kindref="compound">Brancher</ref> &</type>
|
|
<declname>b</declname>
|
|
</param>
|
|
<param>
|
|
<type>const unsigned int</type>
|
|
<declname>a</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Initialize for particular brancher <emphasis>b</emphasis> and alternatives <emphasis>a</emphasis>. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1046" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3092" bodyend="3093"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="public-func">
|
|
<memberdef kind="function" id="classGecode_1_1Choice_1af192a0eaa577e0faff6249bba3846048" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
|
|
<type>unsigned int</type>
|
|
<definition>forceinline unsigned int Gecode::Choice::alternatives</definition>
|
|
<argsstring>(void) const </argsstring>
|
|
<name>alternatives</name>
|
|
<param>
|
|
<type>void</type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Return number of alternatives. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1049" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3096" bodyend="3098"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1Choice_1acad447b380ef518f1e391044080cfceb" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
|
|
<type>GECODE_KERNEL_EXPORT</type>
|
|
<definition>forceinline Gecode::Choice::~Choice</definition>
|
|
<argsstring>(void)</argsstring>
|
|
<name>~Choice</name>
|
|
<param>
|
|
<type>void</type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Destructor. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1051" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="3106" bodyend="3106"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1Choice_1a078e7e946fdf708a7d31537a434ad2ce" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
|
|
<type>size_t</type>
|
|
<definition>virtual size_t Gecode::Choice::size</definition>
|
|
<argsstring>(void) const =0</argsstring>
|
|
<name>size</name>
|
|
<reimplementedby refid="classGecode_1_1Gist_1_1StopChoice_1ad8122c8947ddc0ca4496891bb1191da8">size</reimplementedby>
|
|
<reimplementedby refid="classGecode_1_1PosValChoice_1ae5b4003da9b2a9976410ad41ede55c75">size</reimplementedby>
|
|
<reimplementedby refid="classGecode_1_1Int_1_1Branch_1_1PosValuesChoice_1ac409a768511bc37e8076dcc39ee678ce">size</reimplementedby>
|
|
<reimplementedby refid="classGecode_1_1PosChoice_1a8fc1330d9b21eacd19c4d2f48914d770">size</reimplementedby>
|
|
<reimplementedby refid="classGecode_1_1Int_1_1LDSB_1_1LDSBChoice_1a3bc5738ebfe778f439c39caa99f65759">size</reimplementedby>
|
|
<param>
|
|
<type>void</type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Report size occupied by choice. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1053" column="1"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1Choice_1a6875e7d99bdd505ac44291af3f0a4df3" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
|
|
<type>GECODE_KERNEL_EXPORT void</type>
|
|
<definition>virtual GECODE_KERNEL_EXPORT void Gecode::Choice::archive</definition>
|
|
<argsstring>(Archive &e) const </argsstring>
|
|
<name>archive</name>
|
|
<reimplementedby refid="classGecode_1_1Gist_1_1StopChoice_1a79617264f37a652768bf7152019b21b6">archive</reimplementedby>
|
|
<reimplementedby refid="classGecode_1_1PosValChoice_1a6eb0c381908020c0432b5c7cc4dd5309">archive</reimplementedby>
|
|
<reimplementedby refid="classGecode_1_1PosChoice_1a1b4be569c47acb2dd50700ff94b58601">archive</reimplementedby>
|
|
<reimplementedby refid="classGecode_1_1Int_1_1Branch_1_1PosValuesChoice_1aeb99dc1dc9a39766c51012d8f1f54c62">archive</reimplementedby>
|
|
<reimplementedby refid="classGecode_1_1Int_1_1LDSB_1_1LDSBChoice_1a03de89e58244deacbb66df6320d02482">archive</reimplementedby>
|
|
<param>
|
|
<type><ref refid="classGecode_1_1Archive" kindref="compound">Archive</ref> &</type>
|
|
<declname>e</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para><ref refid="classGecode_1_1Archive" kindref="compound">Archive</ref> into <emphasis>e</emphasis>. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1059" column="1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="public-static-func">
|
|
<memberdef kind="function" id="classGecode_1_1Choice_1a6e73d127bcd5d68cecf1fbee490b7175" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void *</type>
|
|
<definition>forceinline void * Gecode::Choice::operator new</definition>
|
|
<argsstring>(size_t)</argsstring>
|
|
<name>operator new</name>
|
|
<param>
|
|
<type>size_t</type>
|
|
<defname>s</defname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Allocate memory from heap. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1055" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="2309" bodyend="2311"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1Choice_1ad2a15f523c6a971e83a4e996fe20dd76" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>forceinline void Gecode::Choice::operator delete</definition>
|
|
<argsstring>(void *)</argsstring>
|
|
<name>operator delete</name>
|
|
<param>
|
|
<type>void *</type>
|
|
<defname>p</defname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Return memory to heap. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1057" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="2305" bodyend="2307"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
<para>Choice for performing commit </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para>Must be refined by inheritance such that the information stored inside a choice is sufficient to redo a commit performed by a particular brancher. </para> </detaileddescription>
|
|
<inheritancegraph>
|
|
<node id="1482">
|
|
<label>Gecode::PosValChoice< Val ></label>
|
|
<link refid="classGecode_1_1PosValChoice"/>
|
|
<childnode refid="1480" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="1483">
|
|
<label>Gecode::Int::LDSB::LDSBChoice< Val ></label>
|
|
<link refid="classGecode_1_1Int_1_1LDSB_1_1LDSBChoice"/>
|
|
<childnode refid="1482" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="1480">
|
|
<label>Gecode::PosChoice</label>
|
|
<link refid="classGecode_1_1PosChoice"/>
|
|
<childnode refid="1478" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="1479">
|
|
<label>Gecode::Gist::StopChoice</label>
|
|
<link refid="classGecode_1_1Gist_1_1StopChoice"/>
|
|
<childnode refid="1478" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="1478">
|
|
<label>Gecode::Choice</label>
|
|
<link refid="classGecode_1_1Choice"/>
|
|
</node>
|
|
<node id="1481">
|
|
<label>Gecode::Int::Branch::PosValuesChoice</label>
|
|
<link refid="classGecode_1_1Int_1_1Branch_1_1PosValuesChoice"/>
|
|
<childnode refid="1480" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
</inheritancegraph>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1036" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="1036" bodyend="1060"/>
|
|
<listofallmembers>
|
|
<member refid="classGecode_1_1Choice_1a9d1bfa028ab3b9593f3154524fad3004" prot="private" virt="non-virtual"><scope>Gecode::Choice</scope><name>_alt</name></member>
|
|
<member refid="classGecode_1_1Choice_1a28aa30a8837e778aee246d52b599fa3e" prot="private" virt="non-virtual"><scope>Gecode::Choice</scope><name>_id</name></member>
|
|
<member refid="classGecode_1_1Choice_1af192a0eaa577e0faff6249bba3846048" prot="public" virt="non-virtual"><scope>Gecode::Choice</scope><name>alternatives</name></member>
|
|
<member refid="classGecode_1_1Choice_1a6875e7d99bdd505ac44291af3f0a4df3" prot="public" virt="virtual"><scope>Gecode::Choice</scope><name>archive</name></member>
|
|
<member refid="classGecode_1_1Choice_1ab7f6d213ee8ba98e8ac7af0d3c22f31e" prot="protected" virt="non-virtual"><scope>Gecode::Choice</scope><name>Choice</name></member>
|
|
<member refid="classGecode_1_1Choice_1a145f2ea2feea586e1af6563a38834488" prot="private" virt="non-virtual"><scope>Gecode::Choice</scope><name>id</name></member>
|
|
<member refid="classGecode_1_1Choice_1ad2a15f523c6a971e83a4e996fe20dd76" prot="public" virt="non-virtual"><scope>Gecode::Choice</scope><name>operator delete</name></member>
|
|
<member refid="classGecode_1_1Choice_1a6e73d127bcd5d68cecf1fbee490b7175" prot="public" virt="non-virtual"><scope>Gecode::Choice</scope><name>operator new</name></member>
|
|
<member refid="classGecode_1_1Choice_1a078e7e946fdf708a7d31537a434ad2ce" prot="public" virt="pure-virtual"><scope>Gecode::Choice</scope><name>size</name></member>
|
|
<member refid="classGecode_1_1Choice_1a2129e6c0ac73536a2ac4f681dae16947" prot="private" virt="non-virtual"><scope>Gecode::Choice</scope><name>Space</name></member>
|
|
<member refid="classGecode_1_1Choice_1acad447b380ef518f1e391044080cfceb" prot="public" virt="virtual"><scope>Gecode::Choice</scope><name>~Choice</name></member>
|
|
</listofallmembers>
|
|
</compounddef>
|
|
</doxygen>
|