Skip to content

Commit

Permalink
Updated documentation pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed Mar 22, 2024
1 parent 3c7a957 commit 3b4e690
Show file tree
Hide file tree
Showing 12 changed files with 296 additions and 152 deletions.
3 changes: 2 additions & 1 deletion docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,8 @@
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="diwa__activations_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diwa__activations_8h.html">diwa_activations.h</a></td></tr>
<tr class="memdesc:diwa__activations_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines activation functions for use in the <a class="el" href="class_diwa.html" title="Lightweight Feedforward Artificial Neural Network (ANN) library tailored for microcontrollers.">Diwa</a> neural network. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="diwa__conv_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><b>diwa_conv.h</b></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="diwa__conv_8h_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diwa__conv_8h.html">diwa_conv.h</a></td></tr>
<tr class="memdesc:diwa__conv_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Utility functions for data conversion in the <a class="el" href="class_diwa.html" title="Lightweight Feedforward Artificial Neural Network (ANN) library tailored for microcontrollers.">Diwa</a> neural network library. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion docs/dir_68267d1309a1af8e8297ef4c3efbcdba.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ var dir_68267d1309a1af8e8297ef4c3efbcdba =
[
[ "diwa.h", "diwa_8h.html", "diwa_8h" ],
[ "diwa_activations.h", "diwa__activations_8h.html", "diwa__activations_8h" ],
[ "diwa_conv.h", "diwa__conv_8h_source.html", null ]
[ "diwa_conv.h", "diwa__conv_8h.html", null ]
];
163 changes: 80 additions & 83 deletions docs/diwa_8h_source.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/diwa__activations_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@

<p>Defines activation functions for use in the <a class="el" href="class_diwa.html" title="Lightweight Feedforward Artificial Neural Network (ANN) library tailored for microcontrollers.">Diwa</a> neural network.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;diwa_conv.h&gt;</code><br />
<div class="textblock"><code>#include &lt;<a class="el" href="diwa__conv_8h_source.html">diwa_conv.h</a>&gt;</code><br />
<code>#include &lt;math.h&gt;</code><br />
</div>
<p><a href="diwa__activations_8h_source.html">Go to the source code of this file.</a></p>
Expand Down
3 changes: 2 additions & 1 deletion docs/diwa__activations_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="preprocessor">#ifndef DIWA_ACTIVATIONS_H</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="preprocessor">#define DIWA_ACTIVATIONS_H</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#include &lt;diwa_conv.h&gt;</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#include &lt;<a class="code" href="diwa__conv_8h.html">diwa_conv.h</a>&gt;</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="preprocessor">#include &lt;math.h&gt;</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="diwa__activations_8h.html#aec742b543a716ae82c16c211320bb761"> 50</a></span><span class="preprocessor">#define DIWA_ACTFUNC_LOWER_BOUND -30.0f </span></div>
Expand Down Expand Up @@ -173,6 +173,7 @@
<div class="ttc" id="adiwa__activations_8h_html_a805e330efd219b647c3029dd7e3ac520"><div class="ttname"><a href="diwa__activations_8h.html#a805e330efd219b647c3029dd7e3ac520">DIWA_ACTFUNC_UPPER_BOUND</a></div><div class="ttdeci">#define DIWA_ACTFUNC_UPPER_BOUND</div><div class="ttdef"><b>Definition</b> diwa_activations.h:51</div></div>
<div class="ttc" id="adiwa__activations_8h_html_aafa05ac5c062e638690c6449f8e1d76a"><div class="ttname"><a href="diwa__activations_8h.html#aafa05ac5c062e638690c6449f8e1d76a">diwa_activation</a></div><div class="ttdeci">double(* diwa_activation)(double)</div><div class="ttdoc">Typedef for activation function pointer.</div><div class="ttdef"><b>Definition</b> diwa_activations.h:59</div></div>
<div class="ttc" id="adiwa__activations_8h_html_aec742b543a716ae82c16c211320bb761"><div class="ttname"><a href="diwa__activations_8h.html#aec742b543a716ae82c16c211320bb761">DIWA_ACTFUNC_LOWER_BOUND</a></div><div class="ttdeci">#define DIWA_ACTFUNC_LOWER_BOUND</div><div class="ttdef"><b>Definition</b> diwa_activations.h:50</div></div>
<div class="ttc" id="adiwa__conv_8h_html"><div class="ttname"><a href="diwa__conv_8h.html">diwa_conv.h</a></div><div class="ttdoc">Utility functions for data conversion in the Diwa neural network library.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
Expand Down
113 changes: 113 additions & 0 deletions docs/diwa__conv_8h.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Diwa: src/diwa_conv.h File 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>
<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="doxygen-awesome.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign">
<div id="projectname">Diwa
</div>
<div id="projectbrief">Lightweight implementation of Artificial Neural Network for resource-constrained environments</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('diwa__conv_8h.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">diwa_conv.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Utility functions for data conversion in the <a class="el" href="class_diwa.html" title="Lightweight Feedforward Artificial Neural Network (ANN) library tailored for microcontrollers.">Diwa</a> neural network library.
<a href="#details">More...</a></p>

<p><a href="diwa__conv_8h_source.html">Go to the source code of this file.</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility functions for data conversion in the <a class="el" href="class_diwa.html" title="Lightweight Feedforward Artificial Neural Network (ANN) library tailored for microcontrollers.">Diwa</a> neural network library. </p>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/nthnn">Nathanne Isip</a> </dd></dl>
<p>This file provides utility functions for converting data between different formats, such as integers and doubles to byte arrays, and vice versa. These functions are used to facilitate data serialization and deserialization in the <a class="el" href="class_diwa.html" title="Lightweight Feedforward Artificial Neural Network (ANN) library tailored for microcontrollers.">Diwa</a> library. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
<ul>
<li class="footer">Copyright 2024 - <a href="https://github.com/nthnn" target="_blank">Nathanne Isip</a></li>
</ul>
</div>
Loading

0 comments on commit 3b4e690

Please sign in to comment.