generic/solver/slv1.h

/*
 *  SLV: Ascend Numeric Solver
 *  by Karl Michael Westerberg
 *  Created: 2/6/90
 *  Version: $Revision: 1.7 $
 *  Version control file: $RCSfile: slv1.h,v $
 *  Date last modified: $Date: 1997/07/18 12:15:57 $
 *  Last modified by: $Author: mthomas $
 *
 *  This file is part of the SLV solver.
 *
 *  Copyright (C) 1990 Karl Michael Westerberg
 *  Copyright (C) 1994 Joseph Zaher, Benjamin Andrew Allan
 *
 *  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
 *  MINOS solver registration module.
 *  <pre>
 *  Contents:     MINOS module
 *
 *  Requires:     #include "utilities/ascConfig.h"
 *                #include "slv_client.h"
 *  </pre>
 *  @todo MINOS (solver/slv1.c) is out-of-date and will not compile.
 *        Should be either fixed or archived.
 */

#ifndef ASC_SLV1_H
#define ASC_SLV1_H

typedef struct slv1_system_structure *slv1_system_t;

int slv1_register(SlvFunctionsT *sft);
/**<
 *  Registration function for the MINOS solver.
 *  This is the function that tells the system about the MINOS solver.
 *  Our index is not necessarily going to be 1. That everything here is
 *  named slv1* is just a historical event.
 *
 *  @param sft SlvFunctionsT to receive the solver registration info.
 *  @return Returns non-zero on error (e.g. f == NULL), zero if all is ok.
 */

#endif  /* slv1__already_included */

1	jds	54	/*
2	aw0a	1	* SLV: Ascend Numeric Solver
3			* by Karl Michael Westerberg
4			* Created: 2/6/90
5			* Version: $Revision: 1.7 $
6			* Version control file: $RCSfile: slv1.h,v $
7			* Date last modified: $Date: 1997/07/18 12:15:57 $
8			* Last modified by: $Author: mthomas $
9			*
10			* This file is part of the SLV solver.
11			*
12			* Copyright (C) 1990 Karl Michael Westerberg
13			* Copyright (C) 1994 Joseph Zaher, Benjamin Andrew Allan
14			*
15			* The SLV solver is free software; you can redistribute
16			* it and/or modify it under the terms of the GNU General Public License as
17			* published by the Free Software Foundation; either version 2 of the
18			* License, or (at your option) any later version.
19			*
20			* The SLV solver is distributed in hope that it will be
21			* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
22			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23			* General Public License for more details.
24			*
25			* You should have received a copy of the GNU General Public License along with
26			* the program; if not, write to the Free Software Foundation, Inc., 675
27			* Mass Ave, Cambridge, MA 02139 USA. Check the file named COPYING.
28			* COPYING is found in ../compiler.
29			*/
30
31	jds	54	/** @file
32			* MINOS solver registration module.
33			* <pre>
34			* Contents: MINOS module
35			*
36			* Requires: #include "utilities/ascConfig.h"
37			* #include "slv_client.h"
38			* </pre>
39	jds	59	* @todo MINOS (solver/slv1.c) is out-of-date and will not compile.
40			* Should be either fixed or archived.
41	jds	54	*/
42
43	johnpye	466	#ifndef ASC_SLV1_H
44			#define ASC_SLV1_H
45	aw0a	1
46			typedef struct slv1_system_structure *slv1_system_t;
47
48	jds	54	int slv1_register(SlvFunctionsT *sft);
49			/**<
50	jds	59	* Registration function for the MINOS solver.
51	jds	54	* This is the function that tells the system about the MINOS solver.
52			* Our index is not necessarily going to be 1. That everything here is
53			* named slv1* is just a historical event.
54	jds	59	*
55			* @param sft SlvFunctionsT to receive the solver registration info.
56			* @return Returns non-zero on error (e.g. f == NULL), zero if all is ok.
57	jds	54	*/
58	jds	59
59	jds	54	#endif /* slv1__already_included */
60	aw0a	1