/usr/share/octave/packages/ocs-0.1.5/nls/doc-cache is in octave-ocs 0.1.5-2+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # doc-cache created by Octave 4.0.3
# name: cache
# type: cell
# rows: 3
# columns: 2
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 18
nls_newton_raphson
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1007
-- Function File: [Y,NUMIT,RESNRM] = nls_newton_raphson
(Y0,RES,JAC,TOL,MAXIT,VERBOSITY,UPDATE);
Solve a non-linear system of equations using the Newton-Raphson
method with damping and return the computed solution vector Y.
The initial guess for the algorithm is set to Y0.
The Jacobian and residual at each step are computed via the
function handles RES and JAC.
The variables TOL and MAXIT are the relative tolerance on the error
of the computed solution and the maximum number of iterations to be
performed by the algorithm.
The optional parameter VERBOSITY produce verbose output if
non-zero.
The optional function handle UPDATE may be used to provide a faster
mean to update Jacobian and residual at runtime.
NUMIT is the number of performed iterations while RESNRM is a
vector containing the residual norm at each step.
See also:
nls_stationary,tst_backward_euler,tst_theta_method,tst_daspk,tst_odepkg.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Solve a non-linear system of equations using the Newton-Raphson method
with damp
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 14
nls_stationary
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 469
-- Function File: [OUT, NITER] = nls_stationary (INSTRUCT,X,TOL,MAXIT)
Compute the stationary state solution OUT of the system described
by INSTRUCT.
X is the initial guess used by the Newton-Raphson algorithm
implemented in 'nls_newton_raphson', while TOL and MAXIT are the
corresponding parameters.
The optional output NITER returns the number of Newton iterations
needed to reach convergence.
See also: nls_newton_raphson.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 78
Compute the stationary state solution OUT of the system described by
INSTRUCT.
|