modifying documentation

This commit is contained in:
2015-01-28 23:04:21 +01:00
parent 7b1f37aaf9
commit f4c9487af3
8 changed files with 36 additions and 1 deletions

2
.gitignore vendored
View File

@@ -6,3 +6,5 @@ NN.kdev4
*.nm
/doc/html/*
!/doc/html/doxy-boot.js
!/doc/html/jquery.powertip.min.js
!/doc/html/jquery.powertip.min.css

View File

@@ -437,7 +437,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = "./"
INPUT = "./src/" "mainpage.dox"
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

View File

@@ -14,6 +14,8 @@
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<!--<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>-->
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="jquery.powertip.min.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
$search
@@ -21,6 +23,7 @@
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
<link href="jquery.powertip.min.css" rel="stylesheet" type="text/css" />
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>

1
doc/html/jquery.powertip.min.css vendored Normal file
View File

@@ -0,0 +1 @@
#powerTip{cursor:default;background-color:#333;background-color:rgba(0,0,0,.8);border-radius:6px;color:#fff;display:none;padding:10px;position:absolute;white-space:nowrap;z-index:2147483647}#powerTip:before{content:"";position:absolute}#powerTip.n:before,#powerTip.s:before{border-right:5px solid transparent;border-left:5px solid transparent;left:50%;margin-left:-5px}#powerTip.e:before,#powerTip.w:before{border-bottom:5px solid transparent;border-top:5px solid transparent;margin-top:-5px;top:50%}#powerTip.n:before{border-top:10px solid #333;border-top:10px solid rgba(0,0,0,.8);bottom:-10px}#powerTip.e:before{border-right:10px solid #333;border-right:10px solid rgba(0,0,0,.8);left:-10px}#powerTip.s:before{border-bottom:10px solid #333;border-bottom:10px solid rgba(0,0,0,.8);top:-10px}#powerTip.w:before{border-left:10px solid #333;border-left:10px solid rgba(0,0,0,.8);right:-10px}#powerTip.ne:before,#powerTip.se:before{border-right:10px solid transparent;border-left:0;left:10px}#powerTip.nw:before,#powerTip.sw:before{border-left:10px solid transparent;border-right:0;right:10px}#powerTip.ne:before,#powerTip.nw:before{border-top:10px solid #333;border-top:10px solid rgba(0,0,0,.8);bottom:-10px}#powerTip.se:before,#powerTip.sw:before{border-bottom:10px solid #333;border-bottom:10px solid rgba(0,0,0,.8);top:-10px}#powerTip.nw-alt:before,#powerTip.ne-alt:before,#powerTip.sw-alt:before,#powerTip.se-alt:before{border-top:10px solid #333;border-top:10px solid rgba(0,0,0,.8);bottom:-10px;border-left:5px solid transparent;border-right:5px solid transparent;left:10px}#powerTip.ne-alt:before{left:auto;right:10px}#powerTip.sw-alt:before,#powerTip.se-alt:before{border-top:0;border-bottom:10px solid #333;border-bottom:10px solid rgba(0,0,0,.8);bottom:auto;top:-10px}#powerTip.se-alt:before{left:auto;right:10px}

8
doc/html/jquery.powertip.min.js vendored Normal file

File diff suppressed because one or more lines are too long

View File

@@ -6,4 +6,5 @@
@author Tomas Cernik (Tom.Cernik@gmail.com)
TODO
*/

View File

@@ -87,6 +87,13 @@ namespace NeuralNetwork
* @author Tomas Cernik (Tom.Cernik@gmail.com)
* @brief Class representing FeedForward network
* @see ACyclicNetwork
*
* @b Usage:
* @code
* Shin::NeuralNetwork::FeedForward net({1,5,2});
* net.setThreads(2); // it alows network to use 2 threads if it needs to.
* Shin::Solution sol = net.solve(Shin::Problem(0.1)) // and finaly, solve Problem
* @endcode
*/
class FeedForward:public ACyclicNetwork
{
@@ -112,6 +119,9 @@ namespace NeuralNetwork
*/
FeedForward operator=(const FeedForward &f)=delete;
/**
* @brief computes output Solution from input Problem
*/
virtual Solution solve(const Problem& p) override;
virtual size_t size() const override { return layers;};
virtual FFLayer& operator[](const size_t& l) override;

View File

@@ -8,11 +8,21 @@ namespace Shin
{
namespace NeuralNetwork
{
/**
* @author Tomas Cernik (Tom.Cernik@gmail.com)
* @brief Class reprezenting Perceptron - network with only 2 layer (input and output) with Heaviside transfer function
*/
class Perceptron:public FeedForward
{
public:
/**
* @brief Constructor for Perceptron network
* @param inputSize size of input Problem
* @param outputSize size of output Solution
*/
Perceptron(const size_t &inputSize, const size_t &outputSize):FeedForward({inputSize,outputSize})
{
// < iterate throuht layers and set them to Heaviside Function
for(int i=0;i<layers;i++)
{
delete transfer[i];