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_1Slice.xml

231 lines
13 KiB
XML
Raw Normal View History

2014-01-22 09:41:47 +00:00
<?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_1Slice" kind="class" prot="public">
<compoundname>Gecode::Slice</compoundname>
<includes refid="minimodel_8hh" local="no">minimodel.hh</includes>
<templateparamlist>
<param>
<type>class</type>
<declname>A</declname>
<defname>A</defname>
</param>
</templateparamlist>
<sectiondef kind="public-type">
<memberdef kind="typedef" id="classGecode_1_1Slice_1ac22f49cd72ba044a071442b5cb176222" prot="public" static="no">
<type><ref refid="classGecode_1_1ArrayTraits" kindref="compound">ArrayTraits</ref>&lt; A &gt;::<ref refid="classGecode_1_1Slice_1ac22f49cd72ba044a071442b5cb176222" kindref="member">ArgsType</ref></type>
<definition>typedef ArrayTraits&lt;A&gt;::ArgsType Gecode::Slice&lt; A &gt;::ArgsType</definition>
<argsstring></argsstring>
<name>ArgsType</name>
<briefdescription>
<para>The type of the Args-array type for ValueType values. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1937" column="1" bodyfile="/usr/include/gecode/minimodel.hh" bodystart="1937" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="private-attrib">
<memberdef kind="variable" id="classGecode_1_1Slice_1aaf604c0df109cfc375e207c1cbf19aa2" prot="private" static="no" mutable="no">
<type><ref refid="classGecode_1_1Slice_1ac22f49cd72ba044a071442b5cb176222" kindref="member">ArgsType</ref></type>
<definition>ArgsType Gecode::Slice&lt; A &gt;::_r</definition>
<argsstring></argsstring>
<name>_r</name>
<briefdescription>
<para>The elements of the slice. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1939" column="1" bodyfile="/usr/include/gecode/minimodel.hh" bodystart="1939" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classGecode_1_1Slice_1a72a09a26a2fcca8879e6115568924374" prot="private" static="no" mutable="no">
<type>unsigned int</type>
<definition>unsigned int Gecode::Slice&lt; A &gt;::_fc</definition>
<argsstring></argsstring>
<name>_fc</name>
<briefdescription>
<para>From column. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1940" column="1" bodyfile="/usr/include/gecode/minimodel.hh" bodystart="1940" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classGecode_1_1Slice_1a0ddde08d694f141b12f4babfed9e9181" prot="private" static="no" mutable="no">
<type>unsigned int</type>
<definition>unsigned int Gecode::Slice&lt; A &gt;::_tc</definition>
<argsstring></argsstring>
<name>_tc</name>
<briefdescription>
<para>To column. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1941" column="1" bodyfile="/usr/include/gecode/minimodel.hh" bodystart="1940" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classGecode_1_1Slice_1acf87e2c46cd645abdc5f86ca9618cc9c" prot="private" static="no" mutable="no">
<type>unsigned int</type>
<definition>unsigned int Gecode::Slice&lt; A &gt;::_fr</definition>
<argsstring></argsstring>
<name>_fr</name>
<briefdescription>
<para>From row. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1942" column="1" bodyfile="/usr/include/gecode/minimodel.hh" bodystart="1940" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classGecode_1_1Slice_1af8bf608be9708e23fe80078ab5867151" prot="private" static="no" mutable="no">
<type>unsigned int</type>
<definition>unsigned int Gecode::Slice&lt; A &gt;::_tr</definition>
<argsstring></argsstring>
<name>_tr</name>
<briefdescription>
<para>To row. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1943" column="1" bodyfile="/usr/include/gecode/minimodel.hh" bodystart="1940" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
<memberdef kind="function" id="classGecode_1_1Slice_1a2892c85d4df789831f2a51e318178462" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
<type></type>
<definition>Gecode::Slice&lt; A &gt;::Slice</definition>
<argsstring>(const Matrix&lt; A &gt; &amp;a, int fc, int tc, int fr, int tr)</argsstring>
<name>Slice</name>
<param>
<type>const <ref refid="classGecode_1_1Matrix" kindref="compound">Matrix</ref>&lt; A &gt; &amp;</type>
<declname>a</declname>
</param>
<param>
<type>int</type>
<declname>fc</declname>
</param>
<param>
<type>int</type>
<declname>tc</declname>
</param>
<param>
<type>int</type>
<declname>fr</declname>
</param>
<param>
<type>int</type>
<declname>tr</declname>
</param>
<briefdescription>
<para>Construct slice. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1946" column="1" bodyfile="/usr/include/gecode/minimodel/matrix.hpp" bodystart="47" bodyend="62"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1Slice_1a9911bf16786784f3cbc430ffa43d8824" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classGecode_1_1Slice" kindref="compound">Slice</ref> &amp;</type>
<definition>Slice&lt; A &gt; &amp; Gecode::Slice&lt; A &gt;::reverse</definition>
<argsstring>(void)</argsstring>
<name>reverse</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Reverses the contents of the slice, and returns a reference to it. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1950" column="1" bodyfile="/usr/include/gecode/minimodel/matrix.hpp" bodystart="66" bodyend="70"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1Slice_1aa7b07d43a483d2d723fc7c6985efb03b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>forceinline Gecode::Slice&lt; A &gt;::operator ArgsType</definition>
<argsstring>(void)</argsstring>
<name>operator ArgsType</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Cast to array type. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1952" column="1" bodyfile="/usr/include/gecode/minimodel/matrix.hpp" bodystart="74" bodyend="76"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1Slice_1a8297d4cdf2cc0154a493e503382826d4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>Gecode::Slice&lt; A &gt;::operator Matrix&lt; ArgsType &gt;</definition>
<argsstring>(void)</argsstring>
<name>operator Matrix&lt; ArgsType &gt;</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Cast to matrix type. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1954" column="1"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1Slice_1a8e6b5fce9f99409804e6a1e958665c13" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>Gecode::Slice&lt; A &gt;::operator const ArgsType</definition>
<argsstring>(void) const </argsstring>
<name>operator const ArgsType</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Cast to array type. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1957" column="1"/>
</memberdef>
<memberdef kind="function" id="classGecode_1_1Slice_1a627367880a539ceead57e16f60368d1d" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>Gecode::Slice&lt; A &gt;::operator const Matrix&lt; ArgsType &gt;</definition>
<argsstring>(void) const </argsstring>
<name>operator const Matrix&lt; ArgsType &gt;</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Cast to matrix type. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/usr/include/gecode/minimodel.hh" line="1959" column="1"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>A slice of a matrix. </para> </briefdescription>
<detaileddescription>
<para>This class represents a slice of the matrix. It is used to get context-dependent behaviour. The slice will be automatically converted to an ArgsType Args-array or to a Matrix&lt;ArgsType&gt; depending on the context where it is used. </para> </detaileddescription>
<location file="/usr/include/gecode/minimodel.hh" line="1934" column="1" bodyfile="/usr/include/gecode/minimodel.hh" bodystart="1934" bodyend="1960"/>
<listofallmembers>
<member refid="classGecode_1_1Slice_1a72a09a26a2fcca8879e6115568924374" prot="private" virt="non-virtual"><scope>Gecode::Slice</scope><name>_fc</name></member>
<member refid="classGecode_1_1Slice_1acf87e2c46cd645abdc5f86ca9618cc9c" prot="private" virt="non-virtual"><scope>Gecode::Slice</scope><name>_fr</name></member>
<member refid="classGecode_1_1Slice_1aaf604c0df109cfc375e207c1cbf19aa2" prot="private" virt="non-virtual"><scope>Gecode::Slice</scope><name>_r</name></member>
<member refid="classGecode_1_1Slice_1a0ddde08d694f141b12f4babfed9e9181" prot="private" virt="non-virtual"><scope>Gecode::Slice</scope><name>_tc</name></member>
<member refid="classGecode_1_1Slice_1af8bf608be9708e23fe80078ab5867151" prot="private" virt="non-virtual"><scope>Gecode::Slice</scope><name>_tr</name></member>
<member refid="classGecode_1_1Slice_1ac22f49cd72ba044a071442b5cb176222" prot="public" virt="non-virtual"><scope>Gecode::Slice</scope><name>ArgsType</name></member>
<member refid="classGecode_1_1Slice_1aa7b07d43a483d2d723fc7c6985efb03b" prot="public" virt="non-virtual"><scope>Gecode::Slice</scope><name>operator ArgsType</name></member>
<member refid="classGecode_1_1Slice_1a8e6b5fce9f99409804e6a1e958665c13" prot="public" virt="non-virtual"><scope>Gecode::Slice</scope><name>operator const ArgsType</name></member>
<member refid="classGecode_1_1Slice_1a627367880a539ceead57e16f60368d1d" prot="public" virt="non-virtual"><scope>Gecode::Slice</scope><name>operator const Matrix&lt; ArgsType &gt;</name></member>
<member refid="classGecode_1_1Slice_1a8297d4cdf2cc0154a493e503382826d4" prot="public" virt="non-virtual"><scope>Gecode::Slice</scope><name>operator Matrix&lt; ArgsType &gt;</name></member>
<member refid="classGecode_1_1Slice_1a9911bf16786784f3cbc430ffa43d8824" prot="public" virt="non-virtual"><scope>Gecode::Slice</scope><name>reverse</name></member>
<member refid="classGecode_1_1Slice_1a2892c85d4df789831f2a51e318178462" prot="public" virt="non-virtual"><scope>Gecode::Slice</scope><name>Slice</name></member>
</listofallmembers>
</compounddef>
</doxygen>