Mercurial > hg > camir-aes2014

diff toolboxes/FullBNT-1.0.7/nethelp3.3/consist.htm @ 0:e9a9cd732c1e tip
first hg version after svn
author: wolffd
date: Tue, 10 Feb 2015 15:05:51 +0000
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/toolboxes/FullBNT-1.0.7/nethelp3.3/consist.htm	Tue Feb 10 15:05:51 2015 +0000
@@ -0,0 +1,78 @@
+<html>
+<head>
+<title>
+Netlab Reference Manual consist
+</title>
+</head>
+<body>
+<H1> consist
+</H1>
+<h2>
+Purpose
+</h2>
+Check that arguments are consistent.
+
+<p><h2>
+Synopsis
+</h2>
+<PRE>
+errstring = consist(net, type, inputs, outputs)
+errstring = consist(net, type, inputs)
+errstring = consist(net, type)
+</PRE>
+
+
+<p><h2>
+Description
+</h2>
+
+<p><CODE>errstring = consist(net, type, inputs)</CODE> takes a network
+data structure <CODE>net</CODE> together with a string <CODE>type</CODE> containing
+the correct network type, a matrix <CODE>inputs</CODE> of input vectors and checks
+that the data structure is consistent with the other arguments.  An empty
+string is returned if there is no error, otherwise the string contains the
+relevant error message.  If the <CODE>type</CODE> string is empty, then any
+type of network is allowed.
+
+<p><CODE>errstring = consist(net, type)</CODE> takes a network data structure
+<CODE>net</CODE> together with a string <CODE>type</CODE> containing the correct 
+network type, and checks that the two types match.
+
+<p><CODE>errstring = consist(net, type, inputs, outputs)</CODE> also checks that the
+network has the correct number of outputs, and that the number of patterns
+in the <CODE>inputs</CODE> and <CODE>outputs</CODE> is the same.  The fields in <CODE>net</CODE>
+that are used are
+<PRE>
+  type
+  nin
+  nout
+</PRE>
+
+
+<p><h2>
+Example
+</h2>
+
+<p><CODE>mlpfwd</CODE>, the function that propagates values forward through an MLP
+network, has the following check at the head of the file:
+<PRE>
+
+errstring = consist(net, 'mlp', x, t);
+if ~isempty(errstring)
+  error(errstring)
+end
+</PRE>
+
+
+<p><h2>
+See Also
+</h2>
+<CODE><a href="mlpfwd.htm">mlpfwd</a></CODE><hr>
+<b>Pages:</b>
+<a href="index.htm">Index</a>
+<hr>
+<p>Copyright (c) Ian T Nabney (1996-9)
+
+
+</body>
+</html>
\ No newline at end of file
author	wolffd
date	Tue, 10 Feb 2015 15:05:51 +0000
parents
children