12 lines
7.7 KiB
HTML
12 lines
7.7 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
||
"">
|
||
<html><head><meta charset="UTF-8" /><title>cc.journeyman.simulated-genetics.genome documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Simulated-genetics</span> <span class="project-version">0.1.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="Understanding-jme3-character-models.html"><div class="inner"><span>Understanding how jME3 handles character models</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to simulated-genetics</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cc</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>journeyman</span></div></div></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>simulated-genetics</span></div></div></li><li class="depth-4 branch current"><a href="cc.journeyman.simulated-genetics.genome.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>genome</span></div></a></li><li class="depth-4 branch"><a href="cc.journeyman.simulated-genetics.launcher.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>launcher</span></div></a></li><li class="depth-4 branch"><a href="cc.journeyman.simulated-genetics.makehuman-bridge.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>makehuman-bridge</span></div></a></li><li class="depth-4"><a href="cc.journeyman.simulated-genetics.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="cc.journeyman.simulated-genetics.genome.html#var-create-genome"><div class="inner"><span>create-genome</span></div></a></li><li class="depth-1"><a href="cc.journeyman.simulated-genetics.genome.html#var-ethnically-biased-feature-index"><div class="inner"><span>ethnically-biased-feature-index</span></div></a></li><li class="depth-1"><a href="cc.journeyman.simulated-genetics.genome.html#var-expand-genome"><div class="inner"><span>expand-genome</span></div></a></li><li class="depth-1"><a href="cc.journeyman.simulated-genetics.genome.html#var-extract-bits"><div class="inner"><span>extract-bits</span></div></a></li><li class="depth-1"><a href="cc.journeyman.simulated-genetics.genome.html#var-gender-bit"><div class="inner"><span>gender-bit</span></div></a></li><li class="depth-1"><a href="cc.journeyman.simulated-genetics.genome.html#var-genome-mask"><div class="inner"><span>genome-mask</span></div></a></li><li class="depth-1"><a href="cc.journeyman.simulated-genetics.genome.html#var-male.3F"><div class="inner"><span>male?</span></div></a></li><li class="depth-1"><a href="cc.journeyman.simulated-genetics.genome.html#var-rand-genome"><div class="inner"><span>rand-genome</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">cc.journeyman.simulated-genetics.genome</h1><div class="doc"><div class="markdown"><p>lightweight simulation of a genome.</p>
|
||
</div></div><div class="public anchor" id="var-create-genome"><h3>create-genome</h3><div class="usage"><code>(create-genome)</code><code>(create-genome father mother)</code></div><div class="doc"><div class="markdown"><p>Create a new genome; if <code>father</code> and <code>mother</code> are passed, the result will comprise bits taken randomly from those genomes.</p>
|
||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/the-great-game/blob/master/src/cc/journeyman/simulated_genetics/genome.clj#L43">view source</a></div></div><div class="public anchor" id="var-ethnically-biased-feature-index"><h3>ethnically-biased-feature-index</h3><h4 class="type">macro</h4><div class="usage"><code>(ethnically-biased-feature-index genome start end)</code></div><div class="doc"><div class="markdown"><p>Some feature values are associated with particular ethnicities.</p>
|
||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/the-great-game/blob/master/src/cc/journeyman/simulated_genetics/genome.clj#L67">view source</a></div></div><div class="public anchor" id="var-expand-genome"><h3>expand-genome</h3><div class="usage"><code>(expand-genome genome)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/the-great-game/blob/master/src/cc/journeyman/simulated_genetics/genome.clj#L80">view source</a></div></div><div class="public anchor" id="var-extract-bits"><h3>extract-bits</h3><div class="usage"><code>(extract-bits g start end)</code></div><div class="doc"><div class="markdown"><p>Extract, as an integer left-shifted by <code>start</code>, those bits from <code>g</code> indexed from <code>start</code> (inclusive) to <code>end</code> (exclusive).</p>
|
||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/the-great-game/blob/master/src/cc/journeyman/simulated_genetics/genome.clj#L60">view source</a></div></div><div class="public anchor" id="var-gender-bit"><h3>gender-bit</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>The bit that encodes for gender</p>
|
||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/the-great-game/blob/master/src/cc/journeyman/simulated_genetics/genome.clj#L34">view source</a></div></div><div class="public anchor" id="var-genome-mask"><h3>genome-mask</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>A mask which selects just the bits we’re interested in from a long.</p>
|
||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/the-great-game/blob/master/src/cc/journeyman/simulated_genetics/genome.clj#L30">view source</a></div></div><div class="public anchor" id="var-male.3F"><h3>male?</h3><div class="usage"><code>(male? genome)</code></div><div class="doc"><div class="markdown"><p><code>true</code> if this genome is male.</p>
|
||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/the-great-game/blob/master/src/cc/journeyman/simulated_genetics/genome.clj#L75">view source</a></div></div><div class="public anchor" id="var-rand-genome"><h3>rand-genome</h3><h4 class="type">macro</h4><div class="usage"><code>(rand-genome)</code></div><div class="doc"><div class="markdown"><p>Create a random genome.</p>
|
||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/the-great-game/blob/master/src/cc/journeyman/simulated_genetics/genome.clj#L38">view source</a></div></div></div></body></html> |