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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class Object</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class <A HREF="#DOC.DOCU">Object</A></H2></H2><BLOCKQUOTE>Provides a useful interface for managing options.</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=545>
<param name=classes value="CObject,MObject.html,CVec,MVec.html,CTrainer,MTrainer.html,CQCCache,MQCCache.html,CPerm,MPerm.html,COptimizer,MOptimizer.html,CMeasurer,MMeasurer.html,CMat,MMat.html,CMachine,MMachine.html,CKernel,MKernel.html,CIOTorch,MIOTorch.html,CIOHtk,MIOHtk.html,CGrammar,MGrammar.html,CEditDistance,MEditDistance.html,CDictionary,MDictionary.html,CDataSet,MDataSet.html,CCmdLine,MCmdLine.html,CClassFormat,MClassFormat.html">
<param name=before value="M,M|_,MR_,MR_,MR_,MR_,MR_,MR_,MR_,MR_,MR_,MR_,MR_,MR_,MR_,MR_,MR_,Mr_">
<param name=after value="M,M,M,M,M,M,M,M,M,M,M,M,M,M,M,M,M,M">
<param name=indent value="0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.36.1">Object</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.36.2">init</A></B>()
<DD><I>Initialize the object.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.36.3">addOption</A></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)
<DD><I>Add the option <TT>name</TT>.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.36.4">addIOption</A></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)
<DD><I>Several wrappers of <TT>addOption()</TT> for Int, Real and Bool options.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.36.5">addROption</A></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="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.36.6">addBOption</A></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="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.36.7">setOption</A></B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, void* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>)
<DD><I>Set the option <TT>name</TT> to the value contained at <TT>ptr</TT></I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.36.8">setIOption</A></B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, int option)
<DD><I>Several wrappers of <TT>setOption()</TT> for Int, Real and Bool options.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.36.9">setROption</A></B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, real option)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.36.10">setBOption</A></B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, bool option)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.36.11">loadFILE</A></B>(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)
<DD><I>Load the object from a file pointer (<EM>not the options</EM>)</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.36.12">saveFILE</A></B>(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)
<DD><I>Save the object to a file pointer (<EM>not the options</EM>)</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.36.13">load</A></B>(const char* filename)
<DD><I>Load the machine from a file name (<EM>not the options</EM>)</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.36.14">save</A></B>(const char* filename)
<DD><I>Save the machine to a file name (<EM>not the options</EM>)</I>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>Provides a useful interface for managing options.
Class inherited by almost all classes in Torch.
<P></BLOCKQUOTE>
<DL>
<A NAME="Object"></A>
<A NAME="DOC.36.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> Object()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="init"></A>
<A NAME="DOC.36.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void init()</B></TT>
<DD>Initialize the object.
All objects *MUST* call the <TT>init()</TT>
function of their parents.
<DL><DT><DD></DL><P>
<A NAME="addOption"></A>
<A NAME="DOC.36.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void addOption(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)</B></TT>
<DD>Add the option <TT>name</TT>.
This one has a pointer on <TT>ptr</TT> and has the size <TT>size</TT>.
You can provide an help in <TT>help</TT>.
(Note that if <TT>help</TT> is empty, its an empty string and not NULL).
If the option can be changed at any time, you can set
<TT>is_allowed_after_init</TT> to <TT>true</TT>.
<DL><DT><DD></DL><P>
<A NAME="addIOption"></A>
<A NAME="DOC.36.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void addIOption(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)</B></TT>
<DD>Several wrappers of <TT>addOption()</TT> for
Int, Real and Bool options.
Be carefull: there is no type checking.
<DL><DT><DD></DL><P>
<A NAME="addROption"></A>
<A NAME="DOC.36.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void addROption(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)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="addBOption"></A>
<A NAME="DOC.36.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void addBOption(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)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setOption"></A>
<A NAME="DOC.36.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setOption(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, void* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>)</B></TT>
<DD>Set the option <TT>name</TT> to the value contained at <TT>ptr</TT>
<DL><DT><DD></DL><P>
<A NAME="setIOption"></A>
<A NAME="DOC.36.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setIOption(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, int option)</B></TT>
<DD>Several wrappers of <TT>setOption()</TT> for
Int, Real and Bool options.
Be carefull: there is no type checking.
<DL><DT><DD></DL><P>
<A NAME="setROption"></A>
<A NAME="DOC.36.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setROption(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, real option)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setBOption"></A>
<A NAME="DOC.36.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setBOption(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, bool option)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="loadFILE"></A>
<A NAME="DOC.36.11"></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 object from a file pointer (<EM>not the options</EM>)
<DL><DT><DD></DL><P>
<A NAME="saveFILE"></A>
<A NAME="DOC.36.12"></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 object to a file pointer (<EM>not the options</EM>)
<DL><DT><DD></DL><P>
<A NAME="load"></A>
<A NAME="DOC.36.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void load(const char* filename)</B></TT>
<DD>Load the machine from a file name (<EM>not the options</EM>)
<DL><DT><DD></DL><P>
<A NAME="save"></A>
<A NAME="DOC.36.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void save(const char* filename)</B></TT>
<DD>Save the machine to a file name (<EM>not the options</EM>)
<DL><DT><DD></DL><P></DL>
<HR>
<DL><DT><B>Direct child classes:
</B><DD><A HREF="Vec.html">Vec</A><BR>
<A HREF="Trainer.html">Trainer</A><BR>
<A HREF="QCCache.html">QCCache</A><BR>
<A HREF="Perm.html">Perm</A><BR>
<A HREF="Optimizer.html">Optimizer</A><BR>
<A HREF="Measurer.html">Measurer</A><BR>
<A HREF="Mat.html">Mat</A><BR>
<A HREF="Machine.html">Machine</A><BR>
<A HREF="Kernel.html">Kernel</A><BR>
<A HREF="IOTorch.html">IOTorch</A><BR>
<A HREF="IOHtk.html">IOHtk</A><BR>
<A HREF="Grammar.html">Grammar</A><BR>
<A HREF="EditDistance.html">EditDistance</A><BR>
<A HREF="Dictionary.html">Dictionary</A><BR>
<A HREF="DataSet.html">DataSet</A><BR>
<A HREF="CmdLine.html">CmdLine</A><BR>
<A HREF="ClassFormat.html">ClassFormat</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>
|
