]> Creatis software - CreaPhase.git/blob - octave_packages/symbolic-1.1.0/doc-cache
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / symbolic-1.1.0 / doc-cache
1 # Created by Octave 3.6.1, Tue Mar 20 21:13:35 2012 UTC <root@t61>
2 # name: cache
3 # type: cell
4 # rows: 3
5 # columns: 5
6 # name: <cell-element>
7 # type: sq_string
8 # elements: 1
9 # length: 7
10 findsym
11
12
13 # name: <cell-element>
14 # type: sq_string
15 # elements: 1
16 # length: 527
17  -- Function File: VARS = findsym (F, N)
18      Find symbols in expression F and return them comma-separated in
19      string VARS. The symbols are sorted in alphabetic order. If N is
20      specified, the N symbols closest to "x" are returned.
21
22      Example:
23           symbols
24           x     = sym ("x");
25           y     = sym ("y");
26           f     = x^2+3*x*y-y^2;
27           vars  = findsym (f);
28           vars2 = findsym (f,1);
29
30      This is intended for m****b compatibility, calls findsymbols().
31
32      See also: findsymbols
33
34
35
36
37
38 # name: <cell-element>
39 # type: sq_string
40 # elements: 1
41 # length: 76
42 Find symbols in expression F and return them comma-separated in string
43 VARS.
44
45
46
47 # name: <cell-element>
48 # type: sq_string
49 # elements: 1
50 # length: 8
51 poly2sym
52
53
54 # name: <cell-element>
55 # type: sq_string
56 # elements: 1
57 # length: 601
58  -- Function File: P = poly2sym (C, X)
59      Creates a symbolic polynomial expression P with coefficients C.
60      If P is not specified, the free variable is set to sym("x"). C may
61      be a vector or a cell-array of symbols. X may be a symbolic
62      expression or a string.  The coefficients correspond to decreasing
63      exponent of the free variable.
64
65      Example:
66           symbols
67           x = sym("x");
68           y = sym("y");
69           p = poly2sym ([2,5,-3]);         # p = 2*x^2+5*x-3
70           c = poly2sym ({2*y,5,-3},x);     # p = 2*y*x^2+5*x-3
71
72      See also: sym2poly, polyval, roots
73
74
75
76
77
78 # name: <cell-element>
79 # type: sq_string
80 # elements: 1
81 # length: 63
82 Creates a symbolic polynomial expression P with coefficients C.
83
84
85
86 # name: <cell-element>
87 # type: sq_string
88 # elements: 1
89 # length: 5
90 splot
91
92
93 # name: <cell-element>
94 # type: sq_string
95 # elements: 1
96 # length: 85
97  -- Function File: splot (F,X,RANGE)
98      Plot a symbolic function f(x) over range.
99
100
101
102
103 # name: <cell-element>
104 # type: sq_string
105 # elements: 1
106 # length: 41
107 Plot a symbolic function f(x) over range.
108
109
110
111 # name: <cell-element>
112 # type: sq_string
113 # elements: 1
114 # length: 8
115 sym2poly
116
117
118 # name: <cell-element>
119 # type: sq_string
120 # elements: 1
121 # length: 766
122  -- Function File: C = sym2poly (P, X)
123      Returns the coefficients of the symbolic polynomial expression P
124      as a vector. If there is only one free variable in P the
125      coefficient vector C is a plain numeric vector. If there is more
126      than one free variable in P, a second argument X specifies the
127      free variable and the function returns a cell vector of symbolic
128      expressions.  The coefficients correspond to decreasing exponent
129      of the free variable.
130
131      Example:
132           symbols
133           x = sym("x");
134           y = sym("y");
135           c = sym2poly (x^2+3*x-4);    # c = [1,3,-4]
136           c = sym2poly (x^2+y*x,x);    # c = {2,y,0}
137
138      If P is not a polynomial the result has no warranty.
139
140      See also: poly2sym, polyval, roots
141
142
143
144
145
146 # name: <cell-element>
147 # type: sq_string
148 # elements: 1
149 # length: 77
150 Returns the coefficients of the symbolic polynomial expression P as a
151 vector.
152
153
154
155 # name: <cell-element>
156 # type: sq_string
157 # elements: 1
158 # length: 9
159 symfsolve
160
161
162 # name: <cell-element>
163 # type: sq_string
164 # elements: 1
165 # length: 1284
166  -- Function File: [X, INF, MSG] = symfsolve (...)
167      Solve a set of symbolic equations using `fsolve'. There are a
168      number of ways in which this function can be called.
169
170      This solves for all free variables, initial values set to 0:
171
172           symbols
173           x=sym("x");   y=sym("y");
174           f=x^2+3*x-1;  g=x*y-y^2+3;
175           a = symfsolve(f,g);
176
177      This solves for x and y and sets the initial values to 1 and 5
178      respectively:
179
180           a = symfsolve(f,g,x,1,y,5);
181           a = symfsolve(f,g,{x==1,y==5});
182           a = symfsolve(f,g,[1 5]);
183
184      In all the previous examples vector a holds the results: x=a(1),
185      y=a(2).  If initial conditions are specified with variables, the
186      latter determine output order:
187
188           a = symfsolve(f,g,{y==1,x==2});  # here y=a(1), x=a(2)
189
190      The system of equations to solve for can be given as separate
191      arguments or as a single cell-array:
192
193           a = symfsolve({f,g},{y==1,x==2});  # here y=a(1), x=a(2)
194
195      If the variables are not specified explicitly with the initial
196      conditions, they are placed in alphabetic order. The system of
197      equations can be comma- separated or given in a cell-array. The
198      return-values are those of fsolve; X holds the found roots.
199
200    See also: fsolve
201
202
203
204
205 # name: <cell-element>
206 # type: sq_string
207 # elements: 1
208 # length: 49
209 Solve a set of symbolic equations using `fsolve'.
210
211
212
213
214