File: Initializing-the-Multidimensional-Solver.html

package info (click to toggle)
gsl-ref-html 2.3-1
  • links: PTS
  • area: non-free
  • in suites: bullseye, buster, sid
  • size: 6,876 kB
  • ctags: 4,574
  • sloc: makefile: 35
file content (157 lines) | stat: -rw-r--r-- 9,165 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 The GSL Team.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being "GNU General Public License" and "Free Software
Needs Free Documentation", the Front-Cover text being "A GNU Manual",
and with the Back-Cover Text being (a) (see below). A copy of the
license is included in the section entitled "GNU Free Documentation
License".

(a) The Back-Cover Text is: "You have the freedom to copy and modify this
GNU Manual." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library &ndash; Reference Manual: Initializing the Multidimensional Solver</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Initializing the Multidimensional Solver">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Initializing the Multidimensional Solver">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="Multidimensional-Root_002dFinding.html#Multidimensional-Root_002dFinding" rel="up" title="Multidimensional Root-Finding">
<link href="Providing-the-multidimensional-system-of-equations-to-solve.html#Providing-the-multidimensional-system-of-equations-to-solve" rel="next" title="Providing the multidimensional system of equations to solve">
<link href="Overview-of-Multidimensional-Root-Finding.html#Overview-of-Multidimensional-Root-Finding" rel="previous" title="Overview of Multidimensional Root Finding">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Initializing-the-Multidimensional-Solver"></a>
<div class="header">
<p>
Next: <a href="Providing-the-multidimensional-system-of-equations-to-solve.html#Providing-the-multidimensional-system-of-equations-to-solve" accesskey="n" rel="next">Providing the multidimensional system of equations to solve</a>, Previous: <a href="Overview-of-Multidimensional-Root-Finding.html#Overview-of-Multidimensional-Root-Finding" accesskey="p" rel="previous">Overview of Multidimensional Root Finding</a>, Up: <a href="Multidimensional-Root_002dFinding.html#Multidimensional-Root_002dFinding" accesskey="u" rel="up">Multidimensional Root-Finding</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Initializing-the-Solver-2"></a>
<h3 class="section">36.2 Initializing the Solver</h3>

<p>The following functions initialize a multidimensional solver, either
with or without derivatives.  The solver itself depends only on the
dimension of the problem and the algorithm and can be reused for
different problems.
</p>
<dl>
<dt><a name="index-gsl_005fmultiroot_005ffsolver_005falloc"></a>Function: <em>gsl_multiroot_fsolver *</em> <strong>gsl_multiroot_fsolver_alloc</strong> <em>(const gsl_multiroot_fsolver_type * <var>T</var>, size_t <var>n</var>)</em></dt>
<dd><a name="index-gsl_005fmultiroot_005ffsolver"></a>
<a name="index-gsl_005fmultiroot_005ffsolver_005ftype"></a>
<p>This function returns a pointer to a newly allocated instance of a
solver of type <var>T</var> for a system of <var>n</var> dimensions.
For example, the following code creates an instance of a hybrid solver, 
to solve a 3-dimensional system of equations.
</p>
<div class="example">
<pre class="example">const gsl_multiroot_fsolver_type * T 
    = gsl_multiroot_fsolver_hybrid;
gsl_multiroot_fsolver * s 
    = gsl_multiroot_fsolver_alloc (T, 3);
</pre></div>

<p>If there is insufficient memory to create the solver then the function
returns a null pointer and the error handler is invoked with an error
code of <code>GSL_ENOMEM</code>.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fmultiroot_005ffdfsolver_005falloc"></a>Function: <em>gsl_multiroot_fdfsolver *</em> <strong>gsl_multiroot_fdfsolver_alloc</strong> <em>(const gsl_multiroot_fdfsolver_type * <var>T</var>, size_t <var>n</var>)</em></dt>
<dd><a name="index-gsl_005fmultiroot_005ffdfsolver"></a>
<a name="index-gsl_005fmultiroot_005ffdfsolver_005ftype"></a>
<p>This function returns a pointer to a newly allocated instance of a
derivative solver of type <var>T</var> for a system of <var>n</var> dimensions.
For example, the following code creates an instance of a Newton-Raphson solver,
for a 2-dimensional system of equations.
</p>
<div class="example">
<pre class="example">const gsl_multiroot_fdfsolver_type * T 
    = gsl_multiroot_fdfsolver_newton;
gsl_multiroot_fdfsolver * s = 
    gsl_multiroot_fdfsolver_alloc (T, 2);
</pre></div>

<p>If there is insufficient memory to create the solver then the function
returns a null pointer and the error handler is invoked with an error
code of <code>GSL_ENOMEM</code>.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fmultiroot_005ffsolver_005fset"></a>Function: <em>int</em> <strong>gsl_multiroot_fsolver_set</strong> <em>(gsl_multiroot_fsolver * <var>s</var>, gsl_multiroot_function * <var>f</var>, const gsl_vector * <var>x</var>)</em></dt>
<dt><a name="index-gsl_005fmultiroot_005ffdfsolver_005fset"></a>Function: <em>int</em> <strong>gsl_multiroot_fdfsolver_set</strong> <em>(gsl_multiroot_fdfsolver * <var>s</var>, gsl_multiroot_function_fdf * <var>fdf</var>, const gsl_vector * <var>x</var>)</em></dt>
<dd><p>These functions set, or reset, an existing solver <var>s</var> to use the
function <var>f</var> or function and derivative <var>fdf</var>, and the initial
guess <var>x</var>.  Note that the initial position is copied from <var>x</var>, this
argument is not modified by subsequent iterations.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fmultiroot_005ffsolver_005ffree"></a>Function: <em>void</em> <strong>gsl_multiroot_fsolver_free</strong> <em>(gsl_multiroot_fsolver * <var>s</var>)</em></dt>
<dt><a name="index-gsl_005fmultiroot_005ffdfsolver_005ffree"></a>Function: <em>void</em> <strong>gsl_multiroot_fdfsolver_free</strong> <em>(gsl_multiroot_fdfsolver * <var>s</var>)</em></dt>
<dd><p>These functions free all the memory associated with the solver <var>s</var>.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fmultiroot_005ffsolver_005fname"></a>Function: <em>const char *</em> <strong>gsl_multiroot_fsolver_name</strong> <em>(const gsl_multiroot_fsolver * <var>s</var>)</em></dt>
<dt><a name="index-gsl_005fmultiroot_005ffdfsolver_005fname"></a>Function: <em>const char *</em> <strong>gsl_multiroot_fdfsolver_name</strong> <em>(const gsl_multiroot_fdfsolver * <var>s</var>)</em></dt>
<dd><p>These functions return a pointer to the name of the solver.  For example,
</p>
<div class="example">
<pre class="example">printf (&quot;s is a '%s' solver\n&quot;, 
        gsl_multiroot_fdfsolver_name (s));
</pre></div>

<p>would print something like <code>s is a 'newton' solver</code>.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="Providing-the-multidimensional-system-of-equations-to-solve.html#Providing-the-multidimensional-system-of-equations-to-solve" accesskey="n" rel="next">Providing the multidimensional system of equations to solve</a>, Previous: <a href="Overview-of-Multidimensional-Root-Finding.html#Overview-of-Multidimensional-Root-Finding" accesskey="p" rel="previous">Overview of Multidimensional Root Finding</a>, Up: <a href="Multidimensional-Root_002dFinding.html#Multidimensional-Root_002dFinding" accesskey="u" rel="up">Multidimensional Root-Finding</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>