<?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.12.0" xml:lang="en-US">

<compounddef id="classtf_1_1IndexRange" kind="class" language="C++" prot="public">

<compoundname>tf::IndexRange</compoundname>

<includes refid="iterator_8hpp" local="no">taskflow/utility/iterator.hpp</includes>

<templateparamlist>

<param>

<type>typename T</type>

</param>

</templateparamlist>

<sectiondef kind="public-type">

<memberdef kind="typedef" id="classtf_1_1IndexRange_1a3cd586acdb38ba869833496c6d87e8df" prot="public" static="no">

<type>T</type>

<definition>using tf::IndexRange&lt; T &gt;::index_type = T</definition>

<argsstring></argsstring>

<name>index_type</name>

<qualifiedname>tf::IndexRange::index_type</qualifiedname>

<briefdescription>

<para>alias for the index type used in the range </para>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="131" column="3" bodyfile="taskflow/utility/iterator.hpp" bodystart="131" bodyend="-1"/>

</memberdef>

</sectiondef>

<sectiondef kind="private-attrib">

<memberdef kind="variable" id="classtf_1_1IndexRange_1ad07bb2a3f83ea55a9da2b79bfec80860" prot="private" static="no" mutable="no">

<type>T</type>

<definition>T tf::IndexRange&lt; T &gt;::_beg</definition>

<argsstring></argsstring>

<name>_beg</name>

<qualifiedname>tf::IndexRange::_beg</qualifiedname>

<briefdescription>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="229" column="5" bodyfile="taskflow/utility/iterator.hpp" bodystart="229" bodyend="-1"/>

</memberdef>

<memberdef kind="variable" id="classtf_1_1IndexRange_1a25ec20719388b32ffc20f46f6c6865f0" prot="private" static="no" mutable="no">

<type>T</type>

<definition>T tf::IndexRange&lt; T &gt;::_end</definition>

<argsstring></argsstring>

<name>_end</name>

<qualifiedname>tf::IndexRange::_end</qualifiedname>

<briefdescription>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="230" column="5" bodyfile="taskflow/utility/iterator.hpp" bodystart="230" bodyend="-1"/>

</memberdef>

<memberdef kind="variable" id="classtf_1_1IndexRange_1a6347193ad9681b2c4517d17dd2523014" prot="private" static="no" mutable="no">

<type>T</type>

<definition>T tf::IndexRange&lt; T &gt;::_step_size</definition>

<argsstring></argsstring>

<name>_step_size</name>

<qualifiedname>tf::IndexRange::_step_size</qualifiedname>

<briefdescription>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="231" column="5" bodyfile="taskflow/utility/iterator.hpp" bodystart="231" bodyend="-1"/>

</memberdef>

</sectiondef>

<sectiondef kind="public-func">

<memberdef kind="function" id="classtf_1_1IndexRange_1ab67d261986b699206aa8af8d1dc3e2b7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">

<type></type>

<definition>tf::IndexRange&lt; T &gt;::IndexRange</definition>

<argsstring>()=default</argsstring>

<name>IndexRange</name>

<qualifiedname>tf::IndexRange::IndexRange</qualifiedname>

<briefdescription>

<para>constructs an index range object without any initialization </para>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="136" column="3"/>

</memberdef>

<memberdef kind="function" id="classtf_1_1IndexRange_1ab9e48fe80add350412be71fa0a219e4d" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">

<type></type>

<definition>tf::IndexRange&lt; T &gt;::IndexRange</definition>

<argsstring>(T beg, T end, T step_size)</argsstring>

<name>IndexRange</name>

<qualifiedname>tf::IndexRange::IndexRange</qualifiedname>

<param>

<type>T</type>

<declname>beg</declname>

</param>

<param>

<type>T</type>

<declname>end</declname>

</param>

<param>

<type>T</type>

<declname>step_size</declname>

</param>

<briefdescription>

<para>constructs an <ref refid="classtf_1_1IndexRange" kindref="compound">IndexRange</ref> object </para>

</briefdescription>

<detaileddescription>

<para><parameterlist kind="param"><parameteritem>

<parameternamelist>

<parametername>beg</parametername>

</parameternamelist>

<parameterdescription>

<para>starting index of the range </para>

</parameterdescription>

</parameteritem>

<parameteritem>

<parameternamelist>

<parametername>end</parametername>

</parameternamelist>

<parameterdescription>

<para>ending index of the range (exclusive) </para>

</parameterdescription>

</parameteritem>

<parameteritem>

<parameternamelist>

<parametername>step_size</parametername>

</parameternamelist>

<parameterdescription>

<para>step size between consecutive indices in the range </para>

</parameterdescription>

</parameteritem>

</parameterlist>

</para>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="144" column="12" bodyfile="taskflow/utility/iterator.hpp" bodystart="144" bodyend="145"/>

</memberdef>

<memberdef kind="function" id="classtf_1_1IndexRange_1a2b52381358ab392efa257e185a33d4af" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">

<type>T</type>

<definition>T tf::IndexRange&lt; T &gt;::begin</definition>

<argsstring>() const</argsstring>

<name>begin</name>

<qualifiedname>tf::IndexRange::begin</qualifiedname>

<briefdescription>

<para>queries the starting index of the range </para>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="150" column="5" bodyfile="taskflow/utility/iterator.hpp" bodystart="150" bodyend="150"/>

</memberdef>

<memberdef kind="function" id="classtf_1_1IndexRange_1a280096cb4056bc19b86da77d019434e4" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">

<type>T</type>

<definition>T tf::IndexRange&lt; T &gt;::end</definition>

<argsstring>() const</argsstring>

<name>end</name>

<qualifiedname>tf::IndexRange::end</qualifiedname>

<briefdescription>

<para>queries the ending index of the range </para>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="155" column="5" bodyfile="taskflow/utility/iterator.hpp" bodystart="155" bodyend="155"/>

</memberdef>

<memberdef kind="function" id="classtf_1_1IndexRange_1aafd4f2d04614e550649cd9b7912e0bf1" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">

<type>T</type>

<definition>T tf::IndexRange&lt; T &gt;::step_size</definition>

<argsstring>() const</argsstring>

<name>step_size</name>

<qualifiedname>tf::IndexRange::step_size</qualifiedname>

<briefdescription>

<para>queries the step size of the range </para>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="160" column="5" bodyfile="taskflow/utility/iterator.hpp" bodystart="160" bodyend="160"/>

</memberdef>

<memberdef kind="function" id="classtf_1_1IndexRange_1a9cf7948f33d491f1bffe03a8d990bf13" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">

<type><ref refid="classtf_1_1IndexRange" kindref="compound">IndexRange</ref>&lt; T &gt; &amp;</type>

<definition>IndexRange&lt; T &gt; &amp; tf::IndexRange&lt; T &gt;::reset</definition>

<argsstring>(T begin, T end, T step_size)</argsstring>

<name>reset</name>

<qualifiedname>tf::IndexRange::reset</qualifiedname>

<param>

<type>T</type>

<declname>begin</declname>

</param>

<param>

<type>T</type>

<declname>end</declname>

</param>

<param>

<type>T</type>

<declname>step_size</declname>

</param>

<briefdescription>

<para>updates the range with the new starting index, ending index, and step size </para>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="165" column="14" bodyfile="taskflow/utility/iterator.hpp" bodystart="165" bodyend="170"/>

</memberdef>

<memberdef kind="function" id="classtf_1_1IndexRange_1addb769bccbcd30a680c59567876a24b7" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">

<type><ref refid="classtf_1_1IndexRange" kindref="compound">IndexRange</ref>&lt; T &gt; &amp;</type>

<definition>IndexRange&lt; T &gt; &amp; tf::IndexRange&lt; T &gt;::begin</definition>

<argsstring>(T new_begin)</argsstring>

<name>begin</name>

<qualifiedname>tf::IndexRange::begin</qualifiedname>

<param>

<type>T</type>

<declname>new_begin</declname>

</param>

<briefdescription>

<para>updates the starting index of the range </para>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="175" column="14" bodyfile="taskflow/utility/iterator.hpp" bodystart="175" bodyend="175"/>

</memberdef>

<memberdef kind="function" id="classtf_1_1IndexRange_1a96da4e7d6c1e975f08a44d52534c82b0" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">

<type><ref refid="classtf_1_1IndexRange" kindref="compound">IndexRange</ref>&lt; T &gt; &amp;</type>

<definition>IndexRange&lt; T &gt; &amp; tf::IndexRange&lt; T &gt;::end</definition>

<argsstring>(T new_end)</argsstring>

<name>end</name>

<qualifiedname>tf::IndexRange::end</qualifiedname>

<param>

<type>T</type>

<declname>new_end</declname>

</param>

<briefdescription>

<para>updates the ending index of the range </para>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="180" column="14" bodyfile="taskflow/utility/iterator.hpp" bodystart="180" bodyend="180"/>

</memberdef>

<memberdef kind="function" id="classtf_1_1IndexRange_1aa63f63345d773c9dd98e368579882f29" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">

<type><ref refid="classtf_1_1IndexRange" kindref="compound">IndexRange</ref>&lt; T &gt; &amp;</type>

<definition>IndexRange&lt; T &gt; &amp; tf::IndexRange&lt; T &gt;::step_size</definition>

<argsstring>(T new_step_size)</argsstring>

<name>step_size</name>

<qualifiedname>tf::IndexRange::step_size</qualifiedname>

<param>

<type>T</type>

<declname>new_step_size</declname>

</param>

<briefdescription>

<para>updates the step size of the range </para>

</briefdescription>

<detaileddescription>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="185" column="14" bodyfile="taskflow/utility/iterator.hpp" bodystart="185" bodyend="185"/>

</memberdef>

<memberdef kind="function" id="classtf_1_1IndexRange_1a2146e73c53a5f3dde2cda3c659b8b064" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">

<type>size_t</type>

<definition>size_t tf::IndexRange&lt; T &gt;::size</definition>

<argsstring>() const</argsstring>

<name>size</name>

<qualifiedname>tf::IndexRange::size</qualifiedname>

<briefdescription>

<para>queries the number of elements in the range </para>

</briefdescription>

<detaileddescription>

<para>The number of elements is equivalent to the number of iterations in the range. For instance, the range [0, 10) with step size of 2 will iterate five elements, 0, 2, 4, 6, and 8.</para>

<para><programlisting filename=".cpp"><codeline><highlight class="normal"><ref refid="classtf_1_1IndexRange" kindref="compound">tf::IndexRange&lt;int&gt;</ref><sp/>range(0,<sp/>10,<sp/>2);</highlight></codeline>

<codeline><highlight class="normal"><ref refid="cpp/io/c/fprintf" kindref="compound" external="/Users/twhuang/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">printf</ref>(</highlight><highlight class="stringliteral">&quot;%zu\n&quot;</highlight><highlight class="normal">,<sp/>range.size());<sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>5<sp/>(0,<sp/>2,<sp/>4,<sp/>6,<sp/>8)</highlight></codeline>

</programlisting> </para>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="199" column="10" bodyfile="taskflow/utility/iterator.hpp" bodystart="199" bodyend="199"/>

</memberdef>

<memberdef kind="function" id="classtf_1_1IndexRange_1abe3a1bf7a912d73ead27e3375cc660d7" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">

<type><ref refid="classtf_1_1IndexRange" kindref="compound">IndexRange</ref></type>

<definition>IndexRange tf::IndexRange&lt; T &gt;::discrete_domain</definition>

<argsstring>(size_t part_beg, size_t part_end) const</argsstring>

<name>discrete_domain</name>

<qualifiedname>tf::IndexRange::discrete_domain</qualifiedname>

<param>

<type>size_t</type>

<declname>part_beg</declname>

</param>

<param>

<type>size_t</type>

<declname>part_end</declname>

</param>

<briefdescription>

<para>returns a range from the given discrete domain </para>

</briefdescription>

<detaileddescription>

<para><parameterlist kind="param"><parameteritem>

<parameternamelist>

<parametername>part_beg</parametername>

</parameternamelist>

<parameterdescription>

<para>starting index of the discrete domain </para>

</parameterdescription>

</parameteritem>

<parameteritem>

<parameternamelist>

<parametername>part_end</parametername>

</parameternamelist>

<parameterdescription>

<para>ending index of the discrete domain </para>

</parameterdescription>

</parameteritem>

</parameterlist>

<simplesect kind="return"><para>a new <ref refid="classtf_1_1IndexRange" kindref="compound">IndexRange</ref> object representing the given discrete domain</para>

</simplesect>

The discrete domain of a range refers to a counter-based sequence indexed from 0 to <computeroutput>N</computeroutput>, where <computeroutput>N</computeroutput> is the size (i.e., number of iterated elements) of the range. For example, a discrete domain of the range [0, 10) with a step size of 2 corresponds to the sequence 0, 1, 2, 3, and 4, which map to the range elements 0, 2, 4, 6, and 8.</para>

<para>For a partitioned domain [<computeroutput>part_beg</computeroutput>, <computeroutput>part_end</computeroutput>), this function returns the corresponding range. For instance, the partitioned domain [2, 5) for the above example returns the range [4, 10) with the same step size of 2.</para>

<para><simplesect kind="attention"><para>Users must ensure the specified domain is valid with respect to the range. </para>

</simplesect>

</para>

</detaileddescription>

<inbodydescription>

</inbodydescription>

<location file="taskflow/utility/iterator.hpp" line="219" column="14" bodyfile="taskflow/utility/iterator.hpp" bodystart="219" bodyend="225"/>

</memberdef>

</sectiondef>

<briefdescription>

<para>class to create an index range of integral indices with a step size </para>

</briefdescription>

<detaileddescription>

<para><parameterlist kind="templateparam"><parameteritem>

<parameternamelist>

<parametername>T</parametername>

</parameternamelist>

<parameterdescription>

<para>the integral type of the indices</para>

</parameterdescription>

</parameteritem>

</parameterlist>

This class provides functionality for managing a range of indices, where the range is defined by a starting index, an ending index, and a step size. Indices must be an integral type. For example, the range `[0, 10) with a step size 2 represents the five elements, 0, 2, 4, 6, and 8.</para>

<para><programlisting filename=".cpp"><codeline><highlight class="normal"><ref refid="classtf_1_1IndexRange" kindref="compound">tf::IndexRange&lt;int&gt;</ref><sp/>range(0,<sp/>10,<sp/>2);</highlight></codeline>

<codeline><highlight class="normal"></highlight><highlight class="keywordflow">for</highlight><highlight class="normal">(</highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/>i=range.begin();<sp/>i&lt;range.end();<sp/>i+=range.step_size())<sp/>{</highlight></codeline>

<codeline><highlight class="normal"><sp/><sp/><ref refid="cpp/io/c/fprintf" kindref="compound" external="/Users/twhuang/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">printf</ref>(</highlight><highlight class="stringliteral">&quot;%d<sp/>&quot;</highlight><highlight class="normal">,<sp/>i);</highlight></codeline>

<codeline><highlight class="normal">}</highlight></codeline>

</programlisting></para>

<para>You can reset the range to a different value using <ref refid="classtf_1_1IndexRange_1a9cf7948f33d491f1bffe03a8d990bf13" kindref="member">tf::IndexRange::reset</ref>. This is particularly useful when the range value is only known at runtime.</para>

<para><programlisting filename=".cpp"><codeline><highlight class="normal"><ref refid="classtf_1_1IndexRange" kindref="compound">tf::IndexRange&lt;int&gt;</ref><sp/>range;</highlight></codeline>

<codeline><highlight class="normal">range.<ref refid="classtf_1_1IndexRange_1a9cf7948f33d491f1bffe03a8d990bf13" kindref="member">reset</ref>(0,<sp/>10,<sp/>2);</highlight></codeline>

<codeline><highlight class="normal"></highlight><highlight class="keywordflow">for</highlight><highlight class="normal">(</highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/>i=range.<ref refid="classtf_1_1IndexRange_1a2b52381358ab392efa257e185a33d4af" kindref="member">begin</ref>();<sp/>i&lt;range.<ref refid="classtf_1_1IndexRange_1a280096cb4056bc19b86da77d019434e4" kindref="member">end</ref>();<sp/>i+=range.<ref refid="classtf_1_1IndexRange_1aafd4f2d04614e550649cd9b7912e0bf1" kindref="member">step_size</ref>())<sp/>{</highlight></codeline>

<codeline><highlight class="normal"><sp/><sp/><ref refid="cpp/io/c/fprintf" kindref="compound" external="/Users/twhuang/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">printf</ref>(</highlight><highlight class="stringliteral">&quot;%d<sp/>&quot;</highlight><highlight class="normal">,<sp/>i);</highlight></codeline>

<codeline><highlight class="normal">}</highlight></codeline>

</programlisting></para>

<para><simplesect kind="attention"><para>It is user&apos;s responsibility to ensure the given range is valid. For instance, a range from 0 to 10 with a step size of -2 is invalid. </para>

</simplesect>

</para>

</detaileddescription>

<location file="taskflow/utility/iterator.hpp" line="122" column="1" bodyfile="taskflow/utility/iterator.hpp" bodystart="122" bodyend="233"/>

<listofallmembers>

<member refid="classtf_1_1IndexRange_1ad07bb2a3f83ea55a9da2b79bfec80860" prot="private" virt="non-virtual"><scope>tf::IndexRange</scope><name>_beg</name></member>

<member refid="classtf_1_1IndexRange_1a25ec20719388b32ffc20f46f6c6865f0" prot="private" virt="non-virtual"><scope>tf::IndexRange</scope><name>_end</name></member>

<member refid="classtf_1_1IndexRange_1a6347193ad9681b2c4517d17dd2523014" prot="private" virt="non-virtual"><scope>tf::IndexRange</scope><name>_step_size</name></member>

<member refid="classtf_1_1IndexRange_1a2b52381358ab392efa257e185a33d4af" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>begin</name></member>

<member refid="classtf_1_1IndexRange_1addb769bccbcd30a680c59567876a24b7" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>begin</name></member>

<member refid="classtf_1_1IndexRange_1abe3a1bf7a912d73ead27e3375cc660d7" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>discrete_domain</name></member>

<member refid="classtf_1_1IndexRange_1a280096cb4056bc19b86da77d019434e4" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>end</name></member>

<member refid="classtf_1_1IndexRange_1a96da4e7d6c1e975f08a44d52534c82b0" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>end</name></member>

<member refid="classtf_1_1IndexRange_1a3cd586acdb38ba869833496c6d87e8df" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>index_type</name></member>

<member refid="classtf_1_1IndexRange_1ab67d261986b699206aa8af8d1dc3e2b7" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>IndexRange</name></member>

<member refid="classtf_1_1IndexRange_1ab9e48fe80add350412be71fa0a219e4d" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>IndexRange</name></member>

<member refid="classtf_1_1IndexRange_1a9cf7948f33d491f1bffe03a8d990bf13" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>reset</name></member>

<member refid="classtf_1_1IndexRange_1a2146e73c53a5f3dde2cda3c659b8b064" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>size</name></member>

<member refid="classtf_1_1IndexRange_1aafd4f2d04614e550649cd9b7912e0bf1" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>step_size</name></member>

<member refid="classtf_1_1IndexRange_1aa63f63345d773c9dd98e368579882f29" prot="public" virt="non-virtual"><scope>tf::IndexRange</scope><name>step_size</name></member>

</listofallmembers>

</compounddef>

</doxygen>