octave_packages/ocs-0.1.3/nls/doc-cache

   1 # Created by Octave 3.6.1, Sun Mar 25 17:34:24 2012 UTC <root@t61>
   2 # name: cache
   3 # type: cell
   4 # rows: 3
   5 # columns: 2
   6 # name: <cell-element>
   7 # type: sq_string
   8 # elements: 1
   9 # length: 18
  10 nls_newton_raphson
  11
  12
  13 # name: <cell-element>
  14 # type: sq_string
  15 # elements: 1
  16 # length: 1013
  17  -- Function File: [Y,NUMIT,RESNRM] = nls_newton_raphson
  18           (Y0,RES,JAC,TOL, MAXIT,VERBOSITY,UPDATE);
  19      Solve a non-linear system of equations using the Newton-Raphson
  20      method with damping and return the computed solution vector Y.
  21
  22      The initial guess for the algorithm is set to Y0.
  23
  24      The Jacobian and residual at each step are computed via the
  25      function handles RES and JAC.
  26
  27      The variables TOL and MAXIT are the relative tolerance on the
  28      error of the computed solution and the maximum number of
  29      iterations to be performed by the algorithm.
  30
  31      The optional parameter VERBOSITY produce verbose output if
  32      non-zero.
  33
  34      The optional function handle UPDATE may be used to provide a
  35      faster mean to update Jacobian and residual at runtime.
  36
  37      NUMIT is the number of performed iterations while RESNRM is a
  38      vector containing the residual norm at each step.
  39
  40      See also: nls_stationary, tst_backward_euler, tst_theta_method,
  41      tst_daspk, tst_odepkg
  42
  43
  44
  45
  46
  47 # name: <cell-element>
  48 # type: sq_string
  49 # elements: 1
  50 # length: 80
  51 Solve a non-linear system of equations using the Newton-Raphson method
  52 with damp
  53
  54
  55
  56 # name: <cell-element>
  57 # type: sq_string
  58 # elements: 1
  59 # length: 14
  60 nls_stationary
  61
  62
  63 # name: <cell-element>
  64 # type: sq_string
  65 # elements: 1
  66 # length: 471
  67  -- Function File: [OUT, NITER] = nls_stationary (INSTRUCT,X,TOL,MAXIT)
  68      Compute the stationary state solution OUT of the system described
  69      by INSTRUCT.
  70
  71      X is the initial guess used by the Newton-Raphson algorithm
  72      implemented in `nls_newton_raphson', while TOL and MAXIT are the
  73      corresponding parameters.
  74
  75      The optional output NITER returns the number of Newton iterations
  76      needed to reach convergence.
  77
  78      See also: nls_newton_raphson
  79
  80
  81
  82
  83
  84 # name: <cell-element>
  85 # type: sq_string
  86 # elements: 1
  87 # length: 78
  88 Compute the stationary state solution OUT of the system described by
  89 INSTRUCT.
  90
  91
  92
  93
  94