generic/interface/SlvProc.h

/*
 *  SlvProc.h
 *  by Ken Tyner and Ben Allan
 *  Created: 6/97
 *  Version: $Revision: 1.4 $
 *  Version control file: $RCSfile: SlvProc.h,v $
 *  Date last modified: $Date: 2003/08/23 18:43:08 $
 *  Last modified by: $Author: ballan $
 *
 *  This file is part of the ASCEND Tcl/Tk interface
 *
 *  Copyright 1997, Carnegie Mellon University
 *
 *  The ASCEND Tcl/Tk interface is free software; you can redistribute
 *  it and/or modify it under the terms of the GNU General Public License as
 *  published by the Free Software Foundation; either version 2 of the
 *  License, or (at your option) any later version.
 *
 *  The ASCEND Tcl/Tk interface is distributed in hope that it will be
 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with the program; if not, write to the Free Software Foundation,
 *  Inc., 675 Mass Ave, Cambridge, MA 02139 USA.  Check the file named
 *  COPYING.  COPYING is found in ../compiler.
 *
 *  This probe implementation constitutes a total rework of the probe
 *  first created by Abbott, 1994.
 */

#ifndef SlvProc_module_loaded
#define SlvProc_module_loaded

/*
 *  To include this header, you must include the following:
 *      #include "tcl.h"
 *      #include "interface/HelpProc.h"
 *      #include "interface/SlvProc.h" (which is sort of obvious)
 */

#define SLVMONITORPREFIX "slvmon"

extern int Asc_VarAnalyzeCmd(ClientData cdata, Tcl_Interp *interp,
                             int argc, CONST84 char *argv[]);
extern int Asc_RelAnalyzeCmd(ClientData cdata, Tcl_Interp *interp,
                             int argc, CONST84 char *argv[]);
/*
 *  int Asc_VarAnalyzeCmd;
 *  Registered as \"__var_analyze low high
 *                  scaling?lower?upper?other
 *  rel?abs tolerance <othervalue>.
 *  int Asc_RelAnalyzeCmd;
 *  Registered as \"__rel_analyze low high
 *                  residual?other
 *  rel?abs tolerance <othervalue>.
 *  Comments :
 *
 *  This function will analyze the elements in the current slv_systemto see
 *  whether they satisfy the proximity queries. The variable type supported is
 *  the "solver_var". It can be used to analyse variables or relations for
 *  proximity to a "othervalue". rel?abs will determine whether
 *  the queries are done relatively or using absolute values. tolerance must
 *  be set appropriately based on rel?abs. The queries ?scaling?lower?upper
 *  pertain to the nominal,lower_bound, and upper_bound of a solver_var with
 *  respect to the value of the solver_var. "residual" pertains to the residual
 *  of a relation as compared to 0.0. If for any of the queries,
 *  the values are too close to zero, then "absolute" queries are made.
 *  Internal units are used for all queries.
 *
 *  Examples:
 *  1) __var_analyze 20 46 lower rel 0.2;
 *     will analyse (indexes 20 through 46 inclusive) all solver_vars
 *     that have values which are within 20% of their lower_bounds.
 *  2) __var_analyze 20 46 lower abs 0.2;
 *     will analyse (indexes 20 through 46 inclusive) all solver_vars
 *     that have values which are within 0.2 of their lower_bounds.
 *  3) __var_analyze 20 46 other rel 0.2 15.0;
 *     will analyse (indexes 20 through 46 inclusive) all solver_vars
 *     that have values which are within 20% of 15.0.
 *
 *  Will be return a formatted string with of the form:
 *  {index b_close} {index b_far} where index is the original probe list index.
 *  See the source for more details.
 */

STDHLF_H(Asc_SolveMonitorCmd);

extern int Asc_SolveMonitorCmd(ClientData, Tcl_Interp *, int, CONST84 char **);
/* 
 * status = Asc_SolveMonitorCmd((cdata,interp,argc,argv);
 * Registered as: */
#define Asc_SolveMonitorCmdHN "slv_monitor" 
/* which should eventually be __something, when we clean up the slv_ mess */
/* Usage: */
#define Asc_SolveMonitorCmdHU \
  "slv_monitor takes no arguments yet"
#define Asc_SolveMonitorCmdHS \
 "Returns the name of a monitor command to watch var/rel changes"
#define Asc_SolveMonitorCmdHL1 "Eventually this should take an argument "
#define Asc_SolveMonitorCmdHL2 "that is the id of a tcl solver token.\n"
#define Asc_SolveMonitorCmdHL3 "\
 * This creates a monitor and returns its symbolic handle.\n\
 * Multiple monitors can exist and are manipulated by their\n\
 * symbolic handles.\n\
 * A monitor may be used on a series of unrelated slv_system_t.\n\
 * Currently, this function gets its slv_system_t from g_solvsys_cur,\n\
 * but it should be changed to take a slvsys interface id when\n\
 * the solver interface is changed to work by name.\n\
"
/* 
 * because they need to be defined in a visible place, the info strings
 * for the monitors created follow:
 */
#define SolveMonitorHS \
 "Returns the list of changes in residuals, variables, or steps in variables"
#define SolveMonitorHU \
 "slvmonN destroy OR slvmonN slvsysname change <var,rel> OR\n\
slvmonN slvsysname geometry w h x y rmin rmax vmax OR \n\
slvmonN slvsysname plotdata <value,speed,residual>\n\
"
#define SolveMonitorHL1 \
"\
 * s change var         return scaled values that changed\n\
 * s change rel         return scaled residuals that changed\n\
 * Returns a tcl list whose elements are the changed values\n\
 * with master list indices {index value}\n\
 * values are scaled by nominals, or 1 if nominal is 0.\n\
 * Scaled values > vmax (or rmax) will be returned as having the\n\
 * value of the max, rather than their TRUE value.\n\
"
#define SolveMonitorHL2 \
"\n\
 * s geometry w h x y rmin rmax vmax\n\
 * sets conversion parameters for plotdata (w h x y)\n\
 * and limits for data values. This is called with a window\n\
 * size or range change that will require new drawing.\n\
 * x,y is the upper left corner of a coordinate space like a tk canvas.\n\
 * w,h is the width and height of the space in distinctly plottable points\n\
 * The 0 line of the area is y + h/2 for values. The values will be\n\
 * spread evenly over the width in order of increasing solver master index.\n\
"
#define SolveMonitorHL3 \
"\n\
 * s plotdata value     return plot info for scaled values that changed\n\
 * s plotdata speed     return plot info for scaled rates of value change\n\
 * s plotdata residual  return plot info for scaled residuals that changed\n\
 *\n\
"
#define SolveMonitorHL4 \
"\
 * Each option returns a list of {x y index} for changed values of the\n\
 * variables or relations. The x,y are coordinates at which a point\n\
 * should be plotted based on a transformation derived from whxy info\n\
 * last obtained by the geometry command of the monitor.\n\
"
#define SolveMonitorHL5 \
"\
 * The transformation may specify the same coordinate for more than\n\
 * one relation or variable.\n\
 * If this function raises a floating point exception, it will\n\
 * not return data, but an error.\n\
"
#define SolveMonitorHL6 \
"\
*   value:  The variable values v are scaled by nominal.\n\
*       They are then reduced to vmax if abs(v) > vmax.\n\
*       They are then scaled to the plotting region. The\n\
*       returned value is {plotx ploty mastervarindex} for\n\
*       all variables that changed since the last call or geometry.\n\
"
#define SolveMonitorHL7 \
"\
*   speed:  The variable values v are scaled by nominal.\n\
*       They are then reduced to vmax if abs(v) > vmax.\n\
*       The delta in the scaled value since the last call\n\
*       is calculated. If the delta has changed, it is scaled\n\
*       to the plotting region and returned as\n\
*       {plotx ploty mastervarindex} for\n\
*       all variables that had a step size change.\n\
"
#define SolveMonitorHL8 \
"\
*  residual:    The relation residuals, as scaled by nominals and reduced\n\
*       to rmax if necessary, which have changed since the last call\n\
*       are transformed to a dual log scale in the plot region.\n\
*       Residuals < rmin considered as rmin. Residuals < 0 plotted\n\
*       in the lower half of the plot region. Distance from the\n\
*       vertical center of the canvas indicates the residual magnitude"
/* end o spew */

#endif /* SlvProc_module_loaded*/
1	aw0a	1	/*
2			* SlvProc.h
3			* by Ken Tyner and Ben Allan
4			* Created: 6/97
5			* Version: $Revision: 1.4 $
6			* Version control file: $RCSfile: SlvProc.h,v $
7			* Date last modified: $Date: 2003/08/23 18:43:08 $
8			* Last modified by: $Author: ballan $
9			*
10			* This file is part of the ASCEND Tcl/Tk interface
11			*
12			* Copyright 1997, Carnegie Mellon University
13			*
14			* The ASCEND Tcl/Tk interface is free software; you can redistribute
15			* it and/or modify it under the terms of the GNU General Public License as
16			* published by the Free Software Foundation; either version 2 of the
17			* License, or (at your option) any later version.
18			*
19			* The ASCEND Tcl/Tk interface is distributed in hope that it will be
20			* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22			* General Public License for more details.
23			*
24			* You should have received a copy of the GNU General Public License
25			* along with the program; if not, write to the Free Software Foundation,
26			* Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check the file named
27			* COPYING. COPYING is found in ../compiler.
28			*
29			* This probe implementation constitutes a total rework of the probe
30			* first created by Abbott, 1994.
31			*/
32
33			#ifndef SlvProc_module_loaded
34			#define SlvProc_module_loaded
35
36			/*
37			* To include this header, you must include the following:
38			* #include "tcl.h"
39			* #include "interface/HelpProc.h"
40			* #include "interface/SlvProc.h" (which is sort of obvious)
41			*/
42
43			#define SLVMONITORPREFIX "slvmon"
44
45			extern int Asc_VarAnalyzeCmd(ClientData cdata, Tcl_Interp *interp,
46			int argc, CONST84 char *argv[]);
47			extern int Asc_RelAnalyzeCmd(ClientData cdata, Tcl_Interp *interp,
48			int argc, CONST84 char *argv[]);
49			/*
50			* int Asc_VarAnalyzeCmd;
51			* Registered as \"__var_analyze low high
52			* scaling?lower?upper?other
53			* rel?abs tolerance <othervalue>.
54			* int Asc_RelAnalyzeCmd;
55			* Registered as \"__rel_analyze low high
56			* residual?other
57			* rel?abs tolerance <othervalue>.
58			* Comments :
59			*
60			* This function will analyze the elements in the current slv_systemto see
61			* whether they satisfy the proximity queries. The variable type supported is
62			* the "solver_var". It can be used to analyse variables or relations for
63			* proximity to a "othervalue". rel?abs will determine whether
64			* the queries are done relatively or using absolute values. tolerance must
65			* be set appropriately based on rel?abs. The queries ?scaling?lower?upper
66			* pertain to the nominal,lower_bound, and upper_bound of a solver_var with
67			* respect to the value of the solver_var. "residual" pertains to the residual
68			* of a relation as compared to 0.0. If for any of the queries,
69			* the values are too close to zero, then "absolute" queries are made.
70			* Internal units are used for all queries.
71			*
72			* Examples:
73			* 1) __var_analyze 20 46 lower rel 0.2;
74			* will analyse (indexes 20 through 46 inclusive) all solver_vars
75			* that have values which are within 20% of their lower_bounds.
76			* 2) __var_analyze 20 46 lower abs 0.2;
77			* will analyse (indexes 20 through 46 inclusive) all solver_vars
78			* that have values which are within 0.2 of their lower_bounds.
79			* 3) __var_analyze 20 46 other rel 0.2 15.0;
80			* will analyse (indexes 20 through 46 inclusive) all solver_vars
81			* that have values which are within 20% of 15.0.
82			*
83			* Will be return a formatted string with of the form:
84			* {index b_close} {index b_far} where index is the original probe list index.
85			* See the source for more details.
86			*/
87
88			STDHLF_H(Asc_SolveMonitorCmd);
89
90			extern int Asc_SolveMonitorCmd(ClientData, Tcl_Interp , int, CONST84 char *);
91			/*
92			* status = Asc_SolveMonitorCmd((cdata,interp,argc,argv);
93			* Registered as: */
94			#define Asc_SolveMonitorCmdHN "slv_monitor"
95			/* which should eventually be __something, when we clean up the slv_ mess */
96			/* Usage: */
97			#define Asc_SolveMonitorCmdHU \
98			"slv_monitor takes no arguments yet"
99			#define Asc_SolveMonitorCmdHS \
100			"Returns the name of a monitor command to watch var/rel changes"
101			#define Asc_SolveMonitorCmdHL1 "Eventually this should take an argument "
102			#define Asc_SolveMonitorCmdHL2 "that is the id of a tcl solver token.\n"
103			#define Asc_SolveMonitorCmdHL3 "\
104			* This creates a monitor and returns its symbolic handle.\n\
105			* Multiple monitors can exist and are manipulated by their\n\
106			* symbolic handles.\n\
107			* A monitor may be used on a series of unrelated slv_system_t.\n\
108			* Currently, this function gets its slv_system_t from g_solvsys_cur,\n\
109			* but it should be changed to take a slvsys interface id when\n\
110			* the solver interface is changed to work by name.\n\
111			"
112			/*
113			* because they need to be defined in a visible place, the info strings
114			* for the monitors created follow:
115			*/
116			#define SolveMonitorHS \
117			"Returns the list of changes in residuals, variables, or steps in variables"
118			#define SolveMonitorHU \
119			"slvmonN destroy OR slvmonN slvsysname change <var,rel> OR\n\
120			slvmonN slvsysname geometry w h x y rmin rmax vmax OR \n\
121			slvmonN slvsysname plotdata <value,speed,residual>\n\
122			"
123			#define SolveMonitorHL1 \
124			"\
125			* s change var return scaled values that changed\n\
126			* s change rel return scaled residuals that changed\n\
127			* Returns a tcl list whose elements are the changed values\n\
128			* with master list indices {index value}\n\
129			* values are scaled by nominals, or 1 if nominal is 0.\n\
130			* Scaled values > vmax (or rmax) will be returned as having the\n\
131			* value of the max, rather than their TRUE value.\n\
132			"
133			#define SolveMonitorHL2 \
134			"\n\
135			* s geometry w h x y rmin rmax vmax\n\
136			* sets conversion parameters for plotdata (w h x y)\n\
137			* and limits for data values. This is called with a window\n\
138			* size or range change that will require new drawing.\n\
139			* x,y is the upper left corner of a coordinate space like a tk canvas.\n\
140			* w,h is the width and height of the space in distinctly plottable points\n\
141			* The 0 line of the area is y + h/2 for values. The values will be\n\
142			* spread evenly over the width in order of increasing solver master index.\n\
143			"
144			#define SolveMonitorHL3 \
145			"\n\
146			* s plotdata value return plot info for scaled values that changed\n\
147			* s plotdata speed return plot info for scaled rates of value change\n\
148			* s plotdata residual return plot info for scaled residuals that changed\n\
149			*\n\
150			"
151			#define SolveMonitorHL4 \
152			"\
153			* Each option returns a list of {x y index} for changed values of the\n\
154			* variables or relations. The x,y are coordinates at which a point\n\
155			* should be plotted based on a transformation derived from whxy info\n\
156			* last obtained by the geometry command of the monitor.\n\
157			"
158			#define SolveMonitorHL5 \
159			"\
160			* The transformation may specify the same coordinate for more than\n\
161			* one relation or variable.\n\
162			* If this function raises a floating point exception, it will\n\
163			* not return data, but an error.\n\
164			"
165			#define SolveMonitorHL6 \
166			"\
167			* value: The variable values v are scaled by nominal.\n\
168			* They are then reduced to vmax if abs(v) > vmax.\n\
169			* They are then scaled to the plotting region. The\n\
170			* returned value is {plotx ploty mastervarindex} for\n\
171			* all variables that changed since the last call or geometry.\n\
172			"
173			#define SolveMonitorHL7 \
174			"\
175			* speed: The variable values v are scaled by nominal.\n\
176			* They are then reduced to vmax if abs(v) > vmax.\n\
177			* The delta in the scaled value since the last call\n\
178			* is calculated. If the delta has changed, it is scaled\n\
179			* to the plotting region and returned as\n\
180			* {plotx ploty mastervarindex} for\n\
181			* all variables that had a step size change.\n\
182			"
183			#define SolveMonitorHL8 \
184			"\
185			* residual: The relation residuals, as scaled by nominals and reduced\n\
186			* to rmax if necessary, which have changed since the last call\n\
187			* are transformed to a dual log scale in the plot region.\n\
188			* Residuals < rmin considered as rmin. Residuals < 0 plotted\n\
189			* in the lower half of the plot region. Distance from the\n\
190			* vertical center of the canvas indicates the residual magnitude"
191			/* end o spew */
192
193			#endif /* SlvProc_module_loaded*/