/[ascend]/trunk/base/generic/packages/sensitivity.h
ViewVC logotype

Contents of /trunk/base/generic/packages/sensitivity.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 54 - (show annotations) (download) (as text)
Tue Aug 2 11:20:09 2005 UTC (18 years, 10 months ago) by jds
File MIME type: text/x-chdr
File size: 2571 byte(s)
Manual rework of doxygen comments in all headers.
- Added @file comment to all headers.
- Added parameter names to all function declarations in headers.
- Corrected comment referencing where necessary.
- Split some comments which documented blocks of declarations.
- Converted notes about required work into @todo comments so doxygen can generate a todo list.
Minor bug fixes.
1 /*===================================================================*\
2 THIS HEADER IS CRAP AND SHOULD BE FIXED UP PROPERLY
3 Created: May 16, 1996
4 Version: $Revision: 1.1 $
5 Date last modified: $Date: 1996/05/17 16:56:32 $
6
7 This file is part of the Ascend Language Interpreter.
8
9 Copyright (C) 1990, 1993, 1994 Thomas Guthrie Epperly, Kirk Abbott.
10
11 The Ascend Language Interpreter is free software; you can redistribute
12 it and/or modify it under the terms of the GNU General Public License as
13 published by the Free Software Foundation; either version 2 of the
14 License, or (at your option) any later version.
15
16 The Ascend Language Interpreter is distributed in hope that it will be
17 useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
20
21 You should have received a copy of the GNU General Public License along with
22 the program; if not, write to the Free Software Foundation, Inc., 675
23 Mass Ave, Cambridge, MA 02139 USA. Check the file named COPYING.
24 \*===================================================================*/
25
26 /** @file
27 * Sensitivity analysis routines.
28 * <pre>
29 * When #including sensitivity.h, make sure these files are #included first:
30 * #include "utilities/ascConfig.h"
31 * #include "compiler/instance_enum.h"
32 * #include "compiler/compiler.h"
33 * #include "general/list.h"
34 * #include "compiler/extfunc.h"
35 * </pre>
36 * @todo Document sensitivity.h functions.
37 * @todo Do we really need 2 files called [Ss]ensitivity.[ch]? Other one is in tcltk98.
38 */
39
40 #ifndef __SENSITIVITY_H_SEEN__
41 #define __SENSITIVITY_H_SEEN__
42
43 extern int do_solve_eval(struct Slv_Interp *slv_interp,
44 struct Instance *i,
45 struct gl_list_t *arglist,
46 unsigned long whichvar);
47
48 extern int do_finite_diff_eval(struct Slv_Interp *slv_interp,
49 struct Instance *i,
50 struct gl_list_t *arglist,
51 unsigned long whichvar);
52
53 extern char sensitivity_help[];
54
55 extern int do_sensitivity_eval_all(struct Slv_Interp *slv_interp,
56 struct Instance *i,
57 struct gl_list_t *arglist);
58
59 extern int do_sensitivity_eval(struct Slv_Interp *slv_interp,
60 struct Instance *i,
61 struct gl_list_t *arglist);
62
63 #endif /* __SENSITIVITY_H_SEEN__ */
64

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