File: Measurer.html

package info (click to toggle)
torch 2-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 5,488 kB
  • ctags: 3,217
  • sloc: cpp: 14,272; makefile: 201
file content (167 lines) | stat: -rw-r--r-- 8,083 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<HTML>
<HEAD>
   <TITLE>class  Measurer</TITLE>
   <META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
</HEAD>
<BODY BGCOLOR="#ffffff">

<H2>class  <A HREF="#DOC.DOCU">Measurer</A></H2></H2><BLOCKQUOTE>Used to measure what you want during training/testing.</BLOCKQUOTE>
<HR>

<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=335>
<param name=classes value="CObject,MObject.html,CMeasurer,MMeasurer.html,CWordSegMeasurer,MWordSegMeasurer.html,CTimeMeasurer,MTimeMeasurer.html,CSaturationMeasurer,MSaturationMeasurer.html,COutputMeasurer,MOutputMeasurer.html,CNllMeasurer,MNllMeasurer.html,CMseMeasurer,MMseMeasurer.html,CEditDistanceMeasurer,MEditDistanceMeasurer.html,CClassMeasurer,MClassMeasurer.html,CBoostingMeasurer,MBoostingMeasurer.html">
<param name=before value="M,M,M|_,MR_,MR_,MR_,MR_,MR_,MR_,MR_,Mr_">
<param name=after value="Md_,M,M,M,M,M,M,M,M,M,M">
<param name=indent value="0,1,1,1,1,1,1,1,1,1,1">
<param name=arrowdir value="down">
</APPLET>
<HR>

<DL>
<P><DL>
<DT><H3>Public Fields</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void* <B><A HREF="#DOC.30.1">measure</A></B>
<DD><I>The measurer put here what it measures.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>FILE* <B><A HREF="#DOC.30.2">file</A></B>
<DD><I>The measurer save measures in this file</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="DataSet.html">DataSet</A>* <B><A HREF="#DOC.30.3">data</A></B>
<DD><I>The associated <TT>DataSet</TT></I>
</DL></P>

<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.30.4">Measurer</A></B>(<!1><A HREF="DataSet.html">DataSet</A>* data_, FILE* file_)
<DD><I>Measurer with the associated <TT>DataSet</TT> <TT>data_</TT>, and put results in the file <TT>file_</TT></I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.30.5">Measurer</A></B>(<!1><A HREF="DataSet.html">DataSet</A>* data_, const char* filename)
<DD><I>Open the file <TT>filename</TT> for writing measures.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.30.6">measureEx</A></B>()
<DD><I>Measure something for the current example.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.30.7">measureIter</A></B>()
<DD><I>Measure something after the current iteration.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.30.8">measureEnd</A></B>()
<DD><I>Measure something at the end of the training/testing phase</I>
</DL></P>

</DL>
<HR><H3>Inherited from <A HREF="Object.html">Object</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>virtual   void <B>init</B>()
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, int size, void* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addIOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, int* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, int init_value, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addROption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, real* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, real init_value, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addBOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, bool* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, bool init_value, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, void* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setIOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, int option)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setROption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, real option)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setBOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, bool option)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual   void <B>loadFILE</B>(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual   void <B>saveFILE</B>(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>load</B>(const char* filename)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>save</B>(const char* filename)
</DL></P>

</DL>

<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>Used to measure what you want during training/testing.
Usually, trainers call measurers.
The <TT>DataSet</TT> associated to the measurer allow us
to know when the measurer should be called.
(if the <TT>DataSet</TT> is the train dataset, the
measurer will be called during the train phase...)

<P></BLOCKQUOTE>
<DL>

<A NAME="measure"></A>
<A NAME="DOC.30.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void* measure</B></TT>
<DD>The measurer put here what it measures.
As it could be everything, you should
know what's inside before using it.
<DL><DT><DD></DL><P>
<A NAME="file"></A>
<A NAME="DOC.30.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>FILE* file</B></TT>
<DD>The measurer save measures in this file
<DL><DT><DD></DL><P>
<A NAME="data"></A>
<A NAME="DOC.30.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="DataSet.html">DataSet</A>* data</B></TT>
<DD>The associated <TT>DataSet</TT>
<DL><DT><DD></DL><P>
<A NAME="Measurer"></A>
<A NAME="DOC.30.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> Measurer(<!1><A HREF="DataSet.html">DataSet</A>* data_, FILE* file_)</B></TT>
<DD>Measurer with the associated <TT>DataSet</TT> <TT>data_</TT>,
and put results in the file <TT>file_</TT>
<DL><DT><DD></DL><P>
<A NAME="Measurer"></A>
<A NAME="DOC.30.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> Measurer(<!1><A HREF="DataSet.html">DataSet</A>* data_, const char* filename)</B></TT>
<DD>Open the file <TT>filename</TT> for writing measures.        
<TT>data_</TT> is the associated <TT>DataSet</TT>.
<DL><DT><DD></DL><P>
<A NAME="measureEx"></A>
<A NAME="DOC.30.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void measureEx()</B></TT>
<DD>Measure something for the current example.
(This example has been selected in <TT>data</TT>
by the trainer)
<DL><DT><DD></DL><P>
<A NAME="measureIter"></A>
<A NAME="DOC.30.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void measureIter()</B></TT>
<DD>Measure something after the current iteration.
(After the call of <TT>measureEx()</TT> for each
example of <TT>data</TT>)
<DL><DT><DD></DL><P>
<A NAME="measureEnd"></A>
<A NAME="DOC.30.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void measureEnd()</B></TT>
<DD>Measure something at the end of the training/testing phase
<DL><DT><DD></DL><P></DL>
<HR>
<DL><DT><B>Direct child classes:
</B><DD><A HREF="WordSegMeasurer.html">WordSegMeasurer</A><BR>
<A HREF="TimeMeasurer.html">TimeMeasurer</A><BR>
<A HREF="SaturationMeasurer.html">SaturationMeasurer</A><BR>
<A HREF="OutputMeasurer.html">OutputMeasurer</A><BR>
<A HREF="NllMeasurer.html">NllMeasurer</A><BR>
<A HREF="MseMeasurer.html">MseMeasurer</A><BR>
<A HREF="EditDistanceMeasurer.html">EditDistanceMeasurer</A><BR>
<A HREF="ClassMeasurer.html">ClassMeasurer</A><BR>
<A HREF="BoostingMeasurer.html">BoostingMeasurer</A><BR>
</DL>

<DL><DT><DT><B>Author:</B><DD>Ronan Collobert (collober@iro.umontreal.ca)
<DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>