/tags/R2007-03-28/octave-forge/main/odepkg/inst/odepkg_structure_check.m

# · MATLAB · 365 lines · 194 code · 31 blank · 140 comment · 44 complexity · 1c4c70ece57bc313ec52a82c9b67156d MD5 · raw file 

    

  1. %# Copyright (C) 2006, Thomas Treichl <treichl@users.sourceforge.net>

    2. 

  2. %# OdePkg - Package for solving ordinary differential equations with octave

    3. 

  3. %#

    4. 

  4. %# This program is free software; you can redistribute it and/or modify

    5. 

  5. %# it under the terms of the GNU General Public License as published by

    6. 

  6. %# the Free Software Foundation; either version 2 of the License, or

    7. 

  7. %# (at your option) any later version.

    8. 

  8. %#

    9. 

  9. %# This program is distributed in the hope that it will be useful,

    10. 

  10. %# but WITHOUT ANY WARRANTY; without even the implied warranty of

    11. 

  11. %# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    12. 

  12. %# GNU General Public License for more details.

    13. 

  13. %#

    14. 

  14. %# You should have received a copy of the GNU General Public License

    15. 

  15. %# along with this program; if not, write to the Free Software

    16. 

  16. %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

    17. 

  17. 

    18. 

  18. %# -*- texinfo -*-

    19. 

  19. %# @deftypefn {Function} {@var{odestruct} =} odepkg_structure_check (@var{odestruct})

    20. 

  20. %# Checks the field names and the field values of the odepkg option structure @var{odestruct} and returns it again if it is valid. If an invalid field name or an invalid field value is detected then the function terminates with an error.

    21. 

  21. %#

    22. 

  22. %# Run

    23. 

  23. %# @example

    24. 

  24. %# demo odepkg_structure_check

    25. 

  25. %# @end example

    26. 

  26. %# to see an example.

    27. 

  27. %# @end deftypefn

    28. 

  28. %#

    29. 

  29. %# @seealso{odepkg}

    30. 

  30. 

    31. 

  31. %# Maintainer: Thomas Treichl

    32. 

  32. %# Created: 20060809

    33. 

  33. %# ChangeLog:

    34. 

  34. 

    35. 

  35. function [vret] = odepkg_structure_check (vret)

    36. 

  36.   if (nargin == 0) %# Check number of input arguments

    37. 

  37.     vmsg = sprintf ('Number of input arguments must be greater than zero\n');

    38. 

  38.     help ('odepkg_structure_check'); error (vmsg);

    39. 

  39.   else

    40. 

  40.     vint.fld = fieldnames (vret); vint.len = length (vint.fld);

    41. 

  41.   end

    42. 

  42. 

    43. 

  43.   for vcntarg = 1:vint.len %# Run through the number of structure field names

    44. 

  44. 

    45. 

  45.     switch (vint.fld{vcntarg})

    46. 

  46. 

    47. 

  47.       case 'RelTol'

    48. 

  48.         if (isreal (vret.(vint.fld{vcntarg})) == true && ...

    49. 

  49.             (isvector (vret.(vint.fld{vcntarg})) == true || ...

    50. 

  50.              isscalar (vret.(vint.fld{vcntarg})) == true) && ...

    51. 

  51.             all (vret.(vint.fld{vcntarg}) > 0) == true) %# LabMat needs 'all'?!

    52. 

  52.         else

    53. 

  53.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    54. 

  54.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    55. 

  55.           error (vmsg);

    56. 

  56.         end

    57. 

  57. 

    58. 

  58.       case 'AbsTol'

    59. 

  59.         if (isreal (vret.(vint.fld{vcntarg})) == true && ...

    60. 

  60.             (isvector (vret.(vint.fld{vcntarg})) == true || ...

    61. 

  61.              isscalar (vret.(vint.fld{vcntarg})) == true) && ...

    62. 

  62.             all (vret.(vint.fld{vcntarg}) > 0) == true) %# LabMat needs 'all'?!

    63. 

  63.         else

    64. 

  64.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    65. 

  65.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    66. 

  66.           error (vmsg);

    67. 

  67.         end

    68. 

  68. 

    69. 

  69.       case 'NormControl'

    70. 

  70.         if (strcmp (vret.(vint.fld{vcntarg}), 'on') == true || ...

    71. 

  71.             strcmp (vret.(vint.fld{vcntarg}), 'off') == true)

    72. 

  72.         else

    73. 

  73.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    74. 

  74.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    75. 

  75.           error (vmsg);

    76. 

  76.         end

    77. 

  77. 

    78. 

  78.       case 'NonNegative'

    79. 

  79.         if (isempty (vret.(vint.fld{vcntarg})) == true || ...

    80. 

  80.             isvector (vret.(vint.fld{vcntarg})) == true)

    81. 

  81.         else

    82. 

  82.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    83. 

  83.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    84. 

  84.           error (vmsg);

    85. 

  85.         end

    86. 

  86. 

    87. 

  87.       case 'OutputFcn'

    88. 

  88.         if (isempty (vret.(vint.fld{vcntarg})) == true || ...

    89. 

  89.             isa (vret.(vint.fld{vcntarg}), 'function_handle') == true)

    90. 

  90.         else

    91. 

  91.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    92. 

  92.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    93. 

  93.           error (vmsg);

    94. 

  94.         end

    95. 

  95. 

    96. 

  96.       case 'OutputSel'

    97. 

  97.         if (isempty  (vret.(vint.fld{vcntarg})) == true || ...

    98. 

  98.             isvector (vret.(vint.fld{vcntarg})) == true || ...

    99. 

  99.             isscalar (vret.(vint.fld{vcntarg})) == true)

    100. 

  100.         else

    101. 

  101.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    102. 

  102.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    103. 

  103.           error (vmsg);

    104. 

  104.         end

    105. 

  105. 

    106. 

  106.       case 'Refine'

    107. 

  107.         if (mod (vret.(vint.fld{vcntarg}), 1) == 0 && ...

    108. 

  108.             vret.(vint.fld{vcntarg}) >= 0 && ...

    109. 

  109.             vret.(vint.fld{vcntarg}) <= 5)

    110. 

  110.         else

    111. 

  111.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    112. 

  112.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    113. 

  113.           error (vmsg);

    114. 

  114.         end

    115. 

  115. 

    116. 

  116.       case 'Stats'

    117. 

  117.         if (strcmp (vret.(vint.fld{vcntarg}), 'on') == true || ...

    118. 

  118.             strcmp (vret.(vint.fld{vcntarg}), 'off') == true)

    119. 

  119.         else

    120. 

  120.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    121. 

  121.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    122. 

  122.           error (vmsg);

    123. 

  123.         end

    124. 

  124. 

    125. 

  125.       case 'InitialStep'

    126. 

  126.         if (isempty (vret.(vint.fld{vcntarg})) == true || ...

    127. 

  127.             (isreal (vret.(vint.fld{vcntarg})) == true && ...

    128. 

  128.              vret.(vint.fld{vcntarg}) > 0) )

    129. 

  129.         else

    130. 

  130.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"', ...

    131. 

  131.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    132. 

  132.           error (vmsg);

    133. 

  133.         end

    134. 

  134. 

    135. 

  135.       case 'MaxStep'

    136. 

  136.         if (isempty (vret.(vint.fld{vcntarg})) == true || ...

    137. 

  137.             (isscalar (vret.(vint.fld{vcntarg})) == true && vret.(vint.fld{vcntarg}) > 0) )

    138. 

  138.         else

    139. 

  139.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    140. 

  140.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    141. 

  141.           error (vmsg);

    142. 

  142.         end

    143. 

  143. 

    144. 

  144.       case 'Events'

    145. 

  145.         if (isempty (vret.(vint.fld{vcntarg})) == true || ...

    146. 

  146.             isa (vret.(vint.fld{vcntarg}), 'function_handle') == true)

    147. 

  147.         else

    148. 

  148.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    149. 

  149.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    150. 

  150.           error (vmsg);

    151. 

  151.         end

    152. 

  152. 

    153. 

  153.       case 'Jacobian'

    154. 

  154.         if (isempty (vret.(vint.fld{vcntarg})) == true || ...

    155. 

  155.             ismatrix (vret.(vint.fld{vcntarg})) == true || ...

    156. 

  156.             isa (vret.(vint.fld{vcntarg}), 'function_handle') == true)

    157. 

  157.         else

    158. 

  158.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    159. 

  159.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    160. 

  160.           error (vmsg);

    161. 

  161.         end

    162. 

  162. 

    163. 

  163.       case 'JPattern'

    164. 

  164.         if (isempty (vret.(vint.fld{vcntarg})) == true || ...

    165. 

  165.             issparse (vret.(vint.fld{vcntarg})) == true)

    166. 

  166.         else

    167. 

  167.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    168. 

  168.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    169. 

  169.           error (vmsg);

    170. 

  170.         end

    171. 

  171. 

    172. 

  172.       case 'Vectorized'

    173. 

  173.         if (strcmp (vret.(vint.fld{vcntarg}), 'on') == true || ...

    174. 

  174.             strcmp (vret.(vint.fld{vcntarg}), 'off') == true)

    175. 

  175.         else

    176. 

  176.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    177. 

  177.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    178. 

  178.           error (vmsg);

    179. 

  179.         end

    180. 

  180. 

    181. 

  181.       case 'Mass'

    182. 

  182.         if (isempty (vret.(vint.fld{vcntarg})) == true || ...

    183. 

  183.             ismatrix (vret.(vint.fld{vcntarg})) == true || ...

    184. 

  184.             isa (vret.(vint.fld{vcntarg}), 'function_handle') == true)

    185. 

  185.         else

    186. 

  186.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    187. 

  187.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    188. 

  188.           error (vmsg);

    189. 

  189.         end

    190. 

  190. 

    191. 

  191.       case 'MStateDependence'

    192. 

  192.         if (strcmp (vret.(vint.fld{vcntarg}), 'none') == true || ...

    193. 

  193.             strcmp (vret.(vint.fld{vcntarg}), 'weak') == true || ...

    194. 

  194.             strcmp (vret.(vint.fld{vcntarg}), 'strong') == true)

    195. 

  195.         else

    196. 

  196.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    197. 

  197.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    198. 

  198.           error (vmsg);

    199. 

  199.         end

    200. 

  200. 

    201. 

  201.       case 'MvPattern'

    202. 

  202.         if (isempty (vret.(vint.fld{vcntarg})) == true || ...

    203. 

  203.             issparse (vret.(vint.fld{vcntarg})) == true)

    204. 

  204.         else

    205. 

  205.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    206. 

  206.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    207. 

  207.           error (vmsg);

    208. 

  208.         end

    209. 

  209. 

    210. 

  210.       case 'MassSingular'

    211. 

  211.         if (strcmp (vret.(vint.fld{vcntarg}), 'yes') == true || ...

    212. 

  212.             strcmp (vret.(vint.fld{vcntarg}), 'no') == true || ...

    213. 

  213.             strcmp (vret.(vint.fld{vcntarg}), 'maybe') == true)

    214. 

  214.         else

    215. 

  215.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    216. 

  216.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    217. 

  217.           error (vmsg);

    218. 

  218.         end

    219. 

  219. 

    220. 

  220.       case 'InitialSlope'

    221. 

  221.         if (isempty (vret.(vint.fld{vcntarg})) == true || ...

    222. 

  222.             isvector (vret.(vint.fld{vcntarg})) == true)

    223. 

  223.         else

    224. 

  224.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    225. 

  225.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    226. 

  226.           error (vmsg);

    227. 

  227.         end

    228. 

  228. 

    229. 

  229.       case 'MaxOrder'

    230. 

  230.         if (mod (vret.(vint.fld{vcntarg}), 1) == 0 && ...

    231. 

  231.             vret.(vint.fld{vcntarg}) > 0 && vret.(vint.fld{vcntarg}) < 6)

    232. 

  232.         else

    233. 

  233.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    234. 

  234.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    235. 

  235.           error (vmsg);

    236. 

  236.         end

    237. 

  237. 

    238. 

  238.       case 'BDF'

    239. 

  239.         if (strcmp (vret.(vint.fld{vcntarg}), 'on') == true || ...

    240. 

  240.             strcmp (vret.(vint.fld{vcntarg}), 'off') == true)

    241. 

  241.         else

    242. 

  242.           vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    243. 

  243.             vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    244. 

  244.           error (vmsg);

    245. 

  245.         end

    246. 

  246. 

    247. 

  247.       otherwise

    248. 

  248.         vmsg = sprintf ('Unknown parameter "%s" or invalid parameter value "%s"\n', ...

    249. 

  249.           vint.fld{vcntarg}, char (vret.(vint.fld{vcntarg})));

    250. 

  250.         error (vmsg);

    251. 

  251.     end %# switch

    252. 

  252.   end %# for

    253. 

  253. 

    254. 

  254.   %# The following line can be uncommented for a even higher level error detection

    255. 

  255.   %# if (vint.len ~= 21)

    256. 

  256.   %#   vmsg = sprintf ('Number of fields in structure must match 21');

    257. 

  257.   %#   error (vmsg);

    258. 

  258.   %# end

    259. 

  259. 

    260. 

  260. %!test  A = odeset ('RelTol', 1e-4);         %# odeset calls odepkg_structure_check

    261. 

  261. %!test  A = odeset ('RelTol', [1e-4, 1e-3]); %# after the options have been set

    262. 

  262. %!error A = odeset ('RelTol', []);

    263. 

  263. %!error A = odeset ('RelTol', '1e-4');

    264. 

  264. %!test  A = odeset ('AbsTol', 1e-4);

    265. 

  265. %!test  A = odeset ('AbsTol', [1e-4, 1e-3]);

    266. 

  266. %!error A = odeset ('AbsTol', []);

    267. 

  267. %!error A = odeset ('AbsTol', '1e-4');

    268. 

  268. %!test  A = odeset ('NormControl', 'on');

    269. 

  269. %!test  A = odeset ('NormControl', 'off');

    270. 

  270. %!error A = odeset ('NormControl', []);

    271. 

  271. %!error A = odeset ('NormControl', '12');

    272. 

  272. %!test  A = odeset ('NonNegative', 1);

    273. 

  273. %!test  A = odeset ('NonNegative', [1, 2, 3]);

    274. 

  274. %!error A = odeset ('NonNegative', []);

    275. 

  275. %!error A = odeset ('NonNegative', '12');

    276. 

  276. %!test  A = odeset ('OutputFcn', @odeprint);

    277. 

  277. %!test  A = odeset ('OutputFcn', @odeplot);

    278. 

  278. %!error A = odeset ('OutputFcn', []);

    279. 

  279. %!error A = odeset ('OutputFcn', 'odeprint');

    280. 

  280. %!test  A = odeset ('OutputSel', 1);

    281. 

  281. %!test  A = odeset ('OutputSel', [1, 2, 3]);

    282. 

  282. %!error A = odeset ('OutputSel', []);

    283. 

  283. %!error A = odeset ('OutputSel', '12');

    284. 

  284. %!test  A = odeset ('Refine', 3);

    285. 

  285. %!error A = odeset ('Refine', [1, 2, 3]);

    286. 

  286. %!error A = odeset ('Refine', []);

    287. 

  287. %!error A = odeset ('Refine', 6);

    288. 

  288. %!test  A = odeset ('Stats', 'on');

    289. 

  289. %!test  A = odeset ('Stats', 'off');

    290. 

  290. %!error A = odeset ('Stats', []);

    291. 

  291. %!error A = odeset ('Stats', '12');

    292. 

  292. %!test  A = odeset ('InitialStep', 3);

    293. 

  293. %!error A = odeset ('InitialStep', [1, 2, 3]);

    294. 

  294. %!error A = odeset ('InitialStep', []);

    295. 

  295. %!error A = odeset ('InitialStep', 6);

    296. 

  296. %!test  A = odeset ('MaxStep', 3);

    297. 

  297. %!error A = odeset ('MaxStep', [1, 2, 3]);

    298. 

  298. %!error A = odeset ('MaxStep', []);

    299. 

  299. %!error A = odeset ('MaxStep', 6);

    300. 

  300. %!test  A = odeset ('Events', @demo);

    301. 

  301. %!error A = odeset ('Events', 'off');

    302. 

  302. %!error A = odeset ('Events', []);

    303. 

  303. %!error A = odeset ('Events', '12');

    304. 

  304. %!test  A = odeset ('Jacobian', @demo);

    305. 

  305. %!test  A = odeset ('Jacobian', [1, 2; 3, 4]);

    306. 

  306. %!error A = odeset ('Jacobian', []);

    307. 

  307. %!error A = odeset ('Jacobian', '12');

    308. 

  308. %#!test  A = odeset ('JPattern', );

    309. 

  309. %#!test  A = odeset ('JPattern', );

    310. 

  310. %#!error A = odeset ('JPattern', );

    311. 

  311. %#!error A = odeset ('JPattern', );

    312. 

  312. %!test  A = odeset ('Vectorized', 'on');

    313. 

  313. %!test  A = odeset ('Vectorized', 'off');

    314. 

  314. %!error A = odeset ('Vectorized', []);

    315. 

  315. %!error A = odeset ('Vectorized', '12');

    316. 

  316. %!test  A = odeset ('Mass', @demo);

    317. 

  317. %!test  A = odeset ('Mass', [1, 2; 3, 4]);

    318. 

  318. %!error A = odeset ('Mass', []);

    319. 

  319. %!error A = odeset ('Mass', '12');

    320. 

  320. %!test  A = odeset ('MStateDependence', 'none');

    321. 

  321. %!test  A = odeset ('MStateDependence', 'weak');

    322. 

  322. %!test  A = odeset ('MStateDependence', 'strong');

    323. 

  323. %!error A = odeset ('MStateDependence', [1, 2; 3, 4]);

    324. 

  324. %!error A = odeset ('MStateDependence', []);

    325. 

  325. %!error A = odeset ('MStateDependence', '12');

    326. 

  326. %#!test  A = odeset ('MvPattern', );

    327. 

  327. %#!test  A = odeset ('MvPattern', );

    328. 

  328. %#!error A = odeset ('MvPattern', );

    329. 

  329. %#!error A = odeset ('MvPattern', );

    330. 

  330. %!test  A = odeset ('MassSingular', 'yes');

    331. 

  331. %!test  A = odeset ('MassSingular', 'no');

    332. 

  332. %!test  A = odeset ('MassSingular', 'maybe');

    333. 

  333. %!error A = odeset ('MassSingular', [1, 2; 3, 4]);

    334. 

  334. %!error A = odeset ('MassSingular', []);

    335. 

  335. %!error A = odeset ('MassSingular', '12');

    336. 

  336. %!test  A = odeset ('InitialSlope', [1, 2, 3]);

    337. 

  337. %!error A = odeset ('InitialSlope', 1);

    338. 

  338. %!error A = odeset ('InitialSlope', []);

    339. 

  339. %!error A = odeset ('InitialSlope', '12');

    340. 

  340. %!test  A = odeset ('MaxOrder', 3);

    341. 

  341. %!error A = odeset ('MaxOrder', 3.5);

    342. 

  342. %!error A = odeset ('MaxOrder', [1, 2; 3, 4]);

    343. 

  343. %!error A = odeset ('MaxOrder', []);

    344. 

  344. %!test  A = odeset ('BDF', 'on');

    345. 

  345. %!test  A = odeset ('BDF', 'off');

    346. 

  346. %!error A = odeset ('BDF', [1, 2; 3, 4]);

    347. 

  347. %!error A = odeset ('BDF', []);

    348. 

  348. 

    349. 

  349. %!demo

    350. 

  350. %!

    351. 

  351. %! odepkg_structure_check (odeset);

    352. 

  352. %!

    353. 

  353. %! %----------------------------------------------------------------

    354. 

  354. %! % Returns the checked odepkg options structure created by odeset.

    355. 

  355. %!demo

    356. 

  356. %!

    357. 

  357. %! A = odeset (); odepkg_structure_check (A);

    358. 

  358. %!

    359. 

  359. %! %----------------------------------------------------------------

    360. 

  360. %! % Create the odepkg options structure A with odeset and check

    361. 

  361. %! % it with odepkg_structure_check.

    362. 

  362. 

    363. 

  363. %# Local Variables: ***

    364. 

  364. %# mode: octave ***

    365. 

  365. %# End: ***
    366.