File: StdDataSet.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 (215 lines) | stat: -rw-r--r-- 9,147 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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

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

<H2>class  <A HREF="#DOC.DOCU">StdDataSet</A></H2></H2><BLOCKQUOTE>Standard Data Set.</BLOCKQUOTE>
<HR>

<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=185>
<param name=classes value="CObject,MObject.html,CDataSet,MDataSet.html,CEuclideanDataSet,MEuclideanDataSet.html,CStdDataSet,MStdDataSet.html,CHtkFileDataSet,MHtkFileDataSet.html,CFileDataSet,MFileDataSet.html">
<param name=before value="M,M,M,M,M|_,Mr_">
<param name=after value="Md_SPSP,Md_SP,Md_,M,M,M">
<param name=indent value="0,1,2,3,3,3">
<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>real** <B><A HREF="#DOC.53.1">all_inputs</A></B>
<DD><I>The inputs table</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>real** <B><A HREF="#DOC.53.2">all_targets</A></B>
<DD><I>The targets table</I>
</DL></P>

<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.53.3">StdDataSet</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.53.4">normalizeUsingDataSet</A></B>(<!1><A HREF="StdDataSet.html">StdDataSet</A>* data_norm)
<DD><I>Normalize the <TT>StdDataSet</TT> using the normalization values of another <TT>StdDataSet</TT>.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.53.5">setInputs</A></B>(real** data_, int n_dim, int n_examples_)
<DD><I>Set the inputs and the targets to a user tabular <TT>n_dim</TT> is the dimension of inputs vectors <TT>n_targets_</TT> is the dimension of targets vectors.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.53.6">setTargets</A></B>(real** y_, int n_targets_)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.53.7">loadFILE</A></B>(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)
<DD><I>Load the normalization parameters</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.53.8">saveFILE</A></B>(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)
<DD><I>Save the normalization parameters</I>
</DL></P>

</DL>
<HR><H3>Inherited from <A HREF="EuclideanDataSet.html">EuclideanDataSet</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>real <B>dotProduct</B>(int i, <!1><A HREF="List.html">List</A>* <!1><A HREF="QCMachine.html#DOC.40.7">y</A>)
<DT>
<IMG ALT="o" SRC=icon2.gif>real <B>realDotProduct</B>(int i, int j)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual   real <B>realRealDotProduct</B>(int i, int j)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual   real <B>realDotProduct</B>(int i, <!1><A HREF="List.html">List</A>* <!1><A HREF="QCMachine.html#DOC.40.7">y</A>)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual   real <B>dotProduct</B>(<!1><A HREF="List.html">List</A>* x, <!1><A HREF="List.html">List</A>* <!1><A HREF="QCMachine.html#DOC.40.7">y</A>)
</DL></P>

<P><DL>
<DT><H3>Public Members</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif> <B>Dot product functions</B>
<DT>
<IMG ALT="o" SRC=icon2.gif> <B>Dot products between two examples.</B>
</DL></P>

</DL>
<HR><H3>Inherited from <A HREF="DataSet.html">DataSet</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Fields</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>int* <B>selected_examples</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>int <B>current_example</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>int <B>n_targets</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>void* <B>targets</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>int <B>n_inputs</B>
<DT>
<IMG ALT="o" SRC=icon2.gif><!1><A HREF="List.html">List</A>* <B>inputs</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>int <B>n_examples</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>int <B>n_real_examples</B>
</DL></P>

<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setExample</B>(int t)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual   void <B>setRealExample</B>(int t)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>pushSubset</B>(int* subset_, int n_examples_)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>popSubset</B>()
</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>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>Standard Data Set.

<P>DataSet with a vector of reals for inputs,
and a vector of real for targets.

<P>This DataSet support normalization with mean/variance.

<P>Options:
<TABLE BORDER>
<TR><TD>
"normalize inputs"  </TD><TD>  bool </TD><TD>   normalize the inputs by mean/stdv  </TD><TD> [false]</TD></TR><TR><TD>
"normalize targets" </TD><TD>  bool </TD><TD>   normalize the targets by mean/stdv </TD><TD> [false]
</TR></TABLE>

<P></BLOCKQUOTE>
<DL>

<A NAME="all_inputs"></A>
<A NAME="DOC.53.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>real** all_inputs</B></TT>
<DD>The inputs table
<DL><DT><DD></DL><P>
<A NAME="all_targets"></A>
<A NAME="DOC.53.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>real** all_targets</B></TT>
<DD>The targets table
<DL><DT><DD></DL><P>
<A NAME="StdDataSet"></A>
<A NAME="DOC.53.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> StdDataSet()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="normalizeUsingDataSet"></A>
<A NAME="DOC.53.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void normalizeUsingDataSet(<!1><A HREF="StdDataSet.html">StdDataSet</A>* data_norm)</B></TT>
<DD>Normalize the <TT>StdDataSet</TT> using the normalization values
of another <TT>StdDataSet</TT>. If the other dataset is not normalize,
nothing will be done.

<P>Call it AFTER <TT>init()</TT>.
<DL><DT><DD></DL><P>
<A NAME="setInputs"></A>
<A NAME="DOC.53.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setInputs(real** data_, int n_dim, int n_examples_)</B></TT>
<DD>Set the inputs and the targets to a user tabular
<TT>n_dim</TT> is the dimension of inputs vectors
<TT>n_targets_</TT> is the dimension of targets vectors.

<P>Call them BEFORE <TT>init()</TT>.
<DL><DT><DD></DL><P>
<A NAME="setTargets"></A>
<A NAME="DOC.53.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setTargets(real** y_, int n_targets_)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="loadFILE"></A>
<A NAME="DOC.53.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void loadFILE(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)</B></TT>
<DD>Load the normalization parameters
<DL><DT><DD></DL><P>
<A NAME="saveFILE"></A>
<A NAME="DOC.53.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void saveFILE(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)</B></TT>
<DD>Save the normalization parameters
<DL><DT><DD></DL><P></DL>
<HR>
<DL><DT><B>Direct child classes:
</B><DD><A HREF="HtkFileDataSet.html">HtkFileDataSet</A><BR>
<A HREF="FileDataSet.html">FileDataSet</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>