185 lines
16 KiB
HTML
185 lines
16 KiB
HTML
<!--
|
|
Copyright Louis Dionne 2013-2017
|
|
Distributed under the Boost Software License, Version 1.0.
|
|
(See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
|
|
-->
|
|
<!-- boost-no-inspect -->
|
|
<!-- HTML header for doxygen 1.8.9.1-->
|
|
<!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/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.20"/>
|
|
<title>Boost.Hana: Reference documentation</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
extensions: ["tex2jax.js"],
|
|
jax: ["input/TeX","output/HTML-CSS"],
|
|
});
|
|
// Copyright Louis Dionne 2013-2017
|
|
// Distributed under the Boost Software License, Version 1.0.
|
|
// (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
|
|
MathJax.Hub.Config({
|
|
"HTML-CSS": {
|
|
linebreaks: {
|
|
automatic: true,
|
|
width: "75% container"
|
|
}
|
|
}
|
|
});
|
|
</script>
|
|
<script type="text/javascript" async="async" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<!-- Additional javascript for drawing charts. -->
|
|
<script type="text/javascript" src="highcharts.js"></script>
|
|
<script type="text/javascript" src="highcharts-data.js"></script>
|
|
<script type="text/javascript" src="highcharts-exporting.js"></script>
|
|
<script type="text/javascript" src="chart.js"></script>
|
|
<script type="text/javascript" src="hana.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="Boost.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Boost.Hana
|
|
 <span id="projectnumber">1.7.0</span>
|
|
</div>
|
|
<div id="projectbrief">Your standard library for metaprogramming</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.svg"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.20 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('modules.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Reference documentation</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"> The reference documentation is split into logical modules, as documented in the user manual.</div><div class="directory">
|
|
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
|
|
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><a class="el" href="group__group-concepts.html" target="_self">Concepts</a></td><td class="desc">Concepts provided by the library </td></tr>
|
|
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_applicative.html" target="_self">Applicative</a></td><td class="desc">The <code>Applicative</code> concept represents <code>Functor</code>s with the ability to lift values and combine computations </td></tr>
|
|
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_comonad.html" target="_self">Comonad</a></td><td class="desc">The <code>Comonad</code> concept represents context-sensitive computations and data </td></tr>
|
|
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_comparable.html" target="_self">Comparable</a></td><td class="desc">The <code>Comparable</code> concept defines equality and inequality </td></tr>
|
|
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_constant.html" target="_self">Constant</a></td><td class="desc">The <code>Constant</code> concept represents data that can be manipulated at compile-time </td></tr>
|
|
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_euclidean_ring.html" target="_self">Euclidean Ring</a></td><td class="desc">The <code>EuclideanRing</code> concept represents a commutative <code>Ring</code> that can also be endowed with a division algorithm </td></tr>
|
|
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_foldable.html" target="_self">Foldable</a></td><td class="desc">The <code>Foldable</code> concept represents data structures that can be reduced to a single value </td></tr>
|
|
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_functor.html" target="_self">Functor</a></td><td class="desc">The <code>Functor</code> concept represents types that can be mapped over </td></tr>
|
|
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_group.html" target="_self">Group</a></td><td class="desc">The <code>Group</code> concept represents <code>Monoid</code>s where all objects have an inverse w.r.t. the <code>Monoid</code>'s binary operation </td></tr>
|
|
<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_hashable.html" target="_self">Hashable</a></td><td class="desc">The <code>Hashable</code> concept represents objects that can be normalized to a type-level hash </td></tr>
|
|
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_iterable.html" target="_self">Iterable</a></td><td class="desc">The <code>Iterable</code> concept represents data structures supporting external iteration </td></tr>
|
|
<tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_logical.html" target="_self">Logical</a></td><td class="desc">The <code>Logical</code> concept represents types with a truth value </td></tr>
|
|
<tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_metafunction.html" target="_self">Metafunction</a></td><td class="desc">A <code>Metafunction</code> is a function that takes <code><a class="el" href="structboost_1_1hana_1_1type.html" title="C++ type in value-level representation.">hana::type</a></code>s as inputs and returns a <code><a class="el" href="structboost_1_1hana_1_1type.html" title="C++ type in value-level representation.">hana::type</a></code> as output </td></tr>
|
|
<tr id="row_0_12_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_monad.html" target="_self">Monad</a></td><td class="desc">The <code>Monad</code> concept represents <code>Applicative</code>s with the ability to flatten nested levels of structure </td></tr>
|
|
<tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_monad_plus.html" target="_self">MonadPlus</a></td><td class="desc">The <code>MonadPlus</code> concept represents Monads with a monoidal structure </td></tr>
|
|
<tr id="row_0_14_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_monoid.html" target="_self">Monoid</a></td><td class="desc">The <code>Monoid</code> concept represents data types with an associative binary operation that has an identity </td></tr>
|
|
<tr id="row_0_15_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_orderable.html" target="_self">Orderable</a></td><td class="desc">The <code>Orderable</code> concept represents totally ordered data types </td></tr>
|
|
<tr id="row_0_16_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_product.html" target="_self">Product</a></td><td class="desc">Represents types that are generic containers of two elements </td></tr>
|
|
<tr id="row_0_17_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_ring.html" target="_self">Ring</a></td><td class="desc">The <code>Ring</code> concept represents <code>Group</code>s that also form a <code>Monoid</code> under a second binary operation that distributes over the first </td></tr>
|
|
<tr id="row_0_18_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_searchable.html" target="_self">Searchable</a></td><td class="desc">The <code>Searchable</code> concept represents structures that can be searched </td></tr>
|
|
<tr id="row_0_19_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_sequence.html" target="_self">Sequence</a></td><td class="desc">The <code>Sequence</code> concept represents generic index-based sequences </td></tr>
|
|
<tr id="row_0_20_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-_struct.html" target="_self">Struct</a></td><td class="desc">The <code>Struct</code> concept represents <code>struct</code>-like user-defined types </td></tr>
|
|
<tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="group__group-datatypes.html" target="_self">Data types</a></td><td class="desc">General purpose data types provided by the library </td></tr>
|
|
<tr id="row_2_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="group__group-functional.html" target="_self">Functional</a></td><td class="desc">General purpose function objects </td></tr>
|
|
<tr id="row_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="group__group-core.html" target="_self">Core</a></td><td class="desc">Core utilities of the library </td></tr>
|
|
<tr id="row_4_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="group__group-experimental.html" target="_self">Experimental features</a></td><td class="desc">Experimental features that may or may not make it into the library. These features should not expected to be stable </td></tr>
|
|
<tr id="row_5_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_5_" class="arrow" onclick="toggleFolder('5_')">▼</span><a class="el" href="group__group-ext.html" target="_self">External adapters</a></td><td class="desc">Adapters for external libraries </td></tr>
|
|
<tr id="row_5_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-ext-fusion.html" target="_self">Boost.Fusion adapters</a></td><td class="desc">Adapters for Boost.Fusion containers </td></tr>
|
|
<tr id="row_5_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-ext-mpl.html" target="_self">Boost.MPL adapters</a></td><td class="desc">Adapters for Boost.MPL containers </td></tr>
|
|
<tr id="row_5_2_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-ext-boost.html" target="_self">Other Boost adapters</a></td><td class="desc">Adapters for miscellaneous heterogeneous containers in Boost </td></tr>
|
|
<tr id="row_5_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__group-ext-std.html" target="_self">Standard library adapters</a></td><td class="desc">Adapters for components in the standard library </td></tr>
|
|
<tr id="row_6_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="group__group-config.html" target="_self">Configuration options</a></td><td class="desc">Configurable options to tweak the global behavior of the library </td></tr>
|
|
<tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="group__group-assertions.html" target="_self">Assertions</a></td><td class="desc">Macros to perform different kinds of assertions </td></tr>
|
|
<tr id="row_8_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="group__group-details.html" target="_self">Details</a></td><td class="desc">Implementation details. Do not rely on anything here, even if it is documented </td></tr>
|
|
</table>
|
|
</div><!-- directory -->
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!--
|
|
Copyright Louis Dionne 2013-2017
|
|
Distributed under the Boost Software License, Version 1.0.
|
|
(See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
|
|
-->
|
|
<!-- boost-no-inspect -->
|
|
<!-- HTML footer for doxygen 1.8.9.1-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|