/[ascend]/trunk/base/generic/solver/slv_client.h
ViewVC logotype

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1033 by johnpye, Sat Nov 25 10:46:13 2006 UTC revision 1034 by johnpye, Thu Jan 4 05:37:55 2007 UTC
# Line 317  typedef linsol_system_t (SlvGetLinsolF)( Line 317  typedef linsol_system_t (SlvGetLinsolF)(
317  typedef linsolqr_system_t (SlvGetLinSysF)(slv_system_t, SlvClientToken);  typedef linsolqr_system_t (SlvGetLinSysF)(slv_system_t, SlvClientToken);
318  typedef mtx_matrix_t (SlvGetSysMtxF)(slv_system_t, SlvClientToken);  typedef mtx_matrix_t (SlvGetSysMtxF)(slv_system_t, SlvClientToken);
319  typedef void (SlvDumpInfoF)(slv_system_t, SlvClientToken,int);  typedef void (SlvDumpInfoF)(slv_system_t, SlvClientToken,int);
320  typedef void (SlvSolveF)(slv_system_t, SlvClientToken);  typedef int (SlvSolveF)(slv_system_t, SlvClientToken);
321    
322  /** Registration information for a solver.  /** Registration information for a solver.
323      @TODO Complete documentation of slv_registration_data members.      @TODO Complete documentation of slv_registration_data members.
# Line 1144  ASC_DLLSPEC(void ) slv_dump_internals(sl Line 1144  ASC_DLLSPEC(void ) slv_dump_internals(sl
1144      @TODO fix dubious documentation (return type is void...)      @TODO fix dubious documentation (return type is void...)
1145  */  */
1146    
1147  ASC_DLLSPEC(void) slv_presolve(slv_system_t sys);  ASC_DLLSPEC(int) slv_presolve(slv_system_t sys);
1148  /**<  /**<
1149      Prepares the system for solving.  This must be called before the      Prepares the system for solving.  This must be called before the
1150      system is solved, but after everything about the system is set up      system is solved, but after everything about the system is set up
# Line 1163  ASC_DLLSPEC(void) slv_presolve(slv_syste Line 1163  ASC_DLLSPEC(void) slv_presolve(slv_syste
1163    
1164      Among other things, this function will perform structural analysis      Among other things, this function will perform structural analysis
1165      so that structural analysis flags in the status will be accurate.      so that structural analysis flags in the status will be accurate.
1166    
1167        @return 0 on success, 1 if errors occurred (they will be output via ERROR_REPORTER)
1168  */  */
1169    
1170  ASC_DLLSPEC(void ) slv_resolve(slv_system_t sys);  ASC_DLLSPEC(int) slv_resolve(slv_system_t sys);
1171  /**<  /**<
1172      This function re-prepares the system for solving.  This function may      This function re-prepares the system for solving.  This function may
1173      be used instead of slv_presolve, provided the system was partially      be used instead of slv_presolve, provided the system was partially
# Line 1189  ASC_DLLSPEC(void ) slv_resolve(slv_syste Line 1191  ASC_DLLSPEC(void ) slv_resolve(slv_syste
1191          expression may be simplified.          expression may be simplified.
1192    
1193      This function is considerably more efficient when it is usable.      This function is considerably more efficient when it is usable.
1194    
1195        @return 0 on success
1196  */  */
1197    
1198  ASC_DLLSPEC(void) slv_iterate(slv_system_t sys);  ASC_DLLSPEC(int) slv_iterate(slv_system_t sys);
1199  /**<  /**<
1200      Performs one iteration toward the ultimate solution (or      Performs one iteration toward the ultimate solution (or
1201      failure thereof) of the system.  The user can obtain information      failure thereof) of the system.  The user can obtain information
# Line 1200  ASC_DLLSPEC(void) slv_iterate(slv_system Line 1204  ASC_DLLSPEC(void) slv_iterate(slv_system
1204      they may not be up to date).  The user may not modify the system in      they may not be up to date).  The user may not modify the system in
1205      any way between iterations (i.e. you may look, but don't touch: see      any way between iterations (i.e. you may look, but don't touch: see
1206      slv_presolve()).  See also slv_solve().      slv_presolve()).  See also slv_solve().
1207    
1208        @return 0 on success
1209  */  */
1210    
1211  ASC_DLLSPEC(void ) slv_solve(slv_system_t sys);  ASC_DLLSPEC(int) slv_solve(slv_system_t sys);
1212  /**<  /**<
1213      Attempts to solve the entire system in one shot (i.e.      Attempts to solve the entire system in one shot (i.e.
1214      performs as many iterations as needed or allowed).  For some solvers,      performs as many iterations as needed or allowed).  For some solvers,
1215      slv_iterate() and slv_solve() may mean the same thing.      slv_iterate() and slv_solve() may mean the same thing.
1216    
1217        @return 0 on success
1218  */  */
1219    
1220  extern void slv_destroy_client(slv_system_t sys);  extern void slv_destroy_client(slv_system_t sys);

Legend:
Removed from v.1033  
changed lines
  Added in v.1034

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