303 lines
18 KiB
XML
303 lines
18 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_1GlobalAFC" kind="class" prot="public">
|
|
<compoundname>Gecode::GlobalAFC</compoundname>
|
|
<includes refid="global-afc_8hpp" local="no">global-afc.hpp</includes>
|
|
<innerclass refid="classGecode_1_1GlobalAFC_1_1Block" prot="private">Gecode::GlobalAFC::Block</innerclass>
|
|
<innerclass refid="classGecode_1_1GlobalAFC_1_1Counter" prot="public">Gecode::GlobalAFC::Counter</innerclass>
|
|
<innerclass refid="classGecode_1_1GlobalAFC_1_1DecayManager" prot="private">Gecode::GlobalAFC::DecayManager</innerclass>
|
|
<innerclass refid="classGecode_1_1GlobalAFC_1_1Object" prot="private">Gecode::GlobalAFC::Object</innerclass>
|
|
<sectiondef kind="private-static-attrib">
|
|
<memberdef kind="variable" id="classGecode_1_1GlobalAFC_1a9e37d08fb1e3d95e4b3f156f2f473be8" prot="private" static="yes" mutable="no">
|
|
<type>const unsigned int</type>
|
|
<definition>const unsigned int Gecode::GlobalAFC::size_min</definition>
|
|
<argsstring></argsstring>
|
|
<name>size_min</name>
|
|
<initializer>= 32</initializer>
|
|
<briefdescription>
|
|
<para>Initial smallest number of entries per block. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="98" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="98" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classGecode_1_1GlobalAFC_1a97f59bdfd53007aeb94b0dddbef8bed1" prot="private" static="yes" mutable="no">
|
|
<type>const unsigned int</type>
|
|
<definition>const unsigned int Gecode::GlobalAFC::size_max</definition>
|
|
<argsstring></argsstring>
|
|
<name>size_max</name>
|
|
<initializer>= 32 * 1024</initializer>
|
|
<briefdescription>
|
|
<para>Largest possible number of entries per block. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="100" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="100" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="private-attrib">
|
|
<memberdef kind="variable" id="classGecode_1_1GlobalAFC_1a7daad60419d918ace642a9272e2c1495" prot="private" static="no" mutable="no">
|
|
<type>void *</type>
|
|
<definition>void* Gecode::GlobalAFC::mo</definition>
|
|
<argsstring></argsstring>
|
|
<name>mo</name>
|
|
<briefdescription>
|
|
<para>Pointer to object, possibly marked. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="126" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="126" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="private-func">
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1a06794a50463d7a729bcbdab56c6e54c8" prot="private" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
|
|
<type>Object *</type>
|
|
<definition>forceinline GlobalAFC::Object * Gecode::GlobalAFC::object</definition>
|
|
<argsstring>(void) const </argsstring>
|
|
<name>object</name>
|
|
<param>
|
|
<type>void</type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Pointer to object without mark. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="128" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="259" bodyend="261"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1a417fe56c117df9f964f9343d5be072ac" prot="private" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
|
|
<type>bool</type>
|
|
<definition>forceinline bool Gecode::GlobalAFC::local</definition>
|
|
<argsstring>(void) const </argsstring>
|
|
<name>local</name>
|
|
<param>
|
|
<type>void</type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Whether pointer points to local object. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="130" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="263" bodyend="265"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1a191aa0c728e637e58efdb742cab48612" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>forceinline void Gecode::GlobalAFC::local</definition>
|
|
<argsstring>(Object *o)</argsstring>
|
|
<name>local</name>
|
|
<param>
|
|
<type>Object *</type>
|
|
<declname>o</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para><ref refid="namespaceGecode_1_1Set" kindref="compound">Set</ref> pointer to local object. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="132" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="267" bodyend="270"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1ab33cafe26b054acfe4f1b9f3b21ebb85" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>forceinline void Gecode::GlobalAFC::global</definition>
|
|
<argsstring>(void *mo)</argsstring>
|
|
<name>global</name>
|
|
<param>
|
|
<type>void *</type>
|
|
<declname>mo</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para><ref refid="namespaceGecode_1_1Set" kindref="compound">Set</ref> global pointer to possibly marked object. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="134" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="272" bodyend="274"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="public-func">
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1adcc38d83e6cd75ad47d5d6d89117968c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type></type>
|
|
<definition>forceinline Gecode::GlobalAFC::GlobalAFC</definition>
|
|
<argsstring>(void)</argsstring>
|
|
<name>GlobalAFC</name>
|
|
<param>
|
|
<type>void</type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Initialize. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="137" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="277" bodyend="280"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1ac3b76cbc6561a699df232bc1cd337101" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type></type>
|
|
<definition>forceinline Gecode::GlobalAFC::GlobalAFC</definition>
|
|
<argsstring>(const GlobalAFC &ga)</argsstring>
|
|
<name>GlobalAFC</name>
|
|
<param>
|
|
<type>const <ref refid="classGecode_1_1GlobalAFC" kindref="compound">GlobalAFC</ref> &</type>
|
|
<declname>ga</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Copy during cloning. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="139" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="283" bodyend="289"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1a0e407c60e6b908f88328ca1e67219e95" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type></type>
|
|
<definition>forceinline Gecode::GlobalAFC::~GlobalAFC</definition>
|
|
<argsstring>(void)</argsstring>
|
|
<name>~GlobalAFC</name>
|
|
<param>
|
|
<type>void</type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Destructor. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="141" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="292" bodyend="314"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1a8e1712be4409ab661d004b31dad6e131" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>forceinline void Gecode::GlobalAFC::decay</definition>
|
|
<argsstring>(double d)</argsstring>
|
|
<name>decay</name>
|
|
<param>
|
|
<type>double</type>
|
|
<declname>d</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para><ref refid="namespaceGecode_1_1Set" kindref="compound">Set</ref> decay factor to <emphasis>d</emphasis>. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="143" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="353" bodyend="358"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1a6ebfc960e0aea160f4780050a6e3dbbc" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
|
|
<type>double</type>
|
|
<definition>forceinline double Gecode::GlobalAFC::decay</definition>
|
|
<argsstring>(void) const </argsstring>
|
|
<name>decay</name>
|
|
<param>
|
|
<type>void</type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Return decay factor. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="145" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="343" bodyend="350"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1a5c4c127b34f0707981bca4c72551faca" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>forceinline void Gecode::GlobalAFC::fail</definition>
|
|
<argsstring>(Counter &c)</argsstring>
|
|
<name>fail</name>
|
|
<param>
|
|
<type><ref refid="classGecode_1_1GlobalAFC_1_1Counter" kindref="compound">Counter</ref> &</type>
|
|
<declname>c</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Increment failure count. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="147" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="317" bodyend="322"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1a45f5c9571c63b6004db4d06516d3d784" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>forceinline void Gecode::GlobalAFC::set</definition>
|
|
<argsstring>(Counter &c, double a)</argsstring>
|
|
<name>set</name>
|
|
<param>
|
|
<type><ref refid="classGecode_1_1GlobalAFC_1_1Counter" kindref="compound">Counter</ref> &</type>
|
|
<declname>c</declname>
|
|
</param>
|
|
<param>
|
|
<type>double</type>
|
|
<declname>a</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para><ref refid="namespaceGecode_1_1Set" kindref="compound">Set</ref> failure count to <emphasis>a</emphasis>. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="149" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="325" bodyend="330"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1a1e93e5f53cd7b9116c99a5ecc6130920" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>double</type>
|
|
<definition>forceinline double Gecode::GlobalAFC::afc</definition>
|
|
<argsstring>(Counter &c)</argsstring>
|
|
<name>afc</name>
|
|
<param>
|
|
<type><ref refid="classGecode_1_1GlobalAFC_1_1Counter" kindref="compound">Counter</ref> &</type>
|
|
<declname>c</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Return failure count. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="151" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="333" bodyend="340"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classGecode_1_1GlobalAFC_1a8ec267284e215de7c77b837de56f2b7d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type><ref refid="classGecode_1_1GlobalAFC_1_1Counter" kindref="compound">Counter</ref> &</type>
|
|
<definition>forceinline GlobalAFC::Counter & Gecode::GlobalAFC::allocate</definition>
|
|
<argsstring>(void)</argsstring>
|
|
<name>allocate</name>
|
|
<param>
|
|
<type>void</type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Allocate new propagator info. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="153" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="361" bodyend="386"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
<para>Globally shared object for propagator information. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<location file="/usr/include/gecode/kernel/global-afc.hpp" line="43" column="1" bodyfile="/usr/include/gecode/kernel/global-afc.hpp" bodystart="43" bodyend="154"/>
|
|
<listofallmembers>
|
|
<member refid="classGecode_1_1GlobalAFC_1a1e93e5f53cd7b9116c99a5ecc6130920" prot="public" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>afc</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a8ec267284e215de7c77b837de56f2b7d" prot="public" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>allocate</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a8e1712be4409ab661d004b31dad6e131" prot="public" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>decay</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a6ebfc960e0aea160f4780050a6e3dbbc" prot="public" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>decay</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a5c4c127b34f0707981bca4c72551faca" prot="public" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>fail</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1ab33cafe26b054acfe4f1b9f3b21ebb85" prot="private" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>global</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1adcc38d83e6cd75ad47d5d6d89117968c" prot="public" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>GlobalAFC</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1ac3b76cbc6561a699df232bc1cd337101" prot="public" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>GlobalAFC</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a417fe56c117df9f964f9343d5be072ac" prot="private" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>local</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a191aa0c728e637e58efdb742cab48612" prot="private" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>local</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a7daad60419d918ace642a9272e2c1495" prot="private" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>mo</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a06794a50463d7a729bcbdab56c6e54c8" prot="private" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>object</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a45f5c9571c63b6004db4d06516d3d784" prot="public" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>set</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a97f59bdfd53007aeb94b0dddbef8bed1" prot="private" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>size_max</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a9e37d08fb1e3d95e4b3f156f2f473be8" prot="private" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>size_min</name></member>
|
|
<member refid="classGecode_1_1GlobalAFC_1a0e407c60e6b908f88328ca1e67219e95" prot="public" virt="non-virtual"><scope>Gecode::GlobalAFC</scope><name>~GlobalAFC</name></member>
|
|
</listofallmembers>
|
|
</compounddef>
|
|
</doxygen>
|