neuralpp/doc/latex/neural_09_09_8hpp.tex

60 lines
2.3 KiB
TeX
Raw Normal View History

2009-08-09 11:17:39 +02:00
\section{neural++.hpp File Reference}
\label{neural_09_09_8hpp}\index{neural++.hpp@{neural++.hpp}}
{\tt \#include $<$vector$>$}\par
{\tt \#include $<$string$>$}\par
{\tt \#include $<$cmath$>$}\par
{\tt \#include \char`\"{}neural++\_\-exception.hpp\char`\"{}}\par
\subsection*{Namespaces}
\begin{CompactItemize}
\item
namespace {\bf neuralpp}
\end{CompactItemize}
\subsection*{Classes}
\begin{CompactItemize}
\item
class {\bf neuralpp::NeuralNet}
\begin{CompactList}\small\item\em Main project's class. \item\end{CompactList}\item
class {\bf neuralpp::Synapsis}
\begin{CompactList}\small\item\em Class for managing synapsis. \item\end{CompactList}\item
class {\bf neuralpp::Neuron}
\begin{CompactList}\small\item\em Class for managing neurons. \item\end{CompactList}\item
class {\bf neuralpp::Layer}
\begin{CompactList}\small\item\em Class for managing layers of neurons. \item\end{CompactList}\item
struct {\bf neuralpp::netrecord}
\item
struct {\bf neuralpp::neuronrecord}
\item
struct {\bf neuralpp::synrecord}
\end{CompactItemize}
\subsection*{Defines}
\begin{CompactItemize}
\item
2009-08-15 02:59:09 +02:00
\#define {\bf RAND}~(double) ( (rand() / (RAND\_\-MAX/2)) - 1)
2009-08-09 11:17:39 +02:00
\begin{CompactList}\small\item\em Default rand value: $|$sin(rand)$|$, always $>$= 0 and $<$= 1. \item\end{CompactList}\item
\#define {\bf BETA0}~1.0
2009-08-09 11:17:39 +02:00
\begin{CompactList}\small\item\em Initial value for the inertial momentum of the synapses. \item\end{CompactList}\end{CompactItemize}
2009-08-15 02:59:09 +02:00
\subsection*{Functions}
\begin{CompactItemize}
\item
double {\bf neuralpp::df} (double($\ast$f)(double), double x)
\item
double {\bf neuralpp::\_\-\_\-actv} (double prop)
2009-08-15 02:59:09 +02:00
\end{CompactItemize}
2009-08-09 11:17:39 +02:00
\subsection{Define Documentation}
\index{neural++.hpp@{neural++.hpp}!BETA0@{BETA0}}
\index{BETA0@{BETA0}!neural++.hpp@{neural++.hpp}}
\subsubsection[BETA0]{\setlength{\rightskip}{0pt plus 5cm}\#define BETA0~1.0}\label{neural_09_09_8hpp_05e2bb5b9fc32f0b6b4d84fe43177d72}
2009-08-09 11:17:39 +02:00
Initial value for the inertial momentum of the synapses.
\index{neural++.hpp@{neural++.hpp}!RAND@{RAND}}
\index{RAND@{RAND}!neural++.hpp@{neural++.hpp}}
2009-08-15 02:59:09 +02:00
\subsubsection[RAND]{\setlength{\rightskip}{0pt plus 5cm}\#define RAND~(double) ( (rand() / (RAND\_\-MAX/2)) - 1)}\label{neural_09_09_8hpp_839a9222721835f53c5b248241f535f4}
2009-08-09 11:17:39 +02:00
Default rand value: $|$sin(rand)$|$, always $>$= 0 and $<$= 1.