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

308 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_1DFA" kind="class" prot="public">
<compoundname>Gecode::DFA</compoundname>
<basecompoundref refid="classGecode_1_1SharedHandle" prot="public" virt="non-virtual">Gecode::SharedHandle</basecompoundref>
<includes refid="int_8hh" local="no">int.hh</includes>
<innerclass refid="classGecode_1_1DFA_1_1DFAI" prot="public">Gecode::DFA::DFAI</innerclass>
<innerclass refid="classGecode_1_1DFA_1_1Symbols" prot="public">Gecode::DFA::Symbols</innerclass>
<innerclass refid="classGecode_1_1DFA_1_1Transition" prot="public">Gecode::DFA::Transition</innerclass>
<innerclass refid="classGecode_1_1DFA_1_1Transitions" prot="public">Gecode::DFA::Transitions</innerclass>
<sectiondef kind="friend">
<memberdef kind="friend" id="classGecode_1_1DFA_1a4614c62c367c134054c5c855e522a13d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>friend class</type>
<definition>friend class Transitions</definition>
<argsstring></argsstring>
<name>Transitions</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1936" column="1" bodyfile="/usr/include/gecode/int.hh" bodystart="1936" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
<memberdef kind="function" id="classGecode_1_1DFA_1a8b3ad99521ad89006da7ed82afe71a86" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>forceinline Gecode::DFA::DFA</definition>
<argsstring>(void)</argsstring>
<name>DFA</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Initialize for <ref refid="classGecode_1_1DFA" kindref="compound">DFA</ref> accepting the empty word. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1938" column="1" bodyfile="/usr/include/gecode/int/extensional/dfa.hpp" bodystart="97" bodyend="97"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1DFA_1a3849009aa55c066559b3215c6f701cf3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>GECODE_INT_EXPORT</type>
<definition>GECODE_INT_EXPORT Gecode::DFA::DFA</definition>
<argsstring>(int s, Transition t[], int f[], bool minimize=true)</argsstring>
<name>DFA</name>
<param>
<type>int</type>
<declname>s</declname>
</param>
<param>
<type><ref refid="classGecode_1_1DFA_1_1Transition" kindref="compound">Transition</ref></type>
<declname>t</declname>
<array>[]</array>
</param>
<param>
<type>int</type>
<declname>f</declname>
<array>[]</array>
</param>
<param>
<type>bool</type>
<declname>minimize</declname>
<defval>true</defval>
</param>
<briefdescription>
<para>Initialize <ref refid="classGecode_1_1DFA" kindref="compound">DFA</ref>. </para> </briefdescription>
<detaileddescription>
<para><itemizedlist>
<listitem><para>Start state is given by <emphasis>s</emphasis>.</para></listitem><listitem><para>Transitions are described by <emphasis>t</emphasis>, where the last element must have -1 as value for <computeroutput>i_state</computeroutput>.</para></listitem><listitem><para>Final states are given by <emphasis>f</emphasis>, where the last final element must be -1.</para></listitem><listitem><para>Minimizes the <ref refid="classGecode_1_1DFA" kindref="compound">DFA</ref>, if <emphasis>minimize</emphasis> is true.</para></listitem><listitem><para>Note that the transitions must be deterministic. </para></listitem></itemizedlist>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1951" column="1"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1DFA_1a0c6bcec16126de0beb5aa6fe3e7553f2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>forceinline Gecode::DFA::DFA</definition>
<argsstring>(const DFA &amp;d)</argsstring>
<name>DFA</name>
<param>
<type>const <ref refid="classGecode_1_1DFA" kindref="compound">DFA</ref> &amp;</type>
<declname>d</declname>
</param>
<briefdescription>
<para>Initialize by <ref refid="classGecode_1_1DFA" kindref="compound">DFA</ref> <emphasis>d</emphasis> (<ref refid="classGecode_1_1DFA" kindref="compound">DFA</ref> is shared) </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1953" column="1" bodyfile="/usr/include/gecode/int/extensional/dfa.hpp" bodystart="101" bodyend="102"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1DFA_1ae5c1b94c0fa595447b0f3ffb1452fa91" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>forceinline int Gecode::DFA::n_states</definition>
<argsstring>(void) const </argsstring>
<name>n_states</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Return the number of states. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1955" column="1" bodyfile="/usr/include/gecode/int/extensional/dfa.hpp" bodystart="105" bodyend="108"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1DFA_1a8af231e01409787b0ca3cae56ed91654" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>forceinline int Gecode::DFA::n_transitions</definition>
<argsstring>(void) const </argsstring>
<name>n_transitions</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Return the number of transitions. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1957" column="1" bodyfile="/usr/include/gecode/int/extensional/dfa.hpp" bodystart="117" bodyend="120"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1DFA_1a85b8deaaca6e1e59f8ccc98f398fe1eb" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>unsigned int</type>
<definition>forceinline unsigned int Gecode::DFA::n_symbols</definition>
<argsstring>(void) const </argsstring>
<name>n_symbols</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Return the number of symbols. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1959" column="1" bodyfile="/usr/include/gecode/int/extensional/dfa.hpp" bodystart="111" bodyend="114"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1DFA_1a23fac135eafb75a4848518aaced156d3" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>unsigned int</type>
<definition>forceinline unsigned int Gecode::DFA::max_degree</definition>
<argsstring>(void) const </argsstring>
<name>max_degree</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Return maximal degree (in-degree and out-degree) of any state. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1961" column="1" bodyfile="/usr/include/gecode/int/extensional/dfa.hpp" bodystart="123" bodyend="126"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1DFA_1a4969795a3a6a36a1e9e2015409f7575b" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>forceinline int Gecode::DFA::final_fst</definition>
<argsstring>(void) const </argsstring>
<name>final_fst</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Return the number of the first final state. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1963" column="1" bodyfile="/usr/include/gecode/int/extensional/dfa.hpp" bodystart="129" bodyend="132"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1DFA_1a82339116e940c76001c589a54cd043c3" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>forceinline int Gecode::DFA::final_lst</definition>
<argsstring>(void) const </argsstring>
<name>final_lst</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Return the number of the last final state. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1965" column="1" bodyfile="/usr/include/gecode/int/extensional/dfa.hpp" bodystart="135" bodyend="138"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1DFA_1aa086b433e158f8767a243001c19038ab" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>forceinline int Gecode::DFA::symbol_min</definition>
<argsstring>(void) const </argsstring>
<name>symbol_min</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Return smallest symbol in <ref refid="classGecode_1_1DFA" kindref="compound">DFA</ref>. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1967" column="1" bodyfile="/usr/include/gecode/int/extensional/dfa.hpp" bodystart="141" bodyend="145"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1DFA_1a0100d3308b398b48465e53f6810f4fcb" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>forceinline int Gecode::DFA::symbol_max</definition>
<argsstring>(void) const </argsstring>
<name>symbol_max</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Return largest symbol in <ref refid="classGecode_1_1DFA" kindref="compound">DFA</ref>. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="1969" column="1" bodyfile="/usr/include/gecode/int/extensional/dfa.hpp" bodystart="148" bodyend="152"/>
</memberdef>
</sectiondef>
<sectiondef kind="related">
<memberdef kind="function" id="classGecode_1_1DFA_1a04595ea6486c336dc02d2fa870886dc8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<templateparamlist>
<param>
<type>class Char</type>
</param>
<param>
<type>class Traits</type>
</param>
</templateparamlist>
<type>std::basic_ostream&lt; Char, Traits &gt; &amp;</type>
<definition>std::basic_ostream&lt; Char, Traits &gt; &amp; operator&lt;&lt;</definition>
<argsstring>(std::basic_ostream&lt; Char, Traits &gt; &amp;os, const DFA &amp;d)</argsstring>
<name>operator&lt;&lt;</name>
<param>
<type>std::basic_ostream&lt; Char, Traits &gt; &amp;</type>
<declname>os</declname>
</param>
<param>
<type>const <ref refid="classGecode_1_1DFA" kindref="compound">DFA</ref> &amp;</type>
<declname>d</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
<para>Print <ref refid="classGecode_1_1DFA" kindref="compound">DFA</ref> <emphasis>d</emphasis> </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/int.hh" line="4156" column="1" bodyfile="/usr/include/gecode/int/extensional/dfa.hpp" bodystart="260" bodyend="287"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>Deterministic finite automaton (DFA) </para> </briefdescription>
<detaileddescription>
<para>After initialization, the start state is always zero. The final states are contiguous ranging from the first to the last final state. </para> </detaileddescription>
<inheritancegraph>
<node id="1646">
<label>Gecode::SharedHandle</label>
<link refid="classGecode_1_1SharedHandle"/>
</node>
<node id="1645">
<label>Gecode::DFA</label>
<link refid="classGecode_1_1DFA"/>
<childnode refid="1646" relation="public-inheritance">
</childnode>
</node>
</inheritancegraph>
<collaborationgraph>
<node id="1648">
<label>Gecode::SharedHandle</label>
<link refid="classGecode_1_1SharedHandle"/>
</node>
<node id="1647">
<label>Gecode::DFA</label>
<link refid="classGecode_1_1DFA"/>
<childnode refid="1648" relation="public-inheritance">
</childnode>
</node>
</collaborationgraph>
<location file="/usr/include/gecode/int.hh" line="1879" column="1" bodyfile="/usr/include/gecode/int.hh" bodystart="1879" bodyend="1970"/>
<listofallmembers>
<member refid="classGecode_1_1DFA_1a8b3ad99521ad89006da7ed82afe71a86" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>DFA</name></member>
<member refid="classGecode_1_1DFA_1a3849009aa55c066559b3215c6f701cf3" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>DFA</name></member>
<member refid="classGecode_1_1DFA_1a0c6bcec16126de0beb5aa6fe3e7553f2" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>DFA</name></member>
<member refid="classGecode_1_1DFA_1a4969795a3a6a36a1e9e2015409f7575b" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>final_fst</name></member>
<member refid="classGecode_1_1DFA_1a82339116e940c76001c589a54cd043c3" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>final_lst</name></member>
<member refid="classGecode_1_1DFA_1a23fac135eafb75a4848518aaced156d3" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>max_degree</name></member>
<member refid="classGecode_1_1DFA_1ae5c1b94c0fa595447b0f3ffb1452fa91" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>n_states</name></member>
<member refid="classGecode_1_1DFA_1a85b8deaaca6e1e59f8ccc98f398fe1eb" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>n_symbols</name></member>
<member refid="classGecode_1_1DFA_1a8af231e01409787b0ca3cae56ed91654" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>n_transitions</name></member>
<member refid="classGecode_1_1SharedHandle_1a703f11794c6cac8c22bfc4a4136eb4f8" prot="protected" virt="non-virtual"><scope>Gecode::DFA</scope><name>object</name></member>
<member refid="classGecode_1_1SharedHandle_1a688e41d609c30fe5517ca35cf908ddee" prot="protected" virt="non-virtual"><scope>Gecode::DFA</scope><name>object</name></member>
<member refid="classGecode_1_1DFA_1a04595ea6486c336dc02d2fa870886dc8" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>operator&lt;&lt;</name></member>
<member refid="classGecode_1_1SharedHandle_1ae484ef9621e41e100aa778b8c908f65e" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>operator=</name></member>
<member refid="classGecode_1_1SharedHandle_1a421b3931301cdbd047737c7eb920097c" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>SharedHandle</name></member>
<member refid="classGecode_1_1SharedHandle_1a7af0bf287aedc0181643f91ee7f94b92" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>SharedHandle</name></member>
<member refid="classGecode_1_1SharedHandle_1aad7da499195487bdf3085d61ed83d004" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>SharedHandle</name></member>
<member refid="classGecode_1_1DFA_1a0100d3308b398b48465e53f6810f4fcb" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>symbol_max</name></member>
<member refid="classGecode_1_1DFA_1aa086b433e158f8767a243001c19038ab" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>symbol_min</name></member>
<member refid="classGecode_1_1DFA_1a4614c62c367c134054c5c855e522a13d" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>Transitions</name></member>
<member refid="classGecode_1_1SharedHandle_1afeb40b81ba09fed2539490f1035788f8" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>update</name></member>
<member refid="classGecode_1_1SharedHandle_1abdf052ec870b883c26b79538296819f8" prot="public" virt="non-virtual"><scope>Gecode::DFA</scope><name>~SharedHandle</name></member>
</listofallmembers>
</compounddef>
</doxygen>