Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / ocs-0.1.3 / nls / doc-cache

diff --git a/octave_packages/ocs-0.1.3/nls/doc-cache b/octave_packages/ocs-0.1.3/nls/doc-cache
new file mode 100644 (file)
index 0000000..dca39ca
--- /dev/null
+++ b/octave_packages/ocs-0.1.3/nls/doc-cache
@@ -0,0 +1,94 @@
+# Created by Octave 3.6.1, Sun Mar 25 17:34:24 2012 UTC <root@t61>
+# 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: 1013
+ -- 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: 471
+ -- 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.
+
+
+
+
+