1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Struct template multi_index</title> 5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../index.html" title="Chapter 1. Boost.Histogram"> 8<link rel="up" href="../../histogram/reference.html#header.boost.histogram.multi_index_hpp" title="Header <boost/histogram/multi_index.hpp>"> 9<link rel="prev" href="make_wei_idm45503931588096.html" title="Function template make_weighted_profile"> 10<link rel="next" href="multi_in_idm45503931560304.html" title="Struct multi_index<static_cast< std::size_t >(-1)>"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="make_wei_idm45503931588096.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../histogram/reference.html#header.boost.histogram.multi_index_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="multi_in_idm45503931560304.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.histogram.multi_index"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Struct template multi_index</span></h2> 29<p>boost::histogram::multi_index — Holder for multiple axis indices. </p> 30</div> 31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../histogram/reference.html#header.boost.histogram.multi_index_hpp" title="Header <boost/histogram/multi_index.hpp>">boost/histogram/multi_index.hpp</a>> 33 34</span><span class="keyword">template</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> Size<span class="special">></span> 35<span class="keyword">struct</span> <a class="link" href="multi_index.html" title="Struct template multi_index">multi_index</a> <span class="special">{</span> 36 <span class="comment">// types</span> 37 <span class="keyword">typedef</span> <span class="identifier">axis</span><span class="special">::</span><span class="identifier">index_type</span> <a name="boost.histogram.multi_index.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> 38 <span class="keyword">typedef</span> <span class="identifier">value_type</span> <span class="special">*</span> <a name="boost.histogram.multi_index.iterator"></a><span class="identifier">iterator</span><span class="special">;</span> 39 <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">*</span> <a name="boost.histogram.multi_index.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span> 40 41 <span class="comment">// <a class="link" href="multi_index.html#boost.histogram.multi_indexconstruct-copy-destruct">construct/copy/destruct</a></span> 42 <span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Is<span class="special">></span> <a class="link" href="multi_index.html#idm45503931569824-bb"><span class="identifier">multi_index</span></a><span class="special">(</span><span class="identifier">axis</span><span class="special">::</span><span class="identifier">index_type</span><span class="special">,</span> <span class="identifier">Is</span><span class="special">...</span><span class="special">)</span><span class="special">;</span> 43 <span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Is<span class="special">></span> 44 <a class="link" href="multi_index.html#idm45503931567344-bb"><span class="identifier">multi_index</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">tuple</span><span class="special"><</span> <span class="identifier">axis</span><span class="special">::</span><span class="identifier">index_type</span><span class="special">,</span> <span class="identifier">Is</span><span class="special">...</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 45 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Iterable<span class="special">></span> <a class="link" href="multi_index.html#idm45503931565520-bb"><span class="identifier">multi_index</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Iterable</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 46 <a class="link" href="multi_index.html#idm45503931564016-bb"><span class="identifier">multi_index</span></a><span class="special">(</span><span class="identifier">priv_tag</span><span class="special">)</span><span class="special">;</span> 47 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">...</span> Is<span class="special">></span> 48 <a class="link" href="multi_index.html#idm45503931563200-bb"><span class="identifier">multi_index</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">mp11</span><span class="special">::</span><span class="identifier">index_sequence</span><span class="special"><</span> <span class="identifier">Is</span><span class="special">...</span> <span class="special">></span><span class="special">)</span><span class="special">;</span> 49 50 <span class="comment">// <a class="link" href="multi_index.html#idm45503931577792-bb">public static functions</a></span> 51 <span class="keyword">static</span> <a class="link" href="multi_index.html" title="Struct template multi_index">multi_index</a> <a class="link" href="multi_index.html#idm45503931577232-bb"><span class="identifier">create</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> 52 <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="multi_index.html#idm45503931575456-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 53 54 <span class="comment">// <a class="link" href="multi_index.html#idm45503931574224-bb">public member functions</a></span> 55 <span class="identifier">iterator</span> <a class="link" href="multi_index.html#idm45503931573664-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 56 <span class="identifier">iterator</span> <a class="link" href="multi_index.html#idm45503931572704-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 57 <span class="identifier">const_iterator</span> <a class="link" href="multi_index.html#idm45503931571744-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 58 <span class="identifier">const_iterator</span> <a class="link" href="multi_index.html#idm45503931570784-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 59<span class="special">}</span><span class="special">;</span></pre></div> 60<div class="refsect1"> 61<a name="idm45113198324032"></a><h2>Description</h2> 62<p>Adapts external iterable, tuple, or explicit list of indices to the same representation. </p> 63<div class="refsect2"> 64<a name="idm45113198323248"></a><h3> 65<a name="boost.histogram.multi_indexconstruct-copy-destruct"></a><code class="computeroutput">multi_index</code> 66 public 67 construct/copy/destruct</h3> 68<div class="orderedlist"><ol class="orderedlist" type="1"> 69<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Is<span class="special">></span> <a name="idm45503931569824-bb"></a><span class="identifier">multi_index</span><span class="special">(</span><span class="identifier">axis</span><span class="special">::</span><span class="identifier">index_type</span> i<span class="special">,</span> <span class="identifier">Is</span><span class="special">...</span> is<span class="special">)</span><span class="special">;</span></pre></li> 70<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Is<span class="special">></span> 71 <a name="idm45503931567344-bb"></a><span class="identifier">multi_index</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">tuple</span><span class="special"><</span> <span class="identifier">axis</span><span class="special">::</span><span class="identifier">index_type</span><span class="special">,</span> <span class="identifier">Is</span><span class="special">...</span> <span class="special">></span> <span class="special">&</span> is<span class="special">)</span><span class="special">;</span></pre></li> 72<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Iterable<span class="special">></span> <a name="idm45503931565520-bb"></a><span class="identifier">multi_index</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Iterable</span> <span class="special">&</span> is<span class="special">)</span><span class="special">;</span></pre></li> 73<li class="listitem"><pre class="literallayout"><a name="idm45503931564016-bb"></a><span class="identifier">multi_index</span><span class="special">(</span><span class="identifier">priv_tag</span><span class="special">)</span><span class="special">;</span></pre></li> 74<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">...</span> Is<span class="special">></span> 75 <a name="idm45503931563200-bb"></a><span class="identifier">multi_index</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> is<span class="special">,</span> <span class="identifier">mp11</span><span class="special">::</span><span class="identifier">index_sequence</span><span class="special"><</span> <span class="identifier">Is</span><span class="special">...</span> <span class="special">></span><span class="special">)</span><span class="special">;</span></pre></li> 76</ol></div> 77</div> 78<div class="refsect2"> 79<a name="idm45113198267984"></a><h3> 80<a name="idm45503931577792-bb"></a><code class="computeroutput">multi_index</code> public static functions</h3> 81<div class="orderedlist"><ol class="orderedlist" type="1"> 82<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <a class="link" href="multi_index.html" title="Struct template multi_index">multi_index</a> <a name="idm45503931577232-bb"></a><span class="identifier">create</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> s<span class="special">)</span><span class="special">;</span></pre></li> 83<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm45503931575456-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> 84</ol></div> 85</div> 86<div class="refsect2"> 87<a name="idm45113198251440"></a><h3> 88<a name="idm45503931574224-bb"></a><code class="computeroutput">multi_index</code> public member functions</h3> 89<div class="orderedlist"><ol class="orderedlist" type="1"> 90<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idm45503931573664-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> 91<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idm45503931572704-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> 92<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45503931571744-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> 93<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45503931570784-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> 94</ol></div> 95</div> 96</div> 97</div> 98<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 99<td align="left"></td> 100<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans 101 Dembinski<p> 102 Distributed under the Boost Software License, Version 1.0. (See accompanying 103 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 104 </p> 105</div></td> 106</tr></table> 107<hr> 108<div class="spirit-nav"> 109<a accesskey="p" href="make_wei_idm45503931588096.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../histogram/reference.html#header.boost.histogram.multi_index_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="multi_in_idm45503931560304.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 110</div> 111</body> 112</html> 113
