<!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.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Final Year Project: D:/Users/mbuzelis/source/repos/ForwardPlusRenderer/include/ConstrainedMap.h Source File</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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom_dark_theme.css" rel="stylesheet" type="text/css"/>
<link href="custom.css" rel="stylesheet" type="text/css"/>
</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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Final Year Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part --><!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_constrained_map_8h_source.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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">ConstrainedMap.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include <stdafx.h></span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">namespace </span>fpr</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span>{</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="conceptfpr_1_1unique__handle.html"> 11</a></span><span class="keyword">concept </span><a class="code hl_concept" href="conceptfpr_1_1unique__handle.html">unique_handle</a> = <span class="keyword">requires</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span>{</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> { std::declval<T>().get() };</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>};</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="structfpr_1_1unique__handle__type.html"> 18</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structfpr_1_1unique__handle__type.html">unique_handle_type</a></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>{</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">using </span>type = T;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>};</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">// Requires a type to have a ::element_type alias.</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">requires</span> <a class="code hl_concept" href="conceptfpr_1_1unique__handle.html">unique_handle<T></a></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structfpr_1_1unique__handle__type_3_01_t_01_4.html"> 26</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structfpr_1_1unique__handle__type.html">unique_handle_type</a><T></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">using </span>type = T::element_type;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>};</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">// Not every type has a pointer that is functionally equivalent, i.e file handles.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">template</span><<span class="keyword">typename</span> Elem, <span class="keyword">typename</span> Deleter></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structfpr_1_1unique__handle__type_3_01std_1_1unique__ptr_3_01_elem_00_01_deleter_01_4_01_4.html"> 33</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structfpr_1_1unique__handle__type.html">unique_handle_type</a><std::unique_ptr<Elem, Deleter>></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>{</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">using </span>type = std::unique_ptr<Elem, Deleter>::pointer;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>};</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keyword">template</span><<span class="keyword">typename</span> T></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="conceptfpr_1_1_hashable.html"> 43</a></span><span class="keyword">concept </span><a class="code hl_concept" href="conceptfpr_1_1_hashable.html">Hashable</a> = <span class="keyword">requires</span>(T a)</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>{</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> {</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> std::hash<T>{}(a)</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> } -> std::convertible_to<std::size_t>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>};</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keyword">template</span><Hashable Key = std::<span class="keywordtype">string</span>, <span class="keyword">typename</span> map_value = std::any></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classfpr_1_1_constrained_map.html"> 54</a></span><span class="keyword">class </span><a class="code hl_class" href="classfpr_1_1_constrained_map.html">ConstrainedMap</a></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>{</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// Type aliases</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">using </span>map_type = <span class="keyword">typename</span> std::unordered_map<Key, map_value>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">using </span>iterator = <span class="keyword">typename</span> map_type::iterator;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">using </span>mapped_type = <span class="keyword">typename</span> map_type::mapped_type;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">using </span>handle_element_type = <span class="keyword">typename</span> unique_handle_type<map_value>::type;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// helper function to extract iterator to mapped value.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> map_type hash_table;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> iterator found_value_iter(<span class="keyword">const</span> std::string& value)</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> {</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordflow">return</span> hash_table.find(value);</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> };</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// Get overload that requires an unique handle</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> handle_element_type Get(<span class="keyword">const</span> std::string& name) <span class="keyword">requires</span>(<a class="code hl_concept" href="conceptfpr_1_1unique__handle.html">unique_handle<map_value></a>)</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> {</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordflow">return</span> found_value_iter(name)->second.get();</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> };</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// Add overload that requires a unique handle</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> handle_element_type Add(<span class="keyword">const</span> std::string& name, map_value& resource) <span class="keyword">requires</span>(<a class="code hl_concept" href="conceptfpr_1_1unique__handle.html">unique_handle<map_value></a>)</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> hash_table[name] = std::move(resource);</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordflow">return</span> hash_table[name].get();</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> };</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// Add overload that requires a unique handle and takes an r-value ref</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> handle_element_type Add(<span class="keyword">const</span> std::string& name, map_value&& resource) <span class="keyword">requires</span>(<a class="code hl_concept" href="conceptfpr_1_1unique__handle.html">unique_handle<map_value></a>)</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> {</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> hash_table[name] = std::move(resource);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordflow">return</span> hash_table[name].get();</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> };</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// Get overload that returns a reference to the value and that the held value is not an unique handle.</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> mapped_type& Get(<span class="keyword">const</span> std::string& name) <span class="keyword">requires</span>(not(<a class="code hl_concept" href="conceptfpr_1_1unique__handle.html">unique_handle<map_value></a>))</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> {</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keywordflow">return</span> found_value_iter(name)->second;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> };</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="comment">// Add overload that requires the mapped valuee to not be an unique handle.</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> mapped_type& Add(<span class="keyword">const</span> std::string& name, map_value resource) <span class="keyword">requires</span>(not(<a class="code hl_concept" href="conceptfpr_1_1unique__handle.html">unique_handle<map_value></a>))</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> {</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> hash_table[name] = resource;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordflow">return</span> hash_table[name];</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> };</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="keywordtype">bool</span> Exists(<span class="keyword">const</span> std::string& name)</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> {</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keywordflow">return</span> found_value_iter(name) != hash_table.end();</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> }</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span>};</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span>} <span class="comment">// namespace fpr</span></div>
<div class="ttc" id="aclassfpr_1_1_constrained_map_html"><div class="ttname"><a href="classfpr_1_1_constrained_map.html">fpr::ConstrainedMap</a></div><div class="ttdef"><b>Definition:</b> <a href="_constrained_map_8h_source.html#l00054">ConstrainedMap.h:55</a></div></div>
<div class="ttc" id="aconceptfpr_1_1_hashable_html"><div class="ttname"><a href="conceptfpr_1_1_hashable.html">fpr::Hashable</a></div><div class="ttdoc">Requires that std::hash<T> overload is provided for the given type. Additionally, it must also return...</div><div class="ttdef"><b>Definition:</b> <a href="_constrained_map_8h_source.html#l00043">ConstrainedMap.h:43</a></div></div>
<div class="ttc" id="aconceptfpr_1_1unique__handle_html"><div class="ttname"><a href="conceptfpr_1_1unique__handle.html">fpr::unique_handle</a></div><div class="ttdoc">Requires the given type to have a .get() function. Could be improved, such as requiring that ....</div><div class="ttdef"><b>Definition:</b> <a href="_constrained_map_8h_source.html#l00011">ConstrainedMap.h:11</a></div></div>
<div class="ttc" id="astructfpr_1_1unique__handle__type_html"><div class="ttname"><a href="structfpr_1_1unique__handle__type.html">fpr::unique_handle_type</a></div><div class="ttdef"><b>Definition:</b> <a href="_constrained_map_8h_source.html#l00018">ConstrainedMap.h:19</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><b>ConstrainedMap.h</b></li>
<li class="footer">
Generated on Mon Oct 3 2022 13:44:05 for Final Year Project by <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"
onerror="this.onerror=null;this.src='doxygen.svg';"/></a> 1.9.5.
Dark theme by <a href="http://majerle.eu" target="_new">Tilen Majerle</a>. All rights reserved.
</li>
</ul>
</div>
<script src="custom.js"></script>
</body>
</html>
Mantas Buzelis