Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-updates > by-pkgid > d5e62c01ae8d1e579463c6a871dd44bf > files > 872

qtbase5-doc-5.12.6-2.mga7.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- contiguouscache.qdoc -->
  <title>Contiguous Cache Example | Qt Core 5.12.6</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.12</td><td ><a href="qtcore-index.html">Qt Core</a></td><td >Contiguous Cache Example</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtcore-index.html">Qt 5.12.6 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Contiguous Cache Example</h1>
<span class="subtitle"></span>
<!-- $$$tools/contiguouscache-brief -->
<p>The Contiguous Cache example shows how to use <a href="qcontiguouscache.html">QContiguousCache</a> to manage memory usage for very large models. In some environments memory is limited and, even when it isn't, users still dislike an application using excessive memory. Using <a href="qcontiguouscache.html">QContiguousCache</a> to manage a list, rather than loading the entire list into memory, allows the application to limit the amount of memory it uses, regardless of the size of the data set it accesses.</p>
<!-- @@@tools/contiguouscache -->
<!-- $$$tools/contiguouscache-description -->
<div class="descr"> <a name="details"></a>
<p>The simplest way to use <a href="qcontiguouscache.html">QContiguousCache</a> is to cache as items are requested. When a view requests an item at row N it is also likely to ask for items at rows near to N.</p>
<pre class="cpp">

  <span class="type"><a href="qvariant.html">QVariant</a></span> RandomListModel<span class="operator">::</span>data(<span class="keyword">const</span> <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> <span class="operator">&amp;</span>index<span class="operator">,</span> <span class="type">int</span> role) <span class="keyword">const</span>
  {
      <span class="keyword">if</span> (role <span class="operator">!</span><span class="operator">=</span> <span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>DisplayRole)
          <span class="keyword">return</span> <span class="type"><a href="qvariant.html">QVariant</a></span>();

      <span class="type">int</span> row <span class="operator">=</span> index<span class="operator">.</span>row();

      <span class="keyword">if</span> (row <span class="operator">&gt;</span> m_rows<span class="operator">.</span>lastIndex()) {
          <span class="keyword">if</span> (row <span class="operator">-</span> m_rows<span class="operator">.</span>lastIndex() <span class="operator">&gt;</span> lookAhead)
              cacheRows(row<span class="operator">-</span>halfLookAhead<span class="operator">,</span> <a href="qtglobal.html#qMin">qMin</a>(m_count<span class="operator">,</span> row<span class="operator">+</span>halfLookAhead));
          <span class="keyword">else</span> <span class="keyword">while</span> (row <span class="operator">&gt;</span> m_rows<span class="operator">.</span>lastIndex())
              m_rows<span class="operator">.</span>append(fetchRow(m_rows<span class="operator">.</span>lastIndex()<span class="operator">+</span><span class="number">1</span>));
      } <span class="keyword">else</span> <span class="keyword">if</span> (row <span class="operator">&lt;</span> m_rows<span class="operator">.</span>firstIndex()) {
          <span class="keyword">if</span> (m_rows<span class="operator">.</span>firstIndex() <span class="operator">-</span> row <span class="operator">&gt;</span> lookAhead)
              cacheRows(<a href="qtglobal.html#qMax">qMax</a>(<span class="number">0</span><span class="operator">,</span> row<span class="operator">-</span>halfLookAhead)<span class="operator">,</span> row<span class="operator">+</span>halfLookAhead);
          <span class="keyword">else</span> <span class="keyword">while</span> (row <span class="operator">&lt;</span> m_rows<span class="operator">.</span>firstIndex())
              m_rows<span class="operator">.</span>prepend(fetchRow(m_rows<span class="operator">.</span>firstIndex()<span class="operator">-</span><span class="number">1</span>));
      }

      <span class="keyword">return</span> m_rows<span class="operator">.</span>at(row);
  }

  <span class="type">void</span> RandomListModel<span class="operator">::</span>cacheRows(<span class="type">int</span> from<span class="operator">,</span> <span class="type">int</span> to) <span class="keyword">const</span>
  {
      <span class="keyword">for</span> (<span class="type">int</span> i <span class="operator">=</span> from; i <span class="operator">&lt;</span><span class="operator">=</span> to; <span class="operator">+</span><span class="operator">+</span>i)
          m_rows<span class="operator">.</span>insert(i<span class="operator">,</span> fetchRow(i));
  }

</pre>
<p>After getting the row, the class determines if the row is in the bounds of the contiguous cache's current range. It would have been equally valid to simply have the following code instead.</p>
<pre class="cpp">

  <span class="keyword">while</span> (row <span class="operator">&gt;</span> m_rows<span class="operator">.</span>lastIndex())
      m_rows<span class="operator">.</span>append(fetchWord(m_rows<span class="operator">.</span>lastIndex()<span class="operator">+</span><span class="number">1</span>);
  <span class="keyword">while</span> (row <span class="operator">&lt;</span> m_rows<span class="operator">.</span>firstIndex())
      m_rows<span class="operator">.</span>prepend(fetchWord(m_rows<span class="operator">.</span>firstIndex()<span class="operator">-</span><span class="number">1</span>);

</pre>
<p>However a list will often jump rows if the scroll bar is used directly, resulting in the code above causing every row between the old and new rows to be fetched.</p>
<p>Using <a href="qcontiguouscache.html#lastIndex">QContiguousCache::lastIndex</a>() and <a href="qcontiguouscache.html#firstIndex">QContiguousCache::firstIndex</a>() allows the example to determine what part of the list the cache is currently caching. These values don't represent the indexes into the cache's own memory, but rather a virtual infinite array that the cache represents.</p>
<p>By using <a href="qcontiguouscache.html#append">QContiguousCache::append</a>() and <a href="qcontiguouscache.html#prepend">QContiguousCache::prepend</a>() the code ensures that items that may be still on the screen are not lost when the requested row has not moved far from the current cache range. <a href="qcontiguouscache.html#insert">QContiguousCache::insert</a>() can potentially remove more than one item from the cache as <a href="qcontiguouscache.html">QContiguousCache</a> does not allow for gaps. If your cache needs to quickly jump back and forth between rows with significant gaps between them consider using <a href="qcache.html">QCache</a> instead.</p>
<p>And thats it. A perfectly reasonable cache, using minimal memory for a very large list. In this case the accessor for getting the words into the cache generates random information rather than fixed information. This allows you to see how the cache range is kept for a local number of rows when running the example.</p>
<pre class="cpp">

  <span class="type"><a href="qstring.html">QString</a></span> RandomListModel<span class="operator">::</span>fetchRow(<span class="type">int</span> position) <span class="keyword">const</span>
  {
      <span class="keyword">return</span> <span class="type"><a href="qstring.html">QString</a></span><span class="operator">::</span>number(<span class="type"><a href="qrandomgenerator.html">QRandomGenerator</a></span><span class="operator">::</span>global()<span class="operator">-</span><span class="operator">&gt;</span>bounded(<span class="operator">+</span><span class="operator">+</span>position));
  }

</pre>
<p>It is also worth considering pre-fetching items into the cache outside of the application's paint routine. This can be done either with a separate thread or using a <a href="qtimer.html">QTimer</a> to incrementally expand the range of the cache prior to rows being requested out of the current cache range.</p>
<p>Files:</p>
<ul>
<li><a href="qtcore-tools-contiguouscache-contiguouscache-pro.html">tools/contiguouscache/contiguouscache.pro</a></li>
<li><a href="qtcore-tools-contiguouscache-main-cpp.html">tools/contiguouscache/main.cpp</a></li>
<li><a href="qtcore-tools-contiguouscache-randomlistmodel-cpp.html">tools/contiguouscache/randomlistmodel.cpp</a></li>
<li><a href="qtcore-tools-contiguouscache-randomlistmodel-h.html">tools/contiguouscache/randomlistmodel.h</a></li>
</ul>
</div>
<!-- @@@tools/contiguouscache -->
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2019 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>