Skip to content

Commit

Permalink
butano: hash support for ibitset added
Browse files Browse the repository at this point in the history
  • Loading branch information
GValiente committed Dec 7, 2024
1 parent d03c3f6 commit 0b116f0
Show file tree
Hide file tree
Showing 10 changed files with 176 additions and 2 deletions.
27 changes: 27 additions & 0 deletions butano/include/bn_bitset.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
#include "bn_span.h"
#include "bn_limits.h"
#include "bn_sstream.h"
#include "bn_functional.h"
#include "bn_bitset_fwd.h"

namespace bn
Expand Down Expand Up @@ -910,6 +911,32 @@ class bitset_ref : public ibitset
}
};

/**
* @brief Hash support for ibitset.
*
* @ingroup bitset
* @ingroup functional
*/
template<>
struct hash<ibitset>
{
/**
* @brief Returns the hash of the given ibitset.
*/
[[nodiscard]] constexpr unsigned operator()(const ibitset& value) const
{
const ibitset::element_t* data = value.data();
unsigned result = make_hash(data[0]);

for(int index = 1, limit = value.elements_size(); index < limit; ++index)
{
hash_combine(data[index], result);
}

return result;
}
};

/**
* @brief Appends the character representation of the given ibitset to the given ostringstream.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
*
* * bn::unique_ptr `operator<<` added.
* * bn::ibitset `operator<<` added.
* * Hash support for bn::ibitset added.
* * bn::utf8_character validation improved.
*
*
Expand Down
1 change: 1 addition & 0 deletions docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,7 @@ <h1>Classes</h1>
<li>struct <a href="structbn_1_1hash_3_01fixed__t_3_01_precision_01_4_01_4.html" class="m-doc">hash&lt;fixed_t&lt;Precision&gt;&gt;</a> <span class="m-doc">Hash support for <a href="classbn_1_1fixed__t.html" class="m-doc">fixed_<wbr />t</a>.</span></li>
<li>struct <a href="structbn_1_1hash_3_01float_01_4.html" class="m-doc">hash&lt;float&gt;</a> <span class="m-doc">Hash support for float.</span></li>
<li>struct <a href="structbn_1_1hash_3_01hbe__ptr_01_4.html" class="m-doc">hash&lt;hbe_ptr&gt;</a> <span class="m-doc">Hash support for <a href="classbn_1_1hbe__ptr.html" class="m-doc">hbe_<wbr />ptr</a>.</span></li>
<li>struct <a href="structbn_1_1hash_3_01ibitset_01_4.html" class="m-doc">hash&lt;ibitset&gt;</a> <span class="m-doc">Hash support for ibitset.</span></li>
<li>struct <a href="structbn_1_1hash_3_01int_01_4.html" class="m-doc">hash&lt;int&gt;</a> <span class="m-doc">Hash support for int.</span></li>
<li>struct <a href="structbn_1_1hash_3_01int16__t_01_4.html" class="m-doc">hash&lt;int16_t&gt;</a> <span class="m-doc">Hash support for int16_t.</span></li>
<li>struct <a href="structbn_1_1hash_3_01int64__t_01_4.html" class="m-doc">hash&lt;int64_t&gt;</a> <span class="m-doc">Hash support for int64_t.</span></li>
Expand Down
5 changes: 5 additions & 0 deletions docs/bn__bitset_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,11 @@ <h2><a href="#nested-classes">Classes</a></h2>
class <a href="classbn_1_1bitset__ref.html" class="m-doc">bn::bitset_ref</a>
</dt>
<dd>ibitset implementation which manages an external elements array.</dd>
<dt>
<div class="m-doc-template">template&lt;&gt;</div>
struct <a href="structbn_1_1hash_3_01ibitset_01_4.html" class="m-doc">bn::hash&lt;ibitset&gt;</a>
</dt>
<dd>Hash support for ibitset.</dd>
</dl>
</section>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/changelog.html

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions docs/group__bitset.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@ <h2><a href="#nested-classes">Classes</a></h2>
class <a href="classbn_1_1bitset__ref.html" class="m-doc">bn::bitset_ref</a>
</dt>
<dd>ibitset implementation which manages an external elements array.</dd>
<dt>
<div class="m-doc-template">template&lt;&gt;</div>
struct <a href="structbn_1_1hash_3_01ibitset_01_4.html" class="m-doc">bn::hash&lt;ibitset&gt;</a>
</dt>
<dd>Hash support for ibitset.</dd>
<dt>
<div class="m-doc-template">template&lt;int Size&gt;</div>
class <a href="classbn_1_1bitset.html" class="m-doc">bn::bitset</a>
Expand Down
5 changes: 5 additions & 0 deletions docs/group__functional.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,11 @@ <h2><a href="#nested-classes">Classes</a></h2>
struct <a href="structbn_1_1hash_3_01bg__palette__ptr_01_4.html" class="m-doc">bn::hash&lt;bg_palette_ptr&gt;</a>
</dt>
<dd>Hash support for <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a>.</dd>
<dt>
<div class="m-doc-template">template&lt;&gt;</div>
struct <a href="structbn_1_1hash_3_01ibitset_01_4.html" class="m-doc">bn::hash&lt;ibitset&gt;</a>
</dt>
<dd>Hash support for ibitset.</dd>
<dt>
<div class="m-doc-template">template&lt;&gt;</div>
struct <a href="structbn_1_1hash_3_01camera__ptr_01_4.html" class="m-doc">bn::hash&lt;camera_ptr&gt;</a>
Expand Down
5 changes: 5 additions & 0 deletions docs/namespacebn.html
Original file line number Diff line number Diff line change
Expand Up @@ -1112,6 +1112,11 @@ <h2><a href="#nested-classes">Classes</a></h2>
struct <a href="structbn_1_1hash_3_01hbe__ptr_01_4.html" class="m-doc">hash&lt;hbe_ptr&gt;</a>
</dt>
<dd>Hash support for <a href="classbn_1_1hbe__ptr.html" class="m-doc">hbe_<wbr />ptr</a>.</dd>
<dt>
<div class="m-doc-template">template&lt;&gt;</div>
struct <a href="structbn_1_1hash_3_01ibitset_01_4.html" class="m-doc">hash&lt;ibitset&gt;</a>
</dt>
<dd>Hash support for ibitset.</dd>
<dt>
<div class="m-doc-template">template&lt;&gt;</div>
struct <a href="structbn_1_1hash_3_01int_01_4.html" class="m-doc">hash&lt;int&gt;</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchdata-v2.js

Large diffs are not rendered by default.

125 changes: 125 additions & 0 deletions docs/structbn_1_1hash_3_01ibitset_01_4.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>bn::hash&lt;ibitset&gt; struct | Butano Docs</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
<link rel="icon" href="favicon-dark.png" type="image/png" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="theme-color" content="#22272e" />
</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://github.com/GValiente/butano">Butano</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</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="namespaces.html">Namespaces</a></li>
<li><a href="annotated.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-code m-inverted m-right-m m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__bitset_8h.html">&lt;bn_bitset.h&gt;</a></div>
<div class="m-doc-template">template&lt;&gt;</div>
<span class="m-breadcrumb"><a href="namespacebn.html">bn</a>::<wbr/></span>hash&lt;ibitset&gt; <span class="m-thin">struct</span>
</h1>
<p>Hash support for ibitset.</p>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#pub-methods">Public functions</a></li>
</ul>
</li>
</ul>
</nav>
<section id="pub-methods">
<h2><a href="#pub-methods">Public functions</a></h2>
<dl class="m-doc">
<dt id="abc3a30905431056d1ee37013228af73e">
<span class="m-doc-wrap-bumper">auto <a href="#abc3a30905431056d1ee37013228af73e" class="m-doc-self">operator()</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1ibitset.html" class="m-doc">ibitset</a>&amp; value) const -&gt; unsigned <span class="m-label m-flat m-primary">constexpr</span></span>
</dt>
<dd>Returns the hash of the given ibitset.</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>
<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.</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> while <span class="m-label m-dim"></span>
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
</div>
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
<ul id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.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>Butano Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.12.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
</div>
</div>
</div>
</nav></footer>
</body>
</html>

0 comments on commit 0b116f0

Please sign in to comment.