generic/solver/slv8.h

/*
 *  Incorporation of the nonlinear solver CONOPT to ASCEND
 *  by Ken Tyner
 *  Created: 6/97
 *  Version: $Revision: 1.3 $
 *  Version control file: $RCSfile: slv8.h,v $
 *  Date last modified: $Date: 1997/08/12 16:43:46 $
 *  Last modified by: $Author: rv2a $
 *
 *  This file is part of the SLV solver.
 *
 *  Copyright (C) 1997 Carnegie Mellon University
 *
 *  The SLV solver 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 SLV solver 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.
 */

/** @file
 *  CONOPT solver registration module.
 *  <pre>
 *  Contents:     CONOPT module
 *
 *  Authors:      Ken Tyner and Vicente Rico-Ramirez
 *
 *  Dates:        06/97 - original version
 *                07/97 - Creating a structure of function pointers so that
 *                        multiple calls to CONOPT can be made
 *                08/97 - Improving CONOPT message report to ASCEND
 *
 *  Requires:     #include "utilities/ascConfig.h"
 *                #include "slv_client.h"
 *  </pre>
 */

#ifndef ASC_SLV8_H
#define ASC_SLV8_H

typedef struct slv8_system_structure *slv8_system_t;

int slv8_register(SlvFunctionsT *f);
/**<
 *  Registration function for the CONOPT solver.
 *  This is the function that tells the system about the CONOPT solver.
 *  Our index is not necessarily going to be 8. That everything here is
 *  named slv8* is just a historical result and a convenient way of
 *  shutting up the linker.
 *
 *  @param f SlvFunctionsT to receive the solver registration info.
 *  @return Returns non-zero on error (e.g. f == NULL), zero if all is ok.
 */

#endif  /* ASC_SLV8_H */

1	jds	54	/*
2	aw0a	1	* Incorporation of the nonlinear solver CONOPT to ASCEND
3	johnpye	466	* by Ken Tyner
4	aw0a	1	* Created: 6/97
5			* Version: $Revision: 1.3 $
6			* Version control file: $RCSfile: slv8.h,v $
7			* Date last modified: $Date: 1997/08/12 16:43:46 $
8			* Last modified by: $Author: rv2a $
9			*
10			* This file is part of the SLV solver.
11			*
12			* Copyright (C) 1997 Carnegie Mellon University
13			*
14			* The SLV solver 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 SLV solver 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
30	jds	54	/** @file
31			* CONOPT solver registration module.
32			* <pre>
33			* Contents: CONOPT module
34	aw0a	1	*
35	jds	54	* Authors: Ken Tyner and Vicente Rico-Ramirez
36	aw0a	1	*
37	jds	54	* Dates: 06/97 - original version
38			* 07/97 - Creating a structure of function pointers so that
39			* multiple calls to CONOPT can be made
40			* 08/97 - Improving CONOPT message report to ASCEND
41			*
42			* Requires: #include "utilities/ascConfig.h"
43			* #include "slv_client.h"
44			* </pre>
45	aw0a	1	*/
46	jds	54
47	johnpye	466	#ifndef ASC_SLV8_H
48			#define ASC_SLV8_H
49	aw0a	1
50			typedef struct slv8_system_structure *slv8_system_t;
51
52	jds	59	int slv8_register(SlvFunctionsT *f);
53	johnpye	466	/**<
54	jds	59	* Registration function for the CONOPT solver.
55	jds	54	* This is the function that tells the system about the CONOPT solver.
56			* Our index is not necessarily going to be 8. That everything here is
57			* named slv8* is just a historical result and a convenient way of
58			* shutting up the linker.
59	jds	59	*
60			* @param f SlvFunctionsT to receive the solver registration info.
61			* @return Returns non-zero on error (e.g. f == NULL), zero if all is ok.
62	aw0a	1	*/
63
64	johnpye	466	#endif /* ASC_SLV8_H */
65	jds	54