annotate toolboxes/FullBNT-1.0.7/nethelp3.3/consist.htm @ 0:cc4b1211e677 tip

initial commit to HG from Changeset: 646 (e263d8a21543) added further path and more save "camirversion.m"
author Daniel Wolff
date Fri, 19 Aug 2016 13:07:06 +0200
parents
children
rev   line source
Daniel@0 1 <html>
Daniel@0 2 <head>
Daniel@0 3 <title>
Daniel@0 4 Netlab Reference Manual consist
Daniel@0 5 </title>
Daniel@0 6 </head>
Daniel@0 7 <body>
Daniel@0 8 <H1> consist
Daniel@0 9 </H1>
Daniel@0 10 <h2>
Daniel@0 11 Purpose
Daniel@0 12 </h2>
Daniel@0 13 Check that arguments are consistent.
Daniel@0 14
Daniel@0 15 <p><h2>
Daniel@0 16 Synopsis
Daniel@0 17 </h2>
Daniel@0 18 <PRE>
Daniel@0 19 errstring = consist(net, type, inputs, outputs)
Daniel@0 20 errstring = consist(net, type, inputs)
Daniel@0 21 errstring = consist(net, type)
Daniel@0 22 </PRE>
Daniel@0 23
Daniel@0 24
Daniel@0 25 <p><h2>
Daniel@0 26 Description
Daniel@0 27 </h2>
Daniel@0 28
Daniel@0 29 <p><CODE>errstring = consist(net, type, inputs)</CODE> takes a network
Daniel@0 30 data structure <CODE>net</CODE> together with a string <CODE>type</CODE> containing
Daniel@0 31 the correct network type, a matrix <CODE>inputs</CODE> of input vectors and checks
Daniel@0 32 that the data structure is consistent with the other arguments. An empty
Daniel@0 33 string is returned if there is no error, otherwise the string contains the
Daniel@0 34 relevant error message. If the <CODE>type</CODE> string is empty, then any
Daniel@0 35 type of network is allowed.
Daniel@0 36
Daniel@0 37 <p><CODE>errstring = consist(net, type)</CODE> takes a network data structure
Daniel@0 38 <CODE>net</CODE> together with a string <CODE>type</CODE> containing the correct
Daniel@0 39 network type, and checks that the two types match.
Daniel@0 40
Daniel@0 41 <p><CODE>errstring = consist(net, type, inputs, outputs)</CODE> also checks that the
Daniel@0 42 network has the correct number of outputs, and that the number of patterns
Daniel@0 43 in the <CODE>inputs</CODE> and <CODE>outputs</CODE> is the same. The fields in <CODE>net</CODE>
Daniel@0 44 that are used are
Daniel@0 45 <PRE>
Daniel@0 46 type
Daniel@0 47 nin
Daniel@0 48 nout
Daniel@0 49 </PRE>
Daniel@0 50
Daniel@0 51
Daniel@0 52 <p><h2>
Daniel@0 53 Example
Daniel@0 54 </h2>
Daniel@0 55
Daniel@0 56 <p><CODE>mlpfwd</CODE>, the function that propagates values forward through an MLP
Daniel@0 57 network, has the following check at the head of the file:
Daniel@0 58 <PRE>
Daniel@0 59
Daniel@0 60 errstring = consist(net, 'mlp', x, t);
Daniel@0 61 if ~isempty(errstring)
Daniel@0 62 error(errstring)
Daniel@0 63 end
Daniel@0 64 </PRE>
Daniel@0 65
Daniel@0 66
Daniel@0 67 <p><h2>
Daniel@0 68 See Also
Daniel@0 69 </h2>
Daniel@0 70 <CODE><a href="mlpfwd.htm">mlpfwd</a></CODE><hr>
Daniel@0 71 <b>Pages:</b>
Daniel@0 72 <a href="index.htm">Index</a>
Daniel@0 73 <hr>
Daniel@0 74 <p>Copyright (c) Ian T Nabney (1996-9)
Daniel@0 75
Daniel@0 76
Daniel@0 77 </body>
Daniel@0 78 </html>