mirror of
https://github.com/boostorg/gil.git
synced 2026-02-13 12:32:09 +00:00
128 lines
5.0 KiB
HTML
128 lines
5.0 KiB
HTML
|
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>Overview - Boost.GIL documentation</title>
|
|
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../_static/style.css" type="text/css" />
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: '../../',
|
|
VERSION: '',
|
|
COLLAPSE_MODINDEX: false,
|
|
FILE_SUFFIX: '.html'
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="../../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../../_static/doctools.js"></script>
|
|
<script type="text/javascript" src="../../_static/language_data.js"></script>
|
|
<link rel="index" title="Index" href="../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../search.html" />
|
|
<link rel="top" title="Boost.GIL documentation" href="../../index.html" />
|
|
<link rel="up" title="Extensions" href="index.html" />
|
|
<link rel="next" title="STD extension" href="std.html" />
|
|
<link rel="prev" title="Extensions" href="index.html" />
|
|
</head>
|
|
<body>
|
|
<div class="header">
|
|
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
|
"header">
|
|
<tr>
|
|
<td valign="top" width="300">
|
|
<h3><a href="../../index.html"><img
|
|
alt="C++ Boost" src="../../_static/gil.png" border="0"></a></h3>
|
|
</td>
|
|
|
|
<td >
|
|
<h1 align="center"><a href="../../index.html"></a></h1>
|
|
</td>
|
|
<td>
|
|
<div id="searchbox" style="display: none">
|
|
<form class="search" action="../../search.html" method="get">
|
|
<input type="text" name="q" size="18" />
|
|
<input type="submit" value="Search" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<hr/>
|
|
<div class="content">
|
|
<div class="navbar" style="text-align:right;">
|
|
|
|
|
|
<a class="prev" title="Extensions" href="index.html"><img src="../../_static/prev.png" alt="prev"/></a>
|
|
<a class="up" title="Extensions" href="index.html"><img src="../../_static/up.png" alt="up"/></a>
|
|
<a class="next" title="STD extension" href="std.html"><img src="../../_static/next.png" alt="next"/></a>
|
|
|
|
</div>
|
|
|
|
<div class="section" id="overview">
|
|
<h1>Overview</h1>
|
|
<div class="contents local topic" id="contents">
|
|
<ul class="simple">
|
|
<li><a class="reference internal" href="#description" id="id1">Description</a></li>
|
|
<li><a class="reference internal" href="#extensions" id="id2">Extensions</a></li>
|
|
<li><a class="reference internal" href="#adding-an-external-container" id="id3">Adding an external container</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="description">
|
|
<h2><a class="toc-backref" href="#id1">Description</a></h2>
|
|
<p>Apart from the default class supplied by Boost.GIL, there are also provisions to
|
|
use external containers like from std::vector, std::map, boost::histogram etc. These
|
|
are provided as extensions.</p>
|
|
</div>
|
|
<div class="section" id="extensions">
|
|
<h2><a class="toc-backref" href="#id2">Extensions</a></h2>
|
|
<dl class="docutils">
|
|
<dt>Currently the following are available:</dt>
|
|
<dd><ol class="first last arabic simple">
|
|
<li>std::vector (1D histogram support)</li>
|
|
<li>std::map (1D histogram support)</li>
|
|
<li>std::array (1D histogram support)</li>
|
|
<li>std::unordered_map (1D histogram support)</li>
|
|
<li>boost::histogram</li>
|
|
</ol>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="adding-an-external-container">
|
|
<h2><a class="toc-backref" href="#id3">Adding an external container</a></h2>
|
|
<dl class="docutils">
|
|
<dt>The workflow should be:</dt>
|
|
<dd><ol class="first last arabic simple">
|
|
<li>Provide overloads for fill_histogram(must), make_histogram(optional) etc. in a new file preferably named after the container type in extensions/histogram/.</li>
|
|
<li>Add tests to test/extensions/histogram.</li>
|
|
<li>Add docs to docs/histogram/extensions.</li>
|
|
<li>Other cmake, Jamfile, config etc. file changes.</li>
|
|
</ol>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="navbar" style="text-align:right;">
|
|
|
|
|
|
<a class="prev" title="Extensions" href="index.html"><img src="../../_static/prev.png" alt="prev"/></a>
|
|
<a class="up" title="Extensions" href="index.html"><img src="../../_static/up.png" alt="up"/></a>
|
|
<a class="next" title="STD extension" href="std.html"><img src="../../_static/next.png" alt="next"/></a>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
Last updated on 2021-10-05 07:10:26.
|
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
|
|
</div>
|
|
</body>
|
|
</html> |