/[ascend]/trunk/base/generic/solver/slv_common.h

Diff of /trunk/base/generic/solver/slv_common.h

Parent Directory | Revision Log | View Patch Patch

-revision 941 by johnpye,
Wed Jun 21 07:00:45 2006 UTC
+revision 942 by johnpye,
Sat Nov 25 05:26:47 2006 UTC
 Line 23
      @file
      SLV common utilities & structures for ASCEND solvers.
-     Routines in this header a applicable to both the system API (as accessed
+     Routines in this header are applicable to both the system API (as accessed
      from ASCEND compiler and GUI/CLI) as well as the solver backend (slv3.c,
      and other solvers, etc)
 Line 66
      #include <solver/logrel.h>
      #include <solver/mtx.h>
      #include <general/list.h>
+ */
+ /** @page solver-parameters Solver Parameters in ASCEND
-     Details on solver parameter definition:
+     @NOTE This stuff REALLY seems painful to use! Is there not a way that
+     we could make it a bit easier? @ENDNOTE
      When used together the parameter-related structures, functions, and
      macros allow us to define all of a solver's parameters in one file
-Line 271 
 struct slv_parameter {
+Line 275 
 struct slv_parameter {
  };
  /*------------------------------------------------------------------------------
+   SOME STRUCTURES FOR SANER INITIALISATION OF PARAMETERS (says I -- JP)
+ */
+ typedef struct{
+     const char *codename;
+     const char *guiname;
+     const int guipagenum;
+     const char *description;
+ } SlvParameterInitMeta;
+ typedef struct{
+     const SlvParameterInitMeta meta;
+     const int val;
+     const int low;
+     const int high;
+ } SlvParameterInitInt;
+ typedef struct{
+     const SlvParameterInitMeta meta;
+     const int val;
+ } SlvParameterInitBool;
+ typedef struct{
+     const SlvParameterInitMeta meta;
+     const double val;
+     const double low;
+     const double high;
+ } SlvParameterInitReal;
+ typedef struct{
+     const SlvParameterInitMeta meta;
+     const char *val;
+     const char *options[]; /* Important: NULL terminated */
+ } SlvParameterInitChar;
+ struct slv_parameters_structure;
+ int slv_param_int (struct slv_parameters_structure *p, const int index, const SlvParameterInitInt);
+ int slv_param_bool(struct slv_parameters_structure *p, const int index, const SlvParameterInitBool);
+ int slv_param_real(struct slv_parameters_structure *p, const int index, const SlvParameterInitReal);
+ int slv_param_char(struct slv_parameters_structure *p, const int index, const SlvParameterInitChar);
+ /* macros to access values from your solver code
+     Usage example:
+         if(SLV_PARAM_BOOL(p,IDA_PARAM_AUTODIFF)){
+             // do something
+         }
+         SLV_PARAM_BOOL(p,IDA_PARAM_AUTODIFF) = FALSE;
+ */
+ /* the first three are read/write */
+ #define SLV_PARAM_INT(PARAMS,INDEX)  (PARAMS)->parms[INDEX].info.i.value
+ #define SLV_PARAM_BOOL(PARAMS,INDEX) (PARAMS)->parms[INDEX].info.b.value
+ #define SLV_PARAM_REAL(PARAMS,INDEX) (PARAMS)->parms[INDEX].info.r.value
+ #define SLV_PARAM_CHAR(PARAMS,INDEX) (PARAMS)->parms[INDEX].info.c.value
+ /**<
+     @NOTE, don't use this macro to set the value of your string, as it will
+     result in memory leaks
+ */
+ /*------------------------------------------------------------------------------
    ACCESSOR MACROS for parm_arg unions
   * Macros for parm_arg unions.
-Line 538 
 typedef struct slv_parameters_structure
+Line 605 
 typedef struct slv_parameters_structure
  ASC_DLLSPEC(void ) slv_destroy_parms(slv_parameters_t *p);
  /**<
      Deallocates any allocated memory held by a parameter structure.
+        * All the 'meta' strings are freed, as they are allocated using ascstrdup.
+        * String values and option arrays are
      Only the held memory is freed, not p itself.  Further, if
      (p->dynamic_parms != 0), the strings in p->parms are freed
      but not p->parms itself.  Does nothing if p is NULL.
+     @NOTE the above description does not appear to be correct! check the code!
      @param p  The parameter structure to destroy.
   */

 Legend:



Removed from v.941
 


changed lines


 
Added in v.942
 Legend:



Removed from v.941
 


changed lines


 
Added in v.942
-Removed from v.941
+Added in v.942

john.pye@anu.edu.au	ViewVC Help
Powered by ViewVC 1.1.22