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_1FloatActivity.xml
Vitor Santos Costa a8eda03305 4.2.1 support
2014-01-22 09:41:47 +00:00

196 lines
13 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_1FloatActivity" kind="class" prot="public">
<compoundname>Gecode::FloatActivity</compoundname>
<basecompoundref refid="classGecode_1_1Activity" prot="public" virt="non-virtual">Gecode::Activity</basecompoundref>
<includes refid="float_8hh" local="no">float.hh</includes>
<sectiondef kind="public-func">
<memberdef kind="function" id="group__TaskModelFloatArith_1ga7f5ead8275722edcb0a3638305e87360" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>forceinline Gecode::FloatActivity::FloatActivity</definition>
<argsstring>(void)</argsstring>
<name>FloatActivity</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Construct as not yet initialized. </para> </briefdescription>
<detaileddescription>
<para>The only member functions that can be used on a constructed but not yet initialized activity storage is init or the assignment operator. </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/float.hh" line="1463" column="1" bodyfile="/usr/include/gecode/float/branch/activity.hpp" bodystart="41" bodyend="41"/>
</memberdef>
<memberdef kind="function" id="group__TaskModelFloatArith_1ga99750fe65f0e581125ac89fccd652f55" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>forceinline Gecode::FloatActivity::FloatActivity</definition>
<argsstring>(const FloatActivity &amp;a)</argsstring>
<name>FloatActivity</name>
<param>
<type>const <ref refid="classGecode_1_1FloatActivity" kindref="compound">FloatActivity</ref> &amp;</type>
<declname>a</declname>
</param>
<briefdescription>
<para>Copy constructor. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/float.hh" line="1465" column="1" bodyfile="/usr/include/gecode/float/branch/activity.hpp" bodystart="44" bodyend="45"/>
</memberdef>
<memberdef kind="function" id="group__TaskModelFloatArith_1ga5367cc0b2a1d07677e7e7d722c159cd4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classGecode_1_1FloatActivity" kindref="compound">FloatActivity</ref> &amp;</type>
<definition>forceinline FloatActivity &amp; Gecode::FloatActivity::operator=</definition>
<argsstring>(const FloatActivity &amp;a)</argsstring>
<name>operator=</name>
<param>
<type>const <ref refid="classGecode_1_1FloatActivity" kindref="compound">FloatActivity</ref> &amp;</type>
<declname>a</declname>
</param>
<briefdescription>
<para>Assignment operator. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/float.hh" line="1467" column="1" bodyfile="/usr/include/gecode/float/branch/activity.hpp" bodystart="48" bodyend="50"/>
</memberdef>
<memberdef kind="function" id="group__TaskModelFloatArith_1gac086227df48febffb9a599fcc114f336" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>GECODE_FLOAT_EXPORT</type>
<definition>GECODE_FLOAT_EXPORT Gecode::FloatActivity::FloatActivity</definition>
<argsstring>(Home home, const FloatVarArgs &amp;x, double d=1.0, FloatBranchMerit bm=NULL)</argsstring>
<name>FloatActivity</name>
<param>
<type><ref refid="classGecode_1_1Home" kindref="compound">Home</ref></type>
<declname>home</declname>
</param>
<param>
<type>const <ref refid="classGecode_1_1FloatVarArgs" kindref="compound">FloatVarArgs</ref> &amp;</type>
<declname>x</declname>
</param>
<param>
<type>double</type>
<declname>d</declname>
<defval>1.0</defval>
</param>
<param>
<type><ref refid="group__TaskModelFloatBranch_1ga7eb7e1523e3550892c106a552e11df68" kindref="member">FloatBranchMerit</ref></type>
<declname>bm</declname>
<defval>NULL</defval>
</param>
<briefdescription>
<para>Initialize for float variables <emphasis>x</emphasis> with decay factor <emphasis>d</emphasis>. </para> </briefdescription>
<detaileddescription>
<para>If the branch merit function <emphasis>bm</emphasis> is different from NULL, the activity for each variable is initialized with the merit returned by <emphasis>bm</emphasis>. </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/float.hh" line="1477" column="1"/>
</memberdef>
<memberdef kind="function" id="group__TaskModelFloatArith_1ga555e39bc516e4fb22f9f09660aadfb4b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>GECODE_FLOAT_EXPORT void</type>
<definition>GECODE_FLOAT_EXPORT void Gecode::FloatActivity::init</definition>
<argsstring>(Home, const FloatVarArgs &amp;x, double d=1.0, FloatBranchMerit bm=NULL)</argsstring>
<name>init</name>
<param>
<type><ref refid="classGecode_1_1Home" kindref="compound">Home</ref></type>
</param>
<param>
<type>const <ref refid="classGecode_1_1FloatVarArgs" kindref="compound">FloatVarArgs</ref> &amp;</type>
<declname>x</declname>
</param>
<param>
<type>double</type>
<declname>d</declname>
<defval>1.0</defval>
</param>
<param>
<type><ref refid="group__TaskModelFloatBranch_1ga7eb7e1523e3550892c106a552e11df68" kindref="member">FloatBranchMerit</ref></type>
<declname>bm</declname>
<defval>NULL</defval>
</param>
<briefdescription>
<para>Initialize for float variables <emphasis>x</emphasis> with decay factor <emphasis>d</emphasis>. </para> </briefdescription>
<detaileddescription>
<para>If the branch merit function <emphasis>bm</emphasis> is different from NULL, the activity for each variable is initialized with the merit returned by <emphasis>bm</emphasis>.</para><para>This member function can only be used once and only if the activity storage has been constructed with the default constructor. </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/float.hh" line="1491" column="1"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>Recording activities for float variables. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inheritancegraph>
<node id="2356">
<label>Gecode::FloatActivity</label>
<link refid="classGecode_1_1FloatActivity"/>
<childnode refid="2357" relation="public-inheritance">
</childnode>
</node>
<node id="2357">
<label>Gecode::Activity</label>
<link refid="classGecode_1_1Activity"/>
</node>
</inheritancegraph>
<collaborationgraph>
<node id="2358">
<label>Gecode::FloatActivity</label>
<link refid="classGecode_1_1FloatActivity"/>
<childnode refid="2359" relation="public-inheritance">
</childnode>
</node>
<node id="2360">
<label>Gecode::Activity::Storage</label>
<link refid="classGecode_1_1Activity_1_1Storage"/>
<childnode refid="2361" relation="usage">
<edgelabel>m</edgelabel>
</childnode>
</node>
<node id="2359">
<label>Gecode::Activity</label>
<link refid="classGecode_1_1Activity"/>
<childnode refid="2359" relation="usage">
<edgelabel>def</edgelabel>
</childnode>
<childnode refid="2360" relation="usage">
<edgelabel>storage</edgelabel>
</childnode>
</node>
<node id="2361">
<label>Gecode::Support::Mutex</label>
<link refid="classGecode_1_1Support_1_1Mutex"/>
</node>
</collaborationgraph>
<location file="/usr/include/gecode/float.hh" line="1454" column="1" bodyfile="/usr/include/gecode/float.hh" bodystart="1454" bodyend="1493"/>
<listofallmembers>
<member refid="classGecode_1_1Activity_1ad6b32f8c30378172e1fbc25e161c4897" prot="protected" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>acquire</name></member>
<member refid="classGecode_1_1Activity_1a10de627a991b3595095f19841273f6a3" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>Activity</name></member>
<member refid="classGecode_1_1Activity_1ae0177bd66469e93d20fc0d9bc857053f" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>Activity</name></member>
<member refid="classGecode_1_1Activity_1a7340b51a56e559b8c283c2f5db1e9a02" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>Activity</name></member>
<member refid="classGecode_1_1Activity_1ae12d220f39f8904d463303c8f9e441cb" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>Activity</name></member>
<member refid="classGecode_1_1Activity_1a4aa1f7831d1deb4c9a1f6401dc5c1e56" prot="protected" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>decay</name></member>
<member refid="classGecode_1_1Activity_1ac410d8671b6d4a03e8b93825190655d9" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>decay</name></member>
<member refid="classGecode_1_1Activity_1a91ab0666d7a87cc64d72f08172f34214" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>decay</name></member>
<member refid="classGecode_1_1Activity_1a0404a66fa10adfc71c78d21e118ae63c" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>def</name></member>
<member refid="group__TaskModelFloatArith_1ga7f5ead8275722edcb0a3638305e87360" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>FloatActivity</name></member>
<member refid="group__TaskModelFloatArith_1ga99750fe65f0e581125ac89fccd652f55" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>FloatActivity</name></member>
<member refid="group__TaskModelFloatArith_1gac086227df48febffb9a599fcc114f336" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>FloatActivity</name></member>
<member refid="group__TaskModelFloatArith_1ga555e39bc516e4fb22f9f09660aadfb4b" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>init</name></member>
<member refid="classGecode_1_1Activity_1aac313d45178d15a3de317f113c015d3f" prot="public" virt="non-virtual" ambiguityscope="Gecode::Activity::"><scope>Gecode::FloatActivity</scope><name>init</name></member>
<member refid="classGecode_1_1Activity_1a08e51b93b51a678716a27fe086cb5907" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>initialized</name></member>
<member refid="classGecode_1_1Activity_1a80bf8d266b1addba76bec44c8d00d334" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>operator&lt;&lt;</name></member>
<member refid="group__TaskModelFloatArith_1ga5367cc0b2a1d07677e7e7d722c159cd4" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>operator=</name></member>
<member refid="classGecode_1_1Activity_1ae2ba02a74bb88628d8ab212f0683f9ee" prot="public" virt="non-virtual" ambiguityscope="Gecode::Activity::"><scope>Gecode::FloatActivity</scope><name>operator=</name></member>
<member refid="classGecode_1_1Activity_1acc7a5da621120ececd06adaea6acb358" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>operator[]</name></member>
<member refid="classGecode_1_1Activity_1ae216c933c125db93cd1bd618b5ff579e" prot="protected" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>release</name></member>
<member refid="classGecode_1_1Activity_1a765b249f38da3e3624274f964c7b1172" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>set</name></member>
<member refid="classGecode_1_1Activity_1a4bbe8f1c09d0ade116d91bfd899168b7" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>size</name></member>
<member refid="classGecode_1_1Activity_1ab9ebdab4dba0d53455fcabb484e3c0fd" prot="protected" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>storage</name></member>
<member refid="classGecode_1_1Activity_1a007ec1ffb415dc85f4ff996adcdee3d4" prot="protected" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>update</name></member>
<member refid="classGecode_1_1Activity_1aa5890b4b03d4ba63cebeb8463d65ce2d" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>update</name></member>
<member refid="classGecode_1_1Activity_1acea7e2ae27b1a3e88cff288bbcf489fe" prot="public" virt="non-virtual"><scope>Gecode::FloatActivity</scope><name>~Activity</name></member>
</listofallmembers>
</compounddef>
</doxygen>