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

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];