180 lines
10 KiB
XML
180 lines
10 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="group__TaskActorStatus" kind="group">
|
|
<compoundname>TaskActorStatus</compoundname>
|
|
<title>Status of constraint propagation and branching commit</title>
|
|
<sectiondef kind="func">
|
|
<memberdef kind="function" id="group__TaskActorStatus_1gafc19cbf71ed90a9e0b414b875103f4c7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>ExecStatus</type>
|
|
<definition>forceinline ExecStatus Gecode::Space::ES_SUBSUMED</definition>
|
|
<argsstring>(Propagator &p)</argsstring>
|
|
<name>ES_SUBSUMED</name>
|
|
<param>
|
|
<type>Propagator &</type>
|
|
<declname>p</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>Propagator <emphasis>p</emphasis> is subsumed</para><para>First disposes the propagator and then returns subsumption.</para><para><simplesect kind="warning"><para>Has a side-effect on the propagator. Overwrites the modification event delta of a propagator. Use only directly with returning from propagation. </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1859" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="2896" bodyend="2899"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="group__TaskActorStatus_1gabda9bef00ac1cc77411b3766c188308a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>ExecStatus</type>
|
|
<definition>forceinline ExecStatus Gecode::Space::ES_SUBSUMED_DISPOSED</definition>
|
|
<argsstring>(Propagator &p, size_t s)</argsstring>
|
|
<name>ES_SUBSUMED_DISPOSED</name>
|
|
<param>
|
|
<type>Propagator &</type>
|
|
<declname>p</declname>
|
|
</param>
|
|
<param>
|
|
<type>size_t</type>
|
|
<declname>s</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Propagator <emphasis>p</emphasis> is subsumed </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para>The size of the propagator is <emphasis>s</emphasis>.</para><para>Note that the propagator must be subsumed and also disposed. So in general, there should be code such as <programlisting><codeline><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>ES_SUBSUMED_DISPOSE(home,*</highlight><highlight class="keyword">this</highlight><highlight class="normal">,dispose(home))<sp/></highlight></codeline>
|
|
</programlisting>.</para><para><simplesect kind="warning"><para>Has a side-effect on the propagator. Overwrites the modification event delta of a propagator. Use only directly with returning from propagation. </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1874" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="2890" bodyend="2893"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="group__TaskActorStatus_1ga3c10035661f491847349d084e967858c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>ExecStatus</type>
|
|
<definition>forceinline ExecStatus Gecode::Space::ES_FIX_PARTIAL</definition>
|
|
<argsstring>(Propagator &p, const ModEventDelta &med)</argsstring>
|
|
<name>ES_FIX_PARTIAL</name>
|
|
<param>
|
|
<type>Propagator &</type>
|
|
<declname>p</declname>
|
|
</param>
|
|
<param>
|
|
<type>const ModEventDelta &</type>
|
|
<declname>med</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Propagator <emphasis>p</emphasis> has computed partial fixpoint </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para>Set modification event delta to <emphasis>med</emphasis> and schedule propagator accordingly.</para><para><simplesect kind="warning"><para>Has a side-effect on the propagator. Use only directly with returning from propagation. </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1885" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="2902" bodyend="2906"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="group__TaskActorStatus_1ga1f9059933d5d03ecfe32a1df5c8d7e36" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>ExecStatus</type>
|
|
<definition>forceinline ExecStatus Gecode::Space::ES_NOFIX_PARTIAL</definition>
|
|
<argsstring>(Propagator &p, const ModEventDelta &med)</argsstring>
|
|
<name>ES_NOFIX_PARTIAL</name>
|
|
<param>
|
|
<type>Propagator &</type>
|
|
<declname>p</declname>
|
|
</param>
|
|
<param>
|
|
<type>const ModEventDelta &</type>
|
|
<declname>med</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Propagator <emphasis>p</emphasis> has not computed partial fixpoint </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para>Combine current modification event delta with <emphasis>and</emphasis> schedule propagator accordingly.</para><para><simplesect kind="warning"><para>Has a side-effect on the propagator. Use only directly with returning from propagation. </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1896" column="1" bodyfile="/usr/include/gecode/kernel/core.hpp" bodystart="2909" bodyend="2913"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="group__TaskActorStatus_1gab238e872a278f9f82dab432174897261" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>class A</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>ExecStatus</type>
|
|
<definition>ExecStatus Gecode::Space::ES_FIX_DISPOSE</definition>
|
|
<argsstring>(Council< A > &c, A &a)</argsstring>
|
|
<name>ES_FIX_DISPOSE</name>
|
|
<param>
|
|
<type>Council< A > &</type>
|
|
<declname>c</declname>
|
|
</param>
|
|
<param>
|
|
<type>A &</type>
|
|
<declname>a</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Advisor <emphasis>a</emphasis> must be disposed </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para>Disposes the advisor and returns that the propagator of <emphasis>a</emphasis> need not be run.</para><para><simplesect kind="warning"><para>Has a side-effect on the advisor. Use only directly when returning from advise. </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1909" column="1"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="group__TaskActorStatus_1gad408b8bdc896a14b069994b1249454c7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>class A</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>ExecStatus</type>
|
|
<definition>ExecStatus Gecode::Space::ES_NOFIX_DISPOSE</definition>
|
|
<argsstring>(Council< A > &c, A &a)</argsstring>
|
|
<name>ES_NOFIX_DISPOSE</name>
|
|
<param>
|
|
<type>Council< A > &</type>
|
|
<declname>c</declname>
|
|
</param>
|
|
<param>
|
|
<type>A &</type>
|
|
<declname>a</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Advisor <emphasis>a</emphasis> must be disposed and its propagator must be run </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para>Disposes the advisor and returns that the propagator of <emphasis>a</emphasis> must be run.</para><para><simplesect kind="warning"><para>Has a side-effect on the advisor. Use only directly when returning from advise. </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1921" column="1"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="group__TaskActorStatus_1gab8af0ee183d3b65dd8da6742e55edf18" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>class A</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>ExecStatus</type>
|
|
<definition>ExecStatus Gecode::Space::ES_NOFIX_DISPOSE_FORCE</definition>
|
|
<argsstring>(Council< A > &c, A &a)</argsstring>
|
|
<name>ES_NOFIX_DISPOSE_FORCE</name>
|
|
<param>
|
|
<type>Council< A > &</type>
|
|
<declname>c</declname>
|
|
</param>
|
|
<param>
|
|
<type>A &</type>
|
|
<declname>a</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Advisor <emphasis>a</emphasis> must be disposed and its propagator must be forcefully rescheduled </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para>Disposes the advisor and returns that the propagator of <emphasis>a</emphasis> must be run and must be forcefully rescheduled (including recomputation of cost).</para><para><simplesect kind="warning"><para>Has a side-effect on the advisor. Use only directly when returning from advise. </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/core.hpp" line="1934" column="1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>Note that the enum values starting with a double underscore should not be used directly. Instead, use the provided functions with the same name without leading underscores. </para> </detaileddescription>
|
|
</compounddef>
|
|
</doxygen>
|