a62df4624ea67a29601c20f8c665abb85a2b65c3
[scilab.git] / scilab / modules / optimization / macros / optimbase / optimbase_configure.sci
1 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
2 // Copyright (C) 2008-2009 - INRIA - Michael Baudin
3 // Copyright (C) 2009-2011 - DIGITEO - Michael Baudin
4 //
5 // This file must be used under the terms of the CeCILL.
6 // This source file is licensed as described in the file COPYING, which
7 // you should have received as part of this distribution.  The terms
8 // are also available at
9 // http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
10
11 //
12 // optimbase_configure --
13 //   Configure the current object with the given value for the given key.
14 //
15 function this = optimbase_configure (this,key,value)
16     UN=number_properties("tiny")
17     [lhs,rhs]=argn();
18     if ( rhs <> 3 ) then
19         errmsg = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "optimbase_configure", 3);
20         error(errmsg)
21     end
22     select key
23     case "-verbose" then
24         optimbase_typereal ( value , "value" , 3 );
25         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
26         optimbase_checkgreq ( "optimbase_configure" , value , "value" , 3 , 0 )
27         this.verbose = value;
28     case "-verbosetermination" then
29         optimbase_typereal ( value , "value" , 3 );
30         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
31         optimbase_checkgreq ( "optimbase_configure" , value , "value" , 3 , 0 )
32         this.verbosetermination = value;
33     case "-logfile" then
34         optimbase_typestring ( value , "value" , 3 );
35         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
36         if ( this.logstartup ) then
37             this = optimbase_logshutdown ( this )
38         end
39         this.logfile = value;
40         this = optimbase_logstartup ( this );
41     case "-x0" then
42         optimbase_typereal ( value , "value" , 3 );
43         [n,m] = size(value);
44         if m<>1 then
45             errmsg = msprintf(gettext("%s: The x0 vector is expected to be a column matrix, but current shape is %d x %d"),"optimbase_configure",n,m);
46             error(errmsg);
47         end
48         this.x0 = value;
49     case "-maxfunevals" then
50         optimbase_typereal ( value , "value" , 3 );
51         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
52         optimbase_checkgreq ( "optimbase_configure" , value , "value" , 3 , 1 )
53         this.maxfunevals = value;
54     case "-maxiter" then
55         optimbase_typereal ( value , "value" , 3 );
56         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
57         optimbase_checkgreq ( "optimbase_configure" , value , "value" , 3 , 1 )
58         this.maxiter = value;
59     case "-tolfunabsolute" then
60         optimbase_typereal ( value , "value" , 3 );
61         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
62         optimbase_checkgreq ( "optimbase_configure" , value , "value" , 3 , 0 )
63         this.tolfunabsolute = value;
64     case "-tolfunrelative" then
65         optimbase_typereal ( value , "value" , 3 );
66         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
67         optimbase_checkgreq ( "optimbase_configure" , value , "value" , 3 , 0 )
68         this.tolfunrelative = value;
69     case "-tolxabsolute" then
70         optimbase_typereal ( value , "value" , 3 );
71         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
72         optimbase_checkgreq ( "optimbase_configure" , value , "value" , 3 , 0 )
73         this.tolxabsolute = value;
74     case "-tolxrelative" then
75         optimbase_typereal ( value , "value" , 3 );
76         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
77         optimbase_checkgreq ( "optimbase_configure" , value , "value" , 3 , 0 )
78         this.tolxrelative = value;
79     case "-tolxmethod" then
80         optimbase_typeboolean ( value , "value" , 3 );
81         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
82         this.tolxmethod = value;
83     case "-tolfunmethod" then
84         optimbase_typeboolean ( value , "value" , 3 );
85         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
86         this.tolfunmethod = value;
87     case "-function" then
88         optimbase_typecallable ( value , "value" , 3)
89         this.fun = value;
90     case "-outputcommand" then
91         optimbase_typecallable ( value , "value" , 3)
92         this.outputcommand = value;
93     case "-numberofvariables" then
94         optimbase_typereal ( value , "value" , 3 );
95         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
96         optimbase_checkgreq ( "optimbase_configure" , value , "value" , 3 , 1 )
97         this.numberofvariables = value;
98     case "-storehistory" then
99         optimbase_typeboolean ( value , "value" , 3 );
100         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
101         this.storehistory = value;
102     case "-boundsmin" then
103         optimbase_typereal ( value , "value" , 3 );
104         this.boundsmin = value;
105     case "-boundsmax" then
106         optimbase_typereal ( value , "value" , 3 );
107         this.boundsmax = value;
108     case "-nbineqconst" then
109         optimbase_typereal ( value , "value" , 3 );
110         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
111         optimbase_checkgreq ( "optimbase_configure" , value , "value" , 3 , 0 )
112         this.nbineqconst = value;
113     case "-withderivatives" then
114         optimbase_typeboolean ( value , "value" , 3 );
115         optimbase_checkscalar ( "optimbase_configure" , value , "value" , 3 )
116         this.withderivatives = value;
117         //
118         // Obsolete options.
119         //
120     else
121         errmsg = msprintf(gettext("%s: Unknown key %s"),"optimbase_configure",key)
122         error(errmsg)
123     end
124 endfunction
125 // Generates an error if the given variable is not of type real
126 function optimbase_typereal ( var , varname , ivar )
127     if ( type ( var ) <> 1 ) then
128         errmsg = msprintf(gettext("%s: Expected real variable for variable %s at input #%d, but got %s instead."),"optimbase_typereal", varname , ivar , typeof(var) );
129         error(errmsg);
130     end
131 endfunction
132 // Generates an error if the given variable is not of type string
133 function optimbase_typestring ( var , varname , ivar )
134     if ( type ( var ) <> 10 ) then
135         errmsg = msprintf(gettext("%s: Expected string variable for variable %s at input #%d, but got %s instead."),"optimbase_typestring", varname , ivar , typeof(var) );
136         error(errmsg);
137     end
138 endfunction
139 // Generates an error if the given variable is not of type function (macro)
140 function optimbase_typefunction ( var , varname , ivar )
141     if ( type ( var ) <> 13 ) then
142         errmsg = msprintf(gettext("%s: Expected function but for variable %s at input #%d, got %s instead."),"optimbase_typefunction", varname , ivar , typeof(var) );
143         error(errmsg);
144     end
145 endfunction
146 // Generates an error if the given variable is not of type boolean
147 function optimbase_typeboolean ( var , varname , ivar )
148     if ( type ( var ) <> 4 ) then
149         errmsg = msprintf(gettext("%s: Expected boolean but for variable %s at input #%d, got %s instead."),"optimbase_typeboolean", varname , ivar , typeof(var) );
150         error(errmsg);
151     end
152 endfunction
153
154 // Generates an error if the value corresponding to an option is unknown.
155 function unknownValueForOption ( value , optionname )
156     errmsg = msprintf(gettext("%s: Unknown value %s for %s option"),"unknownValueForOption",value , optionname );
157     error(errmsg);
158 endfunction
159
160 function optimbase_typecallable ( var , varname , ivar )
161     // Check that var is a function or a list
162     if ( and ( type ( var ) <> [11 13 15] ) ) then
163         errmsg = msprintf(gettext("%s: Expected function or list for variable %s at input #%d, but got %s instead."),"optimbase_typecallable", varname , ivar , typeof(var) );
164         error(errmsg);
165     end
166     if ( type ( var ) == 15 ) then
167         // Check that var(1) is a function
168         if ( and ( type ( var(1) ) <> [11 13] ) ) then
169             errmsg = msprintf(gettext("%s: Expected function for variable %s(1) at input #%d, but got %s instead."),"optimbase_typecallable", varname , ivar , typeof(var) );
170             error(errmsg);
171         end
172     end
173 endfunction
174
175 function optimbase_checkrange ( funname , var , varname , ivar , vmin , vmax )
176     if ( ~and ( vmin <= var & var <= vmax ) ) then
177         k = find ( vmin > var | var > vmax )
178         k = k(1)
179         errmsg = msprintf(gettext("%s: Expected that all entries of input argument %s at input #%d are in the range [%s,%s], but entry #%d is equal to %s."),funname,varname,ivar,string(vmin),string(vmax),k,string(var(k)));
180         error(errmsg);
181     end
182 endfunction
183
184 function optimbase_checkgreq ( funname , var , varname , ivar , thr )
185     if ( or ( var < thr ) ) then
186         k = find ( var < thr )
187         k = k(1)
188         errmsg = msprintf(gettext("%s: Expected that all entries of input argument %s at input #%d are greater or equal than %s, but entry #%d is equal to %s."),funname,varname,ivar,string(thr),k,string(var(k)));
189         error(errmsg);
190     end
191 endfunction
192
193 function optimbase_checkflint ( funname , var , varname , ivar )
194     if ( or ( round(var)<>var ) ) then
195         k = find ( round(var)<>var )
196         k = k(1)
197         errmsg = msprintf(gettext("%s: Expected floating point integer for input argument %s at input #%d, but entry #%d is equal to %s."),funname,varname,ivar,k,string(var(k)));
198         error(errmsg);
199     end
200 endfunction
201
202 function optimbase_checkscalar ( funname , var , varname , ivar )
203     if ( or(size(var) <> [1 1]) ) then
204         strcomp = strcat(string(size(var))," ")
205         errmsg = msprintf(gettext("%s: Wrong size for input argument #%d: %d-by-%d matrix expected.\n"), funname, ivar , 1, 1 );
206         error(errmsg)
207     end
208 endfunction
209
210 function optimbase_checkoption ( funname , var , varname , ivar , expectedopt )
211     if ( and ( var <> expectedopt ) ) then
212         stradd = """ or """
213         strexp = """" + strcat(string(expectedopt),stradd) + """"
214         errmsg = msprintf(gettext("%s: Expected value [%s] for input argument %s at input #%d, but got ""%s"" instead."),funname,strexp,varname,ivar,string(var));
215         error(errmsg);
216     end
217 endfunction
218