<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IAtari: Utils Namespace Reference</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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" />
</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="robot.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">IAtari
</div>
<div id="projectbrief">Genetic algorithm generating AI capable to play Atari2600 games.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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>
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('namespaceUtils.html','');});
/* @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="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Utils Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A set of useful method and class.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classUtils_1_1Random.html">Random</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">RNG based on Xoroshiro128+. <a href="classUtils_1_1Random.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classUtils_1_1ThreadGroup.html">ThreadGroup</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An implementation of Thread group. <a href="classUtils_1_1ThreadGroup.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classUtils_1_1ThreadPool.html">ThreadPool</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An implementation of Thread pool. <a href="classUtils_1_1ThreadPool.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af45a0bd53042e510e4b7788e3786be02"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceUtils.html#af45a0bd53042e510e4b7788e3786be02">atomic_add</a> (std::atomic< T > &f, T d)</td></tr>
<tr class="memdesc:af45a0bd53042e510e4b7788e3786be02"><td class="mdescLeft"> </td><td class="mdescRight">Perform an atomic addition. <a href="#af45a0bd53042e510e4b7788e3786be02">More...</a><br /></td></tr>
<tr class="separator:af45a0bd53042e510e4b7788e3786be02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82b3bf7a40190a6dcef8e29b847bb7a5"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceUtils.html#a82b3bf7a40190a6dcef8e29b847bb7a5">rotl</a> (const T x, const int k)</td></tr>
<tr class="memdesc:a82b3bf7a40190a6dcef8e29b847bb7a5"><td class="mdescLeft"> </td><td class="mdescRight">Rotate bytes to the left. <a href="#a82b3bf7a40190a6dcef8e29b847bb7a5">More...</a><br /></td></tr>
<tr class="separator:a82b3bf7a40190a6dcef8e29b847bb7a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98dcf2053af6c280534e2f668056f7bd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceUtils.html#a98dcf2053af6c280534e2f668056f7bd">is7bit</a> (int c)</td></tr>
<tr class="memdesc:a98dcf2053af6c280534e2f668056f7bd"><td class="mdescLeft"> </td><td class="mdescRight">Check if a value is written on 7 bits. <a href="#a98dcf2053af6c280534e2f668056f7bd">More...</a><br /></td></tr>
<tr class="separator:a98dcf2053af6c280534e2f668056f7bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7d0a311d3e16cea65be75fa6a1000a7"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceUtils.html#af7d0a311d3e16cea65be75fa6a1000a7">ceilMultiple</a> (size_t a, size_t b)</td></tr>
<tr class="memdesc:af7d0a311d3e16cea65be75fa6a1000a7"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the closest value from a such that this new value is a multiple of b. <a href="#af7d0a311d3e16cea65be75fa6a1000a7">More...</a><br /></td></tr>
<tr class="separator:af7d0a311d3e16cea65be75fa6a1000a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a309a855911c69614a5d3eb7c5f8252fa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceUtils.html#a309a855911c69614a5d3eb7c5f8252fa">secam_to_range_index</a> (int i)</td></tr>
<tr class="memdesc:a309a855911c69614a5d3eb7c5f8252fa"><td class="mdescLeft"> </td><td class="mdescRight">Transform a secam color value to a power of two. <a href="#a309a855911c69614a5d3eb7c5f8252fa">More...</a><br /></td></tr>
<tr class="separator:a309a855911c69614a5d3eb7c5f8252fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aacc905eae78abff87c861223066399ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceUtils.html#aacc905eae78abff87c861223066399ee">secam210x160_to_42x32</a> (const std::vector< unsigned char > &screen, std::vector< unsigned char > &screen42x32)</td></tr>
<tr class="memdesc:aacc905eae78abff87c861223066399ee"><td class="mdescLeft"> </td><td class="mdescRight">Reduce the screen from 210x160 to 42x32. <a href="#aacc905eae78abff87c861223066399ee">More...</a><br /></td></tr>
<tr class="separator:aacc905eae78abff87c861223066399ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3bf35dff1d5b2d28e1a85bb27503e7d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceUtils.html#ac3bf35dff1d5b2d28e1a85bb27503e7d">init_ALE</a> ()</td></tr>
<tr class="memdesc:ac3bf35dff1d5b2d28e1a85bb27503e7d"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the emulator from the config file. <a href="#ac3bf35dff1d5b2d28e1a85bb27503e7d">More...</a><br /></td></tr>
<tr class="separator:ac3bf35dff1d5b2d28e1a85bb27503e7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2cb4fe5036957672db516ed2bed571ed"><td class="memItemLeft" align="right" valign="top">vector< vector< string > > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceUtils.html#a2cb4fe5036957672db516ed2bed571ed">read_Config</a> ()</td></tr>
<tr class="memdesc:a2cb4fe5036957672db516ed2bed571ed"><td class="mdescLeft"> </td><td class="mdescRight">Store values extracted from the config file to a vector. <a href="#a2cb4fe5036957672db516ed2bed571ed">More...</a><br /></td></tr>
<tr class="separator:a2cb4fe5036957672db516ed2bed571ed"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A set of useful method and class. </p>
<dl class="section copyright"><dt>Copyright</dt><dd>GNU General Public License </dd>
<dd>
Part of Leela Zero software </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Gian-Carlo Pascutto </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="af45a0bd53042e510e4b7788e3786be02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af45a0bd53042e510e4b7788e3786be02">◆ </a></span>atomic_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Utils::atomic_add </td>
<td>(</td>
<td class="paramtype">std::atomic< T > & </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"><em>d</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform an atomic addition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">f</td><td>Original atomic value </td></tr>
<tr><td class="paramdir"></td><td class="paramname">d</td><td>Value added to the atomic value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af7d0a311d3e16cea65be75fa6a1000a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7d0a311d3e16cea65be75fa6a1000a7">◆ </a></span>ceilMultiple()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t Utils::ceilMultiple </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the closest value from a such that this new value is a multiple of b. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>The divided </td></tr>
<tr><td class="paramname">b</td><td>The divisor </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The closest value from a such that b divide this value </dd></dl>
</div>
</div>
<a id="ac3bf35dff1d5b2d28e1a85bb27503e7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3bf35dff1d5b2d28e1a85bb27503e7d">◆ </a></span>init_ALE()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Utils::init_ALE </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the emulator from the config file. </p>
<p>The properties set are repeat_action_probability, display_screen, sound, ROM and colourPalette </p>
</div>
</div>
<a id="a98dcf2053af6c280534e2f668056f7bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98dcf2053af6c280534e2f668056f7bd">◆ </a></span>is7bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Utils::is7bit </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a value is written on 7 bits. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>The checked value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the value is written on 7 bits, false otherwise </dd></dl>
</div>
</div>
<a id="a2cb4fe5036957672db516ed2bed571ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cb4fe5036957672db516ed2bed571ed">◆ </a></span>read_Config()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Utils::read_Config </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Store values extracted from the config file to a vector. </p>
<p>The config file is config.config. This file have to be flawlessly written or the algorithm will crash. </p>
</div>
</div>
<a id="a82b3bf7a40190a6dcef8e29b847bb7a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82b3bf7a40190a6dcef8e29b847bb7a5">◆ </a></span>rotl()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Utils::rotl </td>
<td>(</td>
<td class="paramtype">const T </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>k</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate bytes to the left. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>Value to be rotated </td></tr>
<tr><td class="paramname">k</td><td>Number of bits to shift </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The rotated value </dd></dl>
</div>
</div>
<a id="aacc905eae78abff87c861223066399ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacc905eae78abff87c861223066399ee">◆ </a></span>secam210x160_to_42x32()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Utils::secam210x160_to_42x32 </td>
<td>(</td>
<td class="paramtype">const std::vector< unsigned char > & </td>
<td class="paramname"><em>screen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< unsigned char > & </td>
<td class="paramname"><em>screen42x32</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reduce the screen from 210x160 to 42x32. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">screen</td><td>The input screen (pointer vector) </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">screen42x32</td><td>The output screen (pointer vector) </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceUtils.html#a309a855911c69614a5d3eb7c5f8252fa" title="Transform a secam color value to a power of two.">secam_to_range_index()</a> </dd></dl>
</div>
</div>
<a id="a309a855911c69614a5d3eb7c5f8252fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a309a855911c69614a5d3eb7c5f8252fa">◆ </a></span>secam_to_range_index()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Utils::secam_to_range_index </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>i</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Transform a secam color value to a power of two. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The color value we want to transform </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The transformed color value </dd></dl>
</div>
</div>
</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="namespaceUtils.html">Utils</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>