documentation

docs_doxygen/html/base_model_8h_source.html

@@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('base_model_8h_source.html','');});
 <a href="base_model_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">//  baseModel.h</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//  RapidLib</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">//  Created by mzed on 05/09/2016.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">//  Copyright © 2016 Goldsmiths. All rights reserved.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#ifndef baseModel_h</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#define baseModel_h</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="training_example_8h.html">trainingExample.h</a>&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef EMSCRIPTEN</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &quot;json.h&quot;</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classbase_model.html">   22</a></span>&#160;<span class="keyword">class </span><a class="code" href="classbase_model.html">baseModel</a> {</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classbase_model.html#ac16b40e0a37c3ddc335d44b0668df4e2">   24</a></span>&#160;    <span class="keyword">virtual</span> <a class="code" href="classbase_model.html#ac16b40e0a37c3ddc335d44b0668df4e2">~baseModel</a>() {};</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    <span class="keyword">virtual</span> T <a class="code" href="classbase_model.html#a4c57cc5edffbfd8ed959e049e5951ebf">run</a>(<span class="keyword">const</span> std::vector&lt;T&gt; &amp;inputVector) = 0;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classbase_model.html#aadfc4ee03fc17d923dc53721d05740d1">train</a>(<span class="keyword">const</span> std::vector&lt;<a class="code" href="structtraining_example.html">trainingExample&lt;T&gt;</a> &gt; &amp;trainingSet) = 0;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classbase_model.html#a89434e0587b1c701f6abc4065e23e0a2">reset</a>() = 0;;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classbase_model.html#a237863c3daed90c372227797050c70b1">getNumInputs</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    <span class="keyword">virtual</span> std::vector&lt;int&gt; <a class="code" href="classbase_model.html#a3c905a55228bdddf3823ce64ec23c38d">getWhichInputs</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    </div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifndef EMSCRIPTEN</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classbase_model.html#a7e8f888087752fa3d353edd14eeb4858">getJSONDescription</a>(Json::Value &amp;currentModel) = 0;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    </div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="keyword">template</span>&lt;<span class="keyword">typename</span> TT&gt;</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classbase_model.html#a9b1ba32b01a20ff7f3a529ebfe0bee85">   36</a></span>&#160;    Json::Value <a class="code" href="classbase_model.html#a9b1ba32b01a20ff7f3a529ebfe0bee85">vector2json</a>(TT vec) {</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;        Json::Value toReturn;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;        <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; vec.size(); ++i) {</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;            toReturn.append(vec[i]);</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;        }</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;        <span class="keywordflow">return</span> toReturn;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    }</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    </div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;};</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classbase_model_html_a89434e0587b1c701f6abc4065e23e0a2"><div class="ttname"><a href="classbase_model.html#a89434e0587b1c701f6abc4065e23e0a2">baseModel::reset</a></div><div class="ttdeci">virtual void reset()=0</div></div>
 <div class="ttc" id="classbase_model_html_a237863c3daed90c372227797050c70b1"><div class="ttname"><a href="classbase_model.html#a237863c3daed90c372227797050c70b1">baseModel::getNumInputs</a></div><div class="ttdeci">virtual int getNumInputs() const =0</div></div>
 <div class="ttc" id="classbase_model_html_ac16b40e0a37c3ddc335d44b0668df4e2"><div class="ttname"><a href="classbase_model.html#ac16b40e0a37c3ddc335d44b0668df4e2">baseModel::~baseModel</a></div><div class="ttdeci">virtual ~baseModel()</div><div class="ttdef"><b>Definition:</b> baseModel.h:24</div></div>
-<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:17</div></div>
+<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:18</div></div>
 <div class="ttc" id="classbase_model_html_a7e8f888087752fa3d353edd14eeb4858"><div class="ttname"><a href="classbase_model.html#a7e8f888087752fa3d353edd14eeb4858">baseModel::getJSONDescription</a></div><div class="ttdeci">virtual void getJSONDescription(Json::Value &amp;currentModel)=0</div></div>
 <div class="ttc" id="classbase_model_html"><div class="ttname"><a href="classbase_model.html">baseModel</a></div><div class="ttdef"><b>Definition:</b> baseModel.h:22</div></div>
 <div class="ttc" id="classbase_model_html_a9b1ba32b01a20ff7f3a529ebfe0bee85"><div class="ttname"><a href="classbase_model.html#a9b1ba32b01a20ff7f3a529ebfe0bee85">baseModel::vector2json</a></div><div class="ttdeci">Json::Value vector2json(TT vec)</div><div class="ttdef"><b>Definition:</b> baseModel.h:36</div></div>

docs_doxygen/html/classification_8h_source.html

@@ -103,7 +103,7 @@ $(document).ready(function(){initNavTree('classification_8h_source.html','');});
 <div class="ttc" id="classclassification_html_a41d0dc191d7159c4e46ea24918cd650dacf3bba950fb445ec33cacaee6f04f90b"><div class="ttname"><a href="classclassification.html#a41d0dc191d7159c4e46ea24918cd650dacf3bba950fb445ec33cacaee6f04f90b">classification::svm</a></div><div class="ttdef"><b>Definition:</b> classification.h:23</div></div>
 <div class="ttc" id="classclassification_html_aeebac94bbfa7a8d857cb9f5e7680601b"><div class="ttname"><a href="classclassification.html#aeebac94bbfa7a8d857cb9f5e7680601b">classification::setK</a></div><div class="ttdeci">void setK(const int whichModel, const int newK)</div><div class="ttdef"><b>Definition:</b> classification.cpp:100</div></div>
 <div class="ttc" id="classmodel_set_html_ad4cd50c1dd5fc1d4ef55a24dbddfda1c"><div class="ttname"><a href="classmodel_set.html#ad4cd50c1dd5fc1d4ef55a24dbddfda1c">modelSet::numInputs</a></div><div class="ttdeci">int numInputs</div><div class="ttdef"><b>Definition:</b> modelSet.h:37</div></div>
-<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:17</div></div>
+<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:18</div></div>
 <div class="ttc" id="classclassification_html_ab8fa0a1597bb540c92861ab5da8a4e7d"><div class="ttname"><a href="classclassification.html#ab8fa0a1597bb540c92861ab5da8a4e7d">classification::classification</a></div><div class="ttdeci">classification()</div><div class="ttdef"><b>Definition:</b> classification.cpp:17</div></div>
 <div class="ttc" id="classclassification_html_a41d0dc191d7159c4e46ea24918cd650d"><div class="ttname"><a href="classclassification.html#a41d0dc191d7159c4e46ea24918cd650d">classification::classificationTypes</a></div><div class="ttdeci">classificationTypes</div><div class="ttdef"><b>Definition:</b> classification.h:23</div></div>
 <div class="ttc" id="classclassification_html_a0b687b07e67866af9295b40395379e2e"><div class="ttname"><a href="classclassification.html#a0b687b07e67866af9295b40395379e2e">classification::train</a></div><div class="ttdeci">bool train(const std::vector&lt; trainingExample&lt; T &gt; &gt; &amp;trainingSet)</div><div class="ttdef"><b>Definition:</b> classification.cpp:57</div></div>

docs_doxygen/html/classseries_classification.html

@@ -244,8 +244,8 @@ template&lt;typename T &gt; </div>
 </div><div class="memdoc">
 <p>Calculate minimum and maximum cost between examples in one label and examples in a second. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">first</td><td>label to compare </td></tr>
-    <tr><td class="paramname">second</td><td>label to compare </td></tr>
+    <tr><td class="paramname">string</td><td>first label to compare </td></tr>
+    <tr><td class="paramname">string</td><td>second label to compare </td></tr>
   </table>
   </dd>
 </dl>

docs_doxygen/html/knn_classification_8h_source.html

@@ -103,7 +103,7 @@ $(document).ready(function(){initNavTree('knn_classification_8h_source.html','')
 <div class="ttc" id="classknn_classification_html_ac6c73eb7f625ad4e596c7a93b03b802c"><div class="ttname"><a href="classknn_classification.html#ac6c73eb7f625ad4e596c7a93b03b802c">knnClassification::knnClassification</a></div><div class="ttdeci">knnClassification(const int &amp;num_inputs, const std::vector&lt; int &gt; &amp;which_inputs, const std::vector&lt; trainingExample&lt; T &gt; &gt; &amp;trainingSet, const int k)</div><div class="ttdef"><b>Definition:</b> knnClassification.cpp:20</div></div>
 <div class="ttc" id="classknn_classification_html_a040aa10672d162514bc58ba3d8b76c9d"><div class="ttname"><a href="classknn_classification.html#a040aa10672d162514bc58ba3d8b76c9d">knnClassification::train</a></div><div class="ttdeci">void train(const std::vector&lt; trainingExample&lt; T &gt; &gt; &amp;trainingSet)</div><div class="ttdef"><b>Definition:</b> knnClassification.cpp:78</div></div>
 <div class="ttc" id="classknn_classification_html"><div class="ttname"><a href="classknn_classification.html">knnClassification</a></div><div class="ttdef"><b>Definition:</b> knnClassification.h:21</div></div>
-<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:17</div></div>
+<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:18</div></div>
 <div class="ttc" id="classknn_classification_html_a80c299fa0ddbc8ba9630cfead17f6d28"><div class="ttname"><a href="classknn_classification.html#a80c299fa0ddbc8ba9630cfead17f6d28">knnClassification::getNumInputs</a></div><div class="ttdeci">int getNumInputs() const</div><div class="ttdef"><b>Definition:</b> knnClassification.cpp:41</div></div>
 <div class="ttc" id="classbase_model_html"><div class="ttname"><a href="classbase_model.html">baseModel</a></div><div class="ttdef"><b>Definition:</b> baseModel.h:22</div></div>
 <div class="ttc" id="classknn_classification_html_a88e0fec44ac39d02890d0813db19a866"><div class="ttname"><a href="classknn_classification.html#a88e0fec44ac39d02890d0813db19a866">knnClassification::addNeighbour</a></div><div class="ttdeci">void addNeighbour(const int &amp;classNum, const std::vector&lt; T &gt; &amp;features)</div><div class="ttdef"><b>Definition:</b> knnClassification.cpp:69</div></div>

docs_doxygen/html/model_set_8h_source.html

@@ -106,7 +106,7 @@ $(document).ready(function(){initNavTree('model_set_8h_source.html','');});
 <div class="ttc" id="classmodel_set_html_a10b6431ce7b4bc75f23a9f04f1666922"><div class="ttname"><a href="classmodel_set.html#a10b6431ce7b4bc75f23a9f04f1666922">modelSet::putJSON</a></div><div class="ttdeci">bool putJSON(const std::string &amp;jsonMessage)</div><div class="ttdef"><b>Definition:</b> modelSet.cpp:146</div></div>
 <div class="ttc" id="neural_network_8h_html"><div class="ttname"><a href="neural_network_8h.html">neuralNetwork.h</a></div></div>
 <div class="ttc" id="classmodel_set_html_ad4cd50c1dd5fc1d4ef55a24dbddfda1c"><div class="ttname"><a href="classmodel_set.html#ad4cd50c1dd5fc1d4ef55a24dbddfda1c">modelSet::numInputs</a></div><div class="ttdeci">int numInputs</div><div class="ttdef"><b>Definition:</b> modelSet.h:37</div></div>
-<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:17</div></div>
+<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:18</div></div>
 <div class="ttc" id="svm_classification_8h_html"><div class="ttname"><a href="svm_classification_8h.html">svmClassification.h</a></div></div>
 <div class="ttc" id="classmodel_set_html_a98676ef4b61e0a3b596fe164344aeb4f"><div class="ttname"><a href="classmodel_set.html#a98676ef4b61e0a3b596fe164344aeb4f">modelSet::writeJSON</a></div><div class="ttdeci">void writeJSON(const std::string &amp;filepath)</div><div class="ttdef"><b>Definition:</b> modelSet.cpp:135</div></div>
 <div class="ttc" id="knn_classification_8h_html"><div class="ttname"><a href="knn_classification_8h.html">knnClassification.h</a></div></div>

docs_doxygen/html/neural_network_8h_source.html

@@ -107,7 +107,7 @@ $(document).ready(function(){initNavTree('neural_network_8h_source.html','');});
 <div class="ttc" id="classneural_network_html_a31baa6b719b4fd6bfb14d61a583f05d8"><div class="ttname"><a href="classneural_network.html#a31baa6b719b4fd6bfb14d61a583f05d8">neuralNetwork::getNumHiddenNodes</a></div><div class="ttdeci">int getNumHiddenNodes() const</div><div class="ttdef"><b>Definition:</b> neuralNetwork.cpp:210</div></div>
 <div class="ttc" id="classneural_network_html_ae1bd02d3268b99a49b8e365afb2fa8b5"><div class="ttname"><a href="classneural_network.html#ae1bd02d3268b99a49b8e365afb2fa8b5">neuralNetwork::run</a></div><div class="ttdeci">T run(const std::vector&lt; T &gt; &amp;inputVector)</div><div class="ttdef"><b>Definition:</b> neuralNetwork.cpp:303</div></div>
 <div class="ttc" id="classneural_network_html_a6a8f3d3c08e067b13211bf8039581417"><div class="ttname"><a href="classneural_network.html#a6a8f3d3c08e067b13211bf8039581417">neuralNetwork::setNumHiddenLayers</a></div><div class="ttdeci">void setNumHiddenLayers(int num_hidden_layers)</div><div class="ttdef"><b>Definition:</b> neuralNetwork.cpp:203</div></div>
-<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:17</div></div>
+<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:18</div></div>
 <div class="ttc" id="classneural_network_html_adf1a972a173718f922d84681848bdf1b"><div class="ttname"><a href="classneural_network.html#adf1a972a173718f922d84681848bdf1b">neuralNetwork::getWHiddenOutput</a></div><div class="ttdeci">std::vector&lt; T &gt; getWHiddenOutput() const</div><div class="ttdef"><b>Definition:</b> neuralNetwork.cpp:233</div></div>
 <div class="ttc" id="classbase_model_html"><div class="ttname"><a href="classbase_model.html">baseModel</a></div><div class="ttdef"><b>Definition:</b> baseModel.h:22</div></div>
 <div class="ttc" id="classneural_network_html_aaeab4b0827dabb9c4b04603c784194f3"><div class="ttname"><a href="classneural_network.html#aaeab4b0827dabb9c4b04603c784194f3">neuralNetwork::getJSONDescription</a></div><div class="ttdeci">void getJSONDescription(Json::Value &amp;currentModel)</div><div class="ttdef"><b>Definition:</b> neuralNetwork.cpp:259</div></div>

docs_doxygen/html/rapid_stream_8cpp.html

@@ -107,6 +107,10 @@ Include dependency graph for rapidStream.cpp:</div>
 <area shape="rect" id="node2" href="rapid_stream_8h.html" title="rapidStream.h" alt="" coords="5,79,110,104"/>
 </map>
 </div>
+</div><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Michael Zbyszynski </dd></dl>
+<dl class="section date"><dt>Date</dt><dd>6 Feb 2017 </dd></dl>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright © 2017 Goldsmiths. All rights reserved. </dd></dl>
 </div></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

docs_doxygen/html/rapid_stream_8h.html

@@ -119,7 +119,11 @@ Classes</h2></td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapid_stream.html">rapidStream&lt; T &gt;</a></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
-</div><!-- contents -->
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Michael Zbyszynski </dd></dl>
+<dl class="section date"><dt>Date</dt><dd>6 Feb 2017 </dd></dl>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright © 2017 Goldsmiths. All rights reserved. </dd></dl>
+</div></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

docs_doxygen/html/regression_8h_source.html

@@ -100,7 +100,7 @@ $(document).ready(function(){initNavTree('regression_8h_source.html','');});
 <div class="ttc" id="classmodel_set_html"><div class="ttname"><a href="classmodel_set.html">modelSet</a></div><div class="ttdef"><b>Definition:</b> modelSet.h:24</div></div>
 <div class="ttc" id="classregression_html_aec26cba61bc784e388016d4d49453698"><div class="ttname"><a href="classregression.html#aec26cba61bc784e388016d4d49453698">regression::setNumHiddenLayers</a></div><div class="ttdeci">void setNumHiddenLayers(const int &amp;num_hidden_layers)</div><div class="ttdef"><b>Definition:</b> regression.cpp:66</div></div>
 <div class="ttc" id="classmodel_set_html_ad4cd50c1dd5fc1d4ef55a24dbddfda1c"><div class="ttname"><a href="classmodel_set.html#ad4cd50c1dd5fc1d4ef55a24dbddfda1c">modelSet::numInputs</a></div><div class="ttdeci">int numInputs</div><div class="ttdef"><b>Definition:</b> modelSet.h:37</div></div>
-<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:17</div></div>
+<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:18</div></div>
 <div class="ttc" id="classregression_html_a7e84e18b1727ecd5a092310d07a1b392"><div class="ttname"><a href="classregression.html#a7e84e18b1727ecd5a092310d07a1b392">regression::~regression</a></div><div class="ttdeci">~regression()</div><div class="ttdef"><b>Definition:</b> regression.h:31</div></div>
 <div class="ttc" id="classregression_html_afe5baeaea101622217af87c87e4ffd5d"><div class="ttname"><a href="classregression.html#afe5baeaea101622217af87c87e4ffd5d">regression::train</a></div><div class="ttdeci">bool train(const std::vector&lt; trainingExample&lt; T &gt; &gt; &amp;trainingSet)</div><div class="ttdef"><b>Definition:</b> regression.cpp:90</div></div>
 <div class="ttc" id="classregression_html_a9e27950d2f94757f7f12b6f2c9294f3f"><div class="ttname"><a href="classregression.html#a9e27950d2f94757f7f12b6f2c9294f3f">regression::setNumEpochs</a></div><div class="ttdeci">void setNumEpochs(const int &amp;epochs)</div><div class="ttdef"><b>Definition:</b> regression.cpp:78</div></div>

docs_doxygen/html/search_window_8cpp.html

@@ -105,6 +105,10 @@ Include dependency graph for searchWindow.cpp:</div>
 <area shape="rect" id="node4" href="warp_path_8h.html" title="warpPath.h" alt="" coords="80,152,168,177"/>
 </map>
 </div>
+</div><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>RapidLib </p><dl class="section author"><dt>Author</dt><dd>Michael Zbyszynski </dd></dl>
+<dl class="section date"><dt>Date</dt><dd>14 Sep 2017 </dd></dl>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright © 2017 Goldsmiths. All rights reserved. </dd></dl>
 </div></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

docs_doxygen/html/search_window_8h.html

@@ -126,7 +126,11 @@ Classes</h2></td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsearch_window.html">searchWindow&lt; T &gt;</a></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
-</div><!-- contents -->
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>RapidLib </p><dl class="section author"><dt>Author</dt><dd>Michael Zbyszynski </dd></dl>
+<dl class="section date"><dt>Date</dt><dd>14 Sep 2017 </dd></dl>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright © 2017 Goldsmiths. All rights reserved. </dd></dl>
+</div></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

docs_doxygen/html/search_window_8h_source.html

@@ -95,7 +95,7 @@ $(document).ready(function(){initNavTree('search_window_8h_source.html','');});
 <div class="title">searchWindow.h</div>  </div>
 </div><!--header-->
 <div class="contents">
-<a href="search_window_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">//  searchWindow.h</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//  RapidLib</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">//  Created by mzed on 14/09/2017.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">//  Copyright © 2017 Goldsmiths. All rights reserved.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#ifndef searchWindow_h</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#define searchWindow_h</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="warp_path_8h.html">warpPath.h</a>&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classsearch_window.html">   16</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsearch_window.html">searchWindow</a> {</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;    <a class="code" href="classsearch_window.html#a5d1ca48f40d846a222585c3d080fb245">searchWindow</a>(<span class="keyword">const</span> std::vector&lt;std::vector&lt;T&gt;&gt; &amp;seriesX,</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;                 <span class="keyword">const</span> std::vector&lt;std::vector&lt;T&gt;&gt; &amp;seriesY,</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;                 <span class="keyword">const</span> std::vector&lt;std::vector&lt;T&gt;&gt; &amp;shrunkenX,</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;                 <span class="keyword">const</span> std::vector&lt;std::vector&lt;T&gt;&gt; &amp;shrunkenY,</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;                 <a class="code" href="classwarp_path.html">warpPath</a> shrunkenWarpPath,</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;                 <span class="keywordtype">int</span> searchRadius);</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    </div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classsearch_window.html#a9871c01691e3d28304fa8c0ad20272a8">   25</a></span>&#160;    std::vector&lt;int&gt; <a class="code" href="classsearch_window.html#a9871c01691e3d28304fa8c0ad20272a8">minValues</a>;</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classsearch_window.html#afc1eaac02f0874f9e482819721337e5d">   26</a></span>&#160;    std::vector&lt;int&gt; <a class="code" href="classsearch_window.html#afc1eaac02f0874f9e482819721337e5d">maxValues</a>;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    <span class="keywordtype">int</span> maxY;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    <span class="keywordtype">int</span> size;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <span class="keywordtype">void</span> markVisited(<span class="keywordtype">int</span> col, <span class="keywordtype">int</span> row);</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="keywordtype">void</span> expandWindow(<span class="keywordtype">int</span> searchRadius);</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;};</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    </div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* searchWindow_h */</span><span class="preprocessor"></span></div><div class="ttc" id="classsearch_window_html_a9871c01691e3d28304fa8c0ad20272a8"><div class="ttname"><a href="classsearch_window.html#a9871c01691e3d28304fa8c0ad20272a8">searchWindow::minValues</a></div><div class="ttdeci">std::vector&lt; int &gt; minValues</div><div class="ttdef"><b>Definition:</b> searchWindow.h:25</div></div>
+<a href="search_window_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#ifndef searchWindow_h</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#define searchWindow_h</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="warp_path_8h.html">warpPath.h</a>&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classsearch_window.html">   16</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsearch_window.html">searchWindow</a> {</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;    <a class="code" href="classsearch_window.html#a5d1ca48f40d846a222585c3d080fb245">searchWindow</a>(<span class="keyword">const</span> std::vector&lt;std::vector&lt;T&gt;&gt; &amp;seriesX,</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;                 <span class="keyword">const</span> std::vector&lt;std::vector&lt;T&gt;&gt; &amp;seriesY,</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;                 <span class="keyword">const</span> std::vector&lt;std::vector&lt;T&gt;&gt; &amp;shrunkenX,</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;                 <span class="keyword">const</span> std::vector&lt;std::vector&lt;T&gt;&gt; &amp;shrunkenY,</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;                 <a class="code" href="classwarp_path.html">warpPath</a> shrunkenWarpPath,</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;                 <span class="keywordtype">int</span> searchRadius);</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    </div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classsearch_window.html#a9871c01691e3d28304fa8c0ad20272a8">   25</a></span>&#160;    std::vector&lt;int&gt; <a class="code" href="classsearch_window.html#a9871c01691e3d28304fa8c0ad20272a8">minValues</a>;</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classsearch_window.html#afc1eaac02f0874f9e482819721337e5d">   26</a></span>&#160;    std::vector&lt;int&gt; <a class="code" href="classsearch_window.html#afc1eaac02f0874f9e482819721337e5d">maxValues</a>;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    </div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    <span class="keywordtype">int</span> maxY;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    <span class="keywordtype">int</span> size;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <span class="keywordtype">void</span> markVisited(<span class="keywordtype">int</span> col, <span class="keywordtype">int</span> row);</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="keywordtype">void</span> expandWindow(<span class="keywordtype">int</span> searchRadius);</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;};</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* searchWindow_h */</span><span class="preprocessor"></span></div><div class="ttc" id="classsearch_window_html_a9871c01691e3d28304fa8c0ad20272a8"><div class="ttname"><a href="classsearch_window.html#a9871c01691e3d28304fa8c0ad20272a8">searchWindow::minValues</a></div><div class="ttdeci">std::vector&lt; int &gt; minValues</div><div class="ttdef"><b>Definition:</b> searchWindow.h:25</div></div>
 <div class="ttc" id="classwarp_path_html"><div class="ttname"><a href="classwarp_path.html">warpPath</a></div><div class="ttdef"><b>Definition:</b> warpPath.h:14</div></div>
 <div class="ttc" id="warp_path_8h_html"><div class="ttname"><a href="warp_path_8h.html">warpPath.h</a></div></div>
 <div class="ttc" id="classsearch_window_html"><div class="ttname"><a href="classsearch_window.html">searchWindow</a></div><div class="ttdef"><b>Definition:</b> searchWindow.h:16</div></div>

docs_doxygen/html/series_classification_8h_source.html

@@ -107,7 +107,7 @@ $(document).ready(function(){initNavTree('series_classification_8h_source.html',
 <div class="ttc" id="classseries_classification_html_ac39620cb987f1f2074c5e170c056a2e7"><div class="ttname"><a href="classseries_classification.html#ac39620cb987f1f2074c5e170c056a2e7">seriesClassification::~seriesClassification</a></div><div class="ttdeci">~seriesClassification()</div><div class="ttdef"><b>Definition:</b> seriesClassification.cpp:22</div></div>
 <div class="ttc" id="classseries_classification_html_a7cdf23c4e3385e78c31754b6c7275b6c"><div class="ttname"><a href="classseries_classification.html#a7cdf23c4e3385e78c31754b6c7275b6c">seriesClassification::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdef"><b>Definition:</b> seriesClassification.cpp:60</div></div>
 <div class="ttc" id="structseries_classification_1_1min_max_html"><div class="ttname"><a href="structseries_classification_1_1min_max.html">seriesClassification::minMax</a></div><div class="ttdef"><b>Definition:</b> seriesClassification.h:81</div></div>
-<div class="ttc" id="structtraining_series_html"><div class="ttname"><a href="structtraining_series.html">trainingSeries</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:24</div></div>
+<div class="ttc" id="structtraining_series_html"><div class="ttname"><a href="structtraining_series.html">trainingSeries</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:25</div></div>
 <div class="ttc" id="classseries_classification_html_a67695a1e866cdb4052be86a9f8cadd23"><div class="ttname"><a href="classseries_classification.html#a67695a1e866cdb4052be86a9f8cadd23">seriesClassification::getCosts</a></div><div class="ttdeci">std::vector&lt; T &gt; getCosts() const</div><div class="ttdef"><b>Definition:</b> seriesClassification.cpp:105</div></div>
 <div class="ttc" id="classseries_classification_html"><div class="ttname"><a href="classseries_classification.html">seriesClassification</a></div><div class="ttdef"><b>Definition:</b> seriesClassification.h:24</div></div>
 <div class="ttc" id="training_example_8h_html"><div class="ttname"><a href="training_example_8h.html">trainingExample.h</a></div></div>

docs_doxygen/html/svm_classification_8h_source.html

@@ -104,7 +104,7 @@ $(document).ready(function(){initNavTree('svm_classification_8h_source.html','')
 <div class="ttc" id="classsvm_classification_html_aa4fcd506f5684a1c466ecc54cdeca285a41bd477515966d93343d22308bf0be5c"><div class="ttname"><a href="classsvm_classification.html#aa4fcd506f5684a1c466ecc54cdeca285a41bd477515966d93343d22308bf0be5c">svmClassification::NU_SVR</a></div><div class="ttdef"><b>Definition:</b> svmClassification.h:20</div></div>
 <div class="ttc" id="classsvm_classification_html_ac0e6f16cf122322314ffef1a987abad6"><div class="ttname"><a href="classsvm_classification.html#ac0e6f16cf122322314ffef1a987abad6">svmClassification::run</a></div><div class="ttdeci">T run(const std::vector&lt; T &gt; &amp;inputVector)</div><div class="ttdef"><b>Definition:</b> svmClassification.cpp:226</div></div>
 <div class="ttc" id="classsvm_classification_html_aed6303761a5802e65d270d75e6647372"><div class="ttname"><a href="classsvm_classification.html#aed6303761a5802e65d270d75e6647372">svmClassification::getJSONDescription</a></div><div class="ttdeci">void getJSONDescription(Json::Value &amp;currentModel)</div><div class="ttdef"><b>Definition:</b> svmClassification.cpp:261</div></div>
-<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:17</div></div>
+<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:18</div></div>
 <div class="ttc" id="classsvm_classification_html_aee913f59a2aad7e1ea3f27ce9ef732e8abc5abd56c47de997e425c1e1fb827a48"><div class="ttname"><a href="classsvm_classification.html#aee913f59a2aad7e1ea3f27ce9ef732e8abc5abd56c47de997e425c1e1fb827a48">svmClassification::POLY_KERNEL</a></div><div class="ttdef"><b>Definition:</b> svmClassification.h:21</div></div>
 <div class="ttc" id="classsvm_classification_html_a62acf39aee26586edc12f3fa764cdc51"><div class="ttname"><a href="classsvm_classification.html#a62acf39aee26586edc12f3fa764cdc51">svmClassification::~svmClassification</a></div><div class="ttdeci">~svmClassification()</div><div class="ttdef"><b>Definition:</b> svmClassification.cpp:102</div></div>
 <div class="ttc" id="classbase_model_html"><div class="ttname"><a href="classbase_model.html">baseModel</a></div><div class="ttdef"><b>Definition:</b> baseModel.h:22</div></div>

docs_doxygen/html/training_example_8h.html

@@ -136,7 +136,11 @@ Classes</h2></td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtraining_series.html">trainingSeries&lt; T &gt;</a></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
-</div><!-- contents -->
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Michael Zbyszynski </dd></dl>
+<dl class="section date"><dt>Date</dt><dd>22 Nov 2017 </dd></dl>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright © 2016 Goldsmiths. All rights reserved. </dd></dl>
+</div></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

docs_doxygen/html/training_example_8h_source.html

@@ -95,12 +95,12 @@ $(document).ready(function(){initNavTree('training_example_8h_source.html','');}
 <div class="title">trainingExample.h</div>  </div>
 </div><!--header-->
 <div class="contents">
-<a href="training_example_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">//  trainingExample.h</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//  RapidLib</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">//  Created by Michael Zbyszynski on 22/11/2017.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">//  Copyright © 2016 Goldsmiths. All rights reserved.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#ifndef trainingExample_h</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#define trainingExample_h</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="structtraining_example.html">   17</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structtraining_example.html">trainingExample</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structtraining_example.html#a12c70103cf448e393588a1f7c837f6e9">   18</a></span>&#160;  std::vector&lt;T&gt; <a class="code" href="structtraining_example.html#a12c70103cf448e393588a1f7c837f6e9">input</a>;</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structtraining_example.html#ab96334e1a91398762dbe6037a2063910">   19</a></span>&#160;  std::vector&lt;T&gt; <a class="code" href="structtraining_example.html#ab96334e1a91398762dbe6037a2063910">output</a>;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;};</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structtraining_series.html">   24</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structtraining_series.html">trainingSeries</a> {</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structtraining_series.html#a66aa0299355a999a3a583c408cb7528c">   25</a></span>&#160;    std::vector&lt;std::vector&lt;T&gt; &gt; <a class="code" href="structtraining_series.html#a66aa0299355a999a3a583c408cb7528c">input</a>;</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structtraining_series.html#ac91a52265127c7789e1c1654df8b5c24">   26</a></span>&#160;    std::string <a class="code" href="structtraining_series.html#ac91a52265127c7789e1c1654df8b5c24">label</a>;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;};</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="structtraining_series_html_ac91a52265127c7789e1c1654df8b5c24"><div class="ttname"><a href="structtraining_series.html#ac91a52265127c7789e1c1654df8b5c24">trainingSeries::label</a></div><div class="ttdeci">std::string label</div><div class="ttdef"><b>Definition:</b> trainingExample.h:26</div></div>
-<div class="ttc" id="structtraining_example_html_ab96334e1a91398762dbe6037a2063910"><div class="ttname"><a href="structtraining_example.html#ab96334e1a91398762dbe6037a2063910">trainingExample::output</a></div><div class="ttdeci">std::vector&lt; T &gt; output</div><div class="ttdef"><b>Definition:</b> trainingExample.h:19</div></div>
-<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:17</div></div>
-<div class="ttc" id="structtraining_series_html"><div class="ttname"><a href="structtraining_series.html">trainingSeries</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:24</div></div>
-<div class="ttc" id="structtraining_example_html_a12c70103cf448e393588a1f7c837f6e9"><div class="ttname"><a href="structtraining_example.html#a12c70103cf448e393588a1f7c837f6e9">trainingExample::input</a></div><div class="ttdeci">std::vector&lt; T &gt; input</div><div class="ttdef"><b>Definition:</b> trainingExample.h:18</div></div>
-<div class="ttc" id="structtraining_series_html_a66aa0299355a999a3a583c408cb7528c"><div class="ttname"><a href="structtraining_series.html#a66aa0299355a999a3a583c408cb7528c">trainingSeries::input</a></div><div class="ttdeci">std::vector&lt; std::vector&lt; T &gt; &gt; input</div><div class="ttdef"><b>Definition:</b> trainingExample.h:25</div></div>
+<a href="training_example_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#ifndef trainingExample_h</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#define trainingExample_h</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structtraining_example.html">   18</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structtraining_example.html">trainingExample</a> {</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structtraining_example.html#a12c70103cf448e393588a1f7c837f6e9">   19</a></span>&#160;    std::vector&lt;T&gt; <a class="code" href="structtraining_example.html#a12c70103cf448e393588a1f7c837f6e9">input</a>;</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structtraining_example.html#ab96334e1a91398762dbe6037a2063910">   20</a></span>&#160;    std::vector&lt;T&gt; <a class="code" href="structtraining_example.html#ab96334e1a91398762dbe6037a2063910">output</a>;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;};</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structtraining_series.html">   25</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structtraining_series.html">trainingSeries</a> {</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structtraining_series.html#a66aa0299355a999a3a583c408cb7528c">   26</a></span>&#160;    std::vector&lt;std::vector&lt;T&gt; &gt; <a class="code" href="structtraining_series.html#a66aa0299355a999a3a583c408cb7528c">input</a>;</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structtraining_series.html#ac91a52265127c7789e1c1654df8b5c24">   27</a></span>&#160;    std::string <a class="code" href="structtraining_series.html#ac91a52265127c7789e1c1654df8b5c24">label</a>;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;};</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="structtraining_series_html_ac91a52265127c7789e1c1654df8b5c24"><div class="ttname"><a href="structtraining_series.html#ac91a52265127c7789e1c1654df8b5c24">trainingSeries::label</a></div><div class="ttdeci">std::string label</div><div class="ttdef"><b>Definition:</b> trainingExample.h:27</div></div>
+<div class="ttc" id="structtraining_example_html_ab96334e1a91398762dbe6037a2063910"><div class="ttname"><a href="structtraining_example.html#ab96334e1a91398762dbe6037a2063910">trainingExample::output</a></div><div class="ttdeci">std::vector&lt; T &gt; output</div><div class="ttdef"><b>Definition:</b> trainingExample.h:20</div></div>
+<div class="ttc" id="structtraining_example_html"><div class="ttname"><a href="structtraining_example.html">trainingExample</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:18</div></div>
+<div class="ttc" id="structtraining_series_html"><div class="ttname"><a href="structtraining_series.html">trainingSeries</a></div><div class="ttdef"><b>Definition:</b> trainingExample.h:25</div></div>
+<div class="ttc" id="structtraining_example_html_a12c70103cf448e393588a1f7c837f6e9"><div class="ttname"><a href="structtraining_example.html#a12c70103cf448e393588a1f7c837f6e9">trainingExample::input</a></div><div class="ttdeci">std::vector&lt; T &gt; input</div><div class="ttdef"><b>Definition:</b> trainingExample.h:19</div></div>
+<div class="ttc" id="structtraining_series_html_a66aa0299355a999a3a583c408cb7528c"><div class="ttname"><a href="structtraining_series.html#a66aa0299355a999a3a583c408cb7528c">trainingSeries::input</a></div><div class="ttdeci">std::vector&lt; std::vector&lt; T &gt; &gt; input</div><div class="ttdef"><b>Definition:</b> trainingExample.h:26</div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

src/fastDTW.cpp

-//
-//  fastDTW.cpp
-//  RapidLib
-//
-//  Created by mzed on 07/09/2017.
-//  Copyright © 2017 Goldsmiths. All rights reserved.
-//
+/**
+ * @file fastDTW.cpp
+ * RapidLib
+ *
+ * @author Michael Zbyszynski
+ * @date 07 Sep 2017
+ * @copyright Copyright © 2017 Goldsmiths. All rights reserved.
+ */
 
 #include "fastDTW.h"
 #include "dtw.h"

src/fastDTW.h

-//
-//  fastDTW.h
-//  RapidLib
-//
-//  Created by mzed on 07/09/2017.
-//  Copyright © 2017 Goldsmiths. All rights reserved.
-//
+/**
+ * @file  fastDTW.h
+ * RapidLib
+ * @author Michael Zbyszynski
+ * @date 07 Sep 2017
+ * @copyright Copyright © 2017 Goldsmiths. All rights reserved.
+ */
 
 #ifndef fastDTW_h
 #define fastDTW_h
@@ -12,18 +12,47 @@
 #include <vector>
 #include "warpPath.h"
 
+/** Class for performing an fast dynamic time warping between two time series*/
 template<typename T>
 class fastDTW {
 public:
     fastDTW();
     ~fastDTW();
     
+    /**
+     * Returns just the cost of warping one series into a second.
+     * @param seriesX time series X
+     * @param seriesY time series Y
+     * @param searchRadius search radius (usually 1)
+     * @return cost to warp between series
+     */
     static T getCost(const std::vector<std::vector<T>> &seriesX, const std::vector<std::vector<T > > &seriesY, int searchRadius);
+    
+private:
+    /**
+     * Returns the cost and the warp path.
+     * @param seriesX time series X
+     * @param seriesY time series Y
+     * @param searchRadius search radius (usually 1)
+     * @return information about optimal time warp
+     */
     static warpInfo fullFastDTW(const std::vector<std::vector<T>> &seriesX, const std::vector<std::vector<T > > &seriesY, int searchRadius);
 
+    /**
+     * Returns just lowest cost path to warping one series into a second.
+     * @param seriesX time series X
+     * @param seriesY time series Y
+     * @param searchRadius search radius (usually 1)
+     * @return The warp path
+     */
     static warpPath getWarpPath(const std::vector<std::vector<T>> &seriesX, const std::vector<std::vector<T > > &seriesY, int searchRadius);
     
-private:
+    /**
+     * Downsamples a time series by two. Resolution isn't implemented yet
+     * @param series
+     * @param resolution (not used)
+     * @return downsampled series
+     `*/
     static std::vector<std::vector<T> > downsample(const std::vector<std::vector<T>> &series, T resolution);
     
 };

src/rapidStream.cpp

-/*
- * rapidStream.cpp
- * Created by Michael Zbyszynski on 6 Feb 2017
- * Copyright © 2017 Goldsmiths. All rights reserved.
+/**
+ * @file    rapidStream.cpp
+ * @author  Michael Zbyszynski
+ * @date    6 Feb 2017
+ * @copyright Copyright © 2017 Goldsmiths. All rights reserved.
  */
 
 #include "rapidStream.h"