generic/packages/ascFreeAllVars.h

/*  ASCEND modelling environment
    Copyright (C) 1998 Carnegie Mellon University
    Copyright (C) 2006 Carnegie Mellon University

    This program 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, or (at your option)
    any later version.

    This program is distributed in the 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 this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*//**
    @file
    Variable clearing routines.

    Requires:
    #include "utilities/ascConfig.h"
    #include "compiler/instance_enum.h"
    #include "compiler/compiler.h"
    #include "general/list.h"
    #include "compiler/extfunc.h"
*//*
    by Ben Allan
    February 24, 1998
    Part of ASCEND
    Version: $Revision: 1.4 $
    Version control file: $RCSfile: ascFreeAllVars.h,v $
    Date last modified: $Date: 1998/06/16 16:42:10 $
    Last modified by: $Author: mthomas $
*/

#ifndef ASC_ASCFREEALLVARS_H
#define ASC_ASCFREEALLVARS_H

#include <utilities/ascConfig.h>

ASC_DLLSPEC(int) Asc_ClearVarsInTree(struct Instance *i);
/**< Asc_ClearVarsInTree(i).
 * A service routine which assumes a solver_var modeling world
 * and clears (set var.fixed := FALSE) all var and refinements
 * of var in the DAG rooted at i.
 */

ASC_DLLSPEC(int) Asc_FreeAllVars( struct Instance *rootinstance,
                                    struct gl_list_t *arglist);
/**<
 *  err = Asc_FreeAllVars(NULL,rootinstance,arglist,0);
 *  All arguments except rootinstance are ignored.
 *  rootinstance is used as the argument to a call to Asc_ClearVarsInTree.
 *  This wrapper exists only for old EXTERNAL a la abbott compatibility
 *  and should be trashed ASAP.
 */

#endif /* ASC_ASCFREEALLVARS_H */

1	/* ASCEND modelling environment
2	Copyright (C) 1998 Carnegie Mellon University
3	Copyright (C) 2006 Carnegie Mellon University
4
5	This program is free software; you can redistribute it and/or modify
6	it under the terms of the GNU General Public License as published by
7	the Free Software Foundation; either version 2, or (at your option)
8	any later version.
9
10	This program is distributed in the hope that it will be useful,
11	but WITHOUT ANY WARRANTY; without even the implied warranty of
12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13	GNU General Public License for more details.
14
15	You should have received a copy of the GNU General Public License
16	along with this program; if not, write to the Free Software
17	Foundation, Inc., 59 Temple Place - Suite 330,
18	Boston, MA 02111-1307, USA.
19	//*
20	@file
21	Variable clearing routines.
22
23	Requires:
24	#include "utilities/ascConfig.h"
25	#include "compiler/instance_enum.h"
26	#include "compiler/compiler.h"
27	#include "general/list.h"
28	#include "compiler/extfunc.h"
29	//
30	by Ben Allan
31	February 24, 1998
32	Part of ASCEND
33	Version: $Revision: 1.4 $
34	Version control file: $RCSfile: ascFreeAllVars.h,v $
35	Date last modified: $Date: 1998/06/16 16:42:10 $
36	Last modified by: $Author: mthomas $
37	*/
38
39	#ifndef ASC_ASCFREEALLVARS_H
40	#define ASC_ASCFREEALLVARS_H
41
42	#include <utilities/ascConfig.h>
43
44	ASC_DLLSPEC(int) Asc_ClearVarsInTree(struct Instance *i);
45	/**< Asc_ClearVarsInTree(i).
46	* A service routine which assumes a solver_var modeling world
47	* and clears (set var.fixed := FALSE) all var and refinements
48	* of var in the DAG rooted at i.
49	*/
50
51	ASC_DLLSPEC(int) Asc_FreeAllVars( struct Instance *rootinstance,
52	struct gl_list_t *arglist);
53	/**<
54	* err = Asc_FreeAllVars(NULL,rootinstance,arglist,0);
55	* All arguments except rootinstance are ignored.
56	* rootinstance is used as the argument to a call to Asc_ClearVarsInTree.
57	* This wrapper exists only for old EXTERNAL a la abbott compatibility
58	* and should be trashed ASAP.
59	*/
60
61	#endif /* ASC_ASCFREEALLVARS_H */
62