generic/solver/slv0.h

/*
 *  SLV: Ascend Nonlinear Solver
 *  by Karl Michael Westerberg
 *  Created: 2/6/90
 *  Version: $Revision: 1.7 $
 *  Version control file: $RCSfile: slv0.h,v $
 *  Date last modified: $Date: 1997/07/18 12:15:51 $
 *  Last modified by: $Author: mthomas $
 *
 *  This file is part of the SLV solver.
 *
 *  Copyright (C) 1990 Karl Michael Westerberg
 *  Copyright (C) 1993 Joseph Zaher
 *  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
 *  Slv solver registration module.
 *  <pre>
 *  Contents:     Slv module
 *
 *  Authors:      Karl Westerberg
 *                Joseph Zaher
 *
 *  Dates:        06/90 - original version
 *                04/91 - fine tuned modified marquadt computation,
 *                        provided minor iterations for step generation
 *                        within each major iteration of jacobian
 *                        updates
 *                06/93 - eliminated pointer sublists being generated
 *                        at the beginning of each block
 *                04/94 - extended scope to equality constrained
 *                        optimization.
 *
 *  Description:  This file is created by make_slv_header, so don't
 *                modify it yourself.  All functions defined in this
 *                header have identical protocols to the corresponding
 *                functions in slv.h except that slv_system_t ==>
 *                slv0_system_t and slv0_eligible_solver() only takes one
 *                parameter: the system.  Note also that the select
 *                solver functions don't exist.
 *
 *  Requires:     #include "utilities/ascConfig.h"
 *                #include "slv_client.h"
 *  </pre>
 *  @todo Slv (solver/slv0.c) is out-of-date and will not compile.
 *        Should be either fixed or archived.
 */

#ifndef ASC_SLV0_H
#define ASC_SLV0_H

typedef struct slv0_system_structure *slv0_system_t;

int slv0_register(SlvFunctionsT *sft);
/**<
 *  Registration function for the Slv nonlinear solver.
 *  This is the function that tells the system about the QRSlv solver.
 *  Our index is not necessarily going to be 0. That everything here is
 *  named slv0* 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 /* ASC_SLV0_H */

1	jds	54	/*
2	aw0a	1	* SLV: Ascend Nonlinear Solver
3			* by Karl Michael Westerberg
4			* Created: 2/6/90
5			* Version: $Revision: 1.7 $
6			* Version control file: $RCSfile: slv0.h,v $
7			* Date last modified: $Date: 1997/07/18 12:15:51 $
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) 1993 Joseph Zaher
14			* Copyright (C) 1994 Joseph Zaher, Benjamin Andrew Allan
15			*
16			* The SLV solver is free software; you can redistribute
17			* it and/or modify it under the terms of the GNU General Public License as
18			* published by the Free Software Foundation; either version 2 of the
19			* License, or (at your option) any later version.
20			*
21			* The SLV solver is distributed in hope that it will be
22			* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
23			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24			* General Public License for more details.
25			*
26			* You should have received a copy of the GNU General Public License along with
27			* the program; if not, write to the Free Software Foundation, Inc., 675
28			* Mass Ave, Cambridge, MA 02139 USA. Check the file named COPYING.
29			* COPYING is found in ../compiler.
30			*/
31
32	jds	54	/** @file
33			* Slv solver registration module.
34			* <pre>
35			* Contents: Slv module
36			*
37			* Authors: Karl Westerberg
38			* Joseph Zaher
39			*
40			* Dates: 06/90 - original version
41			* 04/91 - fine tuned modified marquadt computation,
42			* provided minor iterations for step generation
43			* within each major iteration of jacobian
44			* updates
45			* 06/93 - eliminated pointer sublists being generated
46			* at the beginning of each block
47			* 04/94 - extended scope to equality constrained
48			* optimization.
49			*
50			* Description: This file is created by make_slv_header, so don't
51			* modify it yourself. All functions defined in this
52			* header have identical protocols to the corresponding
53			* functions in slv.h except that slv_system_t ==>
54			* slv0_system_t and slv0_eligible_solver() only takes one
55			* parameter: the system. Note also that the select
56			* solver functions don't exist.
57			*
58			* Requires: #include "utilities/ascConfig.h"
59			* #include "slv_client.h"
60			* </pre>
61	jds	59	* @todo Slv (solver/slv0.c) is out-of-date and will not compile.
62			* Should be either fixed or archived.
63	jds	54	*/
64
65	johnpye	466	#ifndef ASC_SLV0_H
66			#define ASC_SLV0_H
67	aw0a	1
68			typedef struct slv0_system_structure *slv0_system_t;
69
70	jds	54	int slv0_register(SlvFunctionsT *sft);
71			/**<
72	jds	59	* Registration function for the Slv nonlinear solver.
73	jds	54	* This is the function that tells the system about the QRSlv solver.
74			* Our index is not necessarily going to be 0. That everything here is
75			* named slv0* is just a historical event.
76	jds	59	*
77			* @param sft SlvFunctionsT to receive the solver registration info.
78			* @return Returns non-zero on error (e.g. f == NULL), zero if all is ok.
79	jds	54	*/
80	jds	59
81	johnpye	466	#endif /* ASC_SLV0_H */
82	jds	54