mirror of
https://github.com/boostorg/histogram.git
synced 2026-01-30 20:02:13 +00:00
150 lines
7.6 KiB
HTML
150 lines
7.6 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>Histogram — histogram 1.0 documentation</title>
|
|
|
|
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: './',
|
|
VERSION: '1.0',
|
|
COLLAPSE_INDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: false
|
|
};
|
|
</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="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
<link rel="top" title="histogram 1.0 documentation" href="#" />
|
|
<link rel="next" title="Motivation" href="motivation.html" />
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
|
|
</head>
|
|
<body role="document">
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<div class="section" id="histogram">
|
|
<h1>Histogram<a class="headerlink" href="#histogram" title="Permalink to this headline">¶</a></h1>
|
|
<p>Hans Dembinski</p>
|
|
<p>Copyright (c) 2016 Hans Dembinski</p>
|
|
<p>Distributed under the <a class="reference external" href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>, see accompanying file LICENSE.</p>
|
|
<div class="section" id="description">
|
|
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
|
<p>This project contains an easy-to-use powerful n-dimensional histogram class implemented in <code class="docutils literal"><span class="pre">C++03</span></code>, optimized for convenience and excellent performance under heavy duty. Move semantics are supported using <cite>boost::move</cite>. The histogram has a complete C++ and a <a class="reference external" href="http://www.python.org">Python</a> interface, and can be passed over the language boundary with ease. <a class="reference external" href="http://www.numpy.org">Numpy</a> is fully supported; histograms can be filled with Numpy arrays at C speeds and are convertible into Numpy arrays without copying data. Histograms can be streamed from/to files and pickled in Python.</p>
|
|
<p>My goal is to submit this project to the <a class="reference external" href="http://www.boost.orgBoost">Boost Libraries</a>.</p>
|
|
</div>
|
|
<div class="section" id="contents">
|
|
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="motivation.html">Motivation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#example-1-1d-histogram-in-c">Example 1: 1d-histogram in C++</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#example-2-2d-histogram-in-python">Example 2: 2d-histogram in Python</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="notes.html">Notes</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="notes.html#dependencies">Dependencies</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="notes.html#how-to-build-and-install">How to build and install</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="notes.html#tests">Tests</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="notes.html#checks">Checks</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="notes.html#consistency-of-c-and-python-interface">Consistency of C++ and Python interface</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="notes.html#benchmarks">Benchmarks</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="types.html">Types</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="types.html#histogram-type">Histogram type</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="types.html#axis-types">Axis Types</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="rationale.html">Rationale</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="rationale.html#design-principles">Design principles</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="rationale.html#interface-convenience">Interface convenience</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="rationale.html#language-transparency">Language transparency</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="rationale.html#powerful-binning-strategies">Powerful binning strategies</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="rationale.html#performance-and-memory-efficiency">Performance and memory-efficiency</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="rationale.html#weighted-counts-and-variance-estimates">Weighted counts and variance estimates</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="rationale.html#serialization-and-zero-suppression">Serialization and zero-suppression</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="changelog.html">CHANGELOG</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h1 class="logo"><a href="#">histogram</a></h1>
|
|
|
|
|
|
|
|
|
|
|
|
<p>
|
|
<iframe src="https://ghbtns.com/github-btn.html?user=HDembinski&repo=histogram&type=watch&count=true&size=large"
|
|
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="motivation.html">Motivation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="notes.html">Notes</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="types.html">Types</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="rationale.html">Rationale</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="changelog.html">CHANGELOG</a></li>
|
|
</ul>
|
|
|
|
<div class="relations">
|
|
<h3>Related Topics</h3>
|
|
<ul>
|
|
<li><a href="#">Documentation overview</a><ul>
|
|
<li>Next: <a href="motivation.html" title="next chapter">Motivation</a></li>
|
|
</ul></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="footer">
|
|
©2016, Hans Dembinski.
|
|
|
|
|
|
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.1</a>
|
|
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |