dip-AlignedAllocInterface.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>dip::AlignedAllocInterface class | DIPlib | a library for quantitative image analysis</title>
  <link rel="stylesheet" href="m-dip+documentation.compiled.css" />
  <link rel="icon" href="DIPlib_logo_32.png" type="image/png" />
  <link rel="search" type="application/opensearchdescription+xml" href="opensearch.xml" title="Search DIPlib documentation" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#ffffff" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://diplib.org"><img src="DIPlib_logo.svg" alt="" />DIPlib</a><span class="m-breadcrumb">┃</span><a href="index.html" class="m-thin">a library for quantitative image analysis</a><span class="m-breadcrumb">┃</span><a href="https://github.com/DIPlib/diplib/releases/tag/3.5.2" class="m-thin">version 3.5.2</a>      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="modules.html">Modules</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="classes.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <div class="m-doc-include m-thin m-right-m m-text-right">
<a href="imagetype.html" class="m-doc">Image</a> module<br/><span class="m-code m-thin">#include <a href="file--diplib-h.html">"diplib.h"</a></span>          </div>

          <span class="m-breadcrumb"><a href="dip.html">dip</a>::<wbr/></span>AlignedAllocInterface <span class="m-thin">class</span>        </h1>
        <p><a href="dip-ExternalInterface.html"><code>dip::ExternalInterface</code></a> that allocates aligned data.</p>
        <div class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#base-classes">Base classes</a></li>
                <li><a href="#function-members">Functions</a></li>
              </ul>
            </li>
          </ul>
        </div>
          <p>Image data allocated by this external interface have each scan line aligned on a <code>alignment</code>-byte boundary.
That is, the pointer to the first pixel of each scan line is aligned. This is accomplished by padding the
scan lines so that their length is a multiple of <code>alignment</code>.</p>
<p>If <code>alignment</code> is larger than <code>alignof(std::max_align_t)</code>, then the first scan line is additionally aligned
by padding to its left: a larger buffer is allocated and <code>std::align()</code> is used to get the aligned pointer.</p>
<p>The class is designed as a singleton: <a href="dip-AlignedAllocInterface.html#dip-AlignedAllocInterface-GetInstance-T"><code>dip::AlignedAllocInterface::GetInstance</code></a> returns a pointer to a unique instance.
The alignment, in bytes, is passed to <code>GetInstance</code> as a template parameter.</p>
<p>For example, here we create an allocator that guarantees 4-byte (32-bits) alignment:</p>
<div class="m-code"><pre><span></span><span class="n">ExternalInterface</span><span class="o">*</span><span class="w"> </span><span class="n">ei</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">dip</span><span class="o">::</span><span class="n">AlignedAllocInterface</span><span class="o">::</span><span class="n">GetInstance</span><span class="o">&lt;</span><span class="mi">4</span><span class="o">&gt;</span><span class="p">();</span>
</pre></div>

<p>The scanline dimension is the first dimension.</p>
        <section id="base-classes">
          <h2>Base classes</h2>
          <dl class="m-doc">
                          <dt>
              class <a href="dip-ExternalInterface.html" class="m-doc">dip::<wbr />ExternalInterface</a> <span class="m-label m-flat m-warning">abstract</span>
            </dt>
            <dd>Support for external interfaces.</dd>
          </dl>
        </section>
        <section id="function-members">
          <h2>Functions</h2>
          <dl class="m-doc">
                          <dt id="dip-AlignedAllocInterface-AllocateData-void-PL-dip-DataType--UnsignedArray-CL-IntegerArray-L-dip-Tensor-CL-dip-sint-L">
              <span class="m-doc-wrap-bumper">auto <a href="#dip-AlignedAllocInterface-AllocateData-void-PL-dip-DataType--UnsignedArray-CL-IntegerArray-L-dip-Tensor-CL-dip-sint-L" class="m-doc-self">AllocateData</a>(</span><span class="m-doc-wrap">void*&amp; origin,
              <a href="dip-DataType.html" class="m-doc">dip::DataType</a> dataType,
              <a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> const&amp; sizes,
              <a href="supporttypes.html#dip-IntegerArray" class="m-doc">dip::IntegerArray</a>&amp; strides,
              <a href="dip-Tensor.html" class="m-doc">dip::Tensor</a> const&amp; tensor,
              <a href="supporttypes.html#dip-sint" class="m-doc">dip::sint</a>&amp; tensorStride) -&gt; <a href="imagetype.html#dip-DataSegment" class="m-doc">dip::DataSegment</a> <span class="m-label m-flat m-warning">override</span></span>
            </dt>
            <dd>Called by <a href="dip-Image.html#dip-Image-Forge"><code>dip::Image::Forge</code></a>.</dd>
                          <dt id="dip-AlignedAllocInterface-GetInstance-T">
              <div class="m-doc-template">template&lt;<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> alignment&gt;</div>
              <span class="m-doc-wrap-bumper">static auto <a href="#dip-AlignedAllocInterface-GetInstance-T" class="m-doc-self">GetInstance</a>(</span><span class="m-doc-wrap">) -&gt; <a href="dip-AlignedAllocInterface.html" class="m-doc">dip::AlignedAllocInterface</a>*</span>
            </dt>
            <dd>Singleton interface, templated in the <code>alignment</code> parameter.
Only one instance is needed for each distinct alignment.
<code>alignment</code> is in bytes.</dd>
          </dl>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form action="https://diplib.org/diplib-docs/#search">
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript. Enable it or <a href="https://google.com/search?q=site:diplib.org+">use an external search engine</a>.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or modules.
              You can omit any prefix from the symbol or file path; adding a <code>:</code> or
              <code>/</code> suffix lists all members of given symbol or directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span> / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
              <span class="m-label m-dim">Enter</span> to go.
              <span class="m-label m-dim">Tab</span> autocompletes common prefix.
              You can copy a link to the result using <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">L</span>,
              or <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">M</span> to copy a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.<br />Maybe try a full-text <a href="#" id="search-external" data-search-engine="https://google.com/search?q=site:diplib.org+{query}">search with external engine</a>?</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v1.js"></script>
<script src="searchdata-v1.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>DIPlib, a library for quantitative image analysis. Documentation compiled with <a href="https://crisluengo.github.io/doxpp/">dox++</a> and styled with <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>