This file is indexed.

/usr/share/octave/packages/ocs-0.1.5/tst/tst_daspk.m is in octave-ocs 0.1.5-1.

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
 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
## Copyright (C) 2006,2007,2008,2011  Carlo de Falco            
##
## This file is part of:
## OCS - A Circuit Simulator for Octave
##
## OCS is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program (see the file LICENSE); if not,
## see <http://www.gnu.org/licenses/>.
##
## author: Carlo de Falco <cdf _AT_ users.sourceforge.net> 

## -*- texinfo -*-
##
## @deftypefn{Function File} {[@var{out}] =}  tst_daspk @
## (@var{cirstruct},@var{x},@var{t},@var{tol},@var{maxit},@
## @var{pltvars},@var{verbosity},@var{daskopts},@var{dae_fun});
##
## Perform a transient simulation of the system described by
## @var{cirstruct} over the time interval @var{t} using @code{daspk}.
##
## The initial value for the state vector is computed by solving a
## steady state problem at @var{t}(1), with starting guess @var{x}.
##
## @var{tol} and @var{maxit} are parameters passed to
## @code{nls_newton_raphson}.
##
## The output @var{out} will contain the value of the state vector
## at each point of @var{t}.
##
## Extra options for @code{daspk} can be passed as name/value pairs in
## the cellarray @var{daskopts}.
##
## The optional parameter  @var{verbosity} controls the amount of
## output produced: 
## 
## @itemize @minus 
## @item if verbosity(1) != 0, information on the progress
## of the algorithm are output at runtime
## @item if verbosity(2) != 0, the plot of the variables whose names
## are listed in @var{pltvars} is
## produced after the computation
## @end itemize
##
## For special purposes one may need to pass modified jacobian and
## residual functions. This can be done via the cell array of function
## handles @var{dae_fun}.
##
## Such functions should have the same input and output
## parameter list as the default sub-functions
## TSTBWEFUNJAC0,TSTBWEFUNRES0, TSTBWEFUNJAC,TSTBWEFUNRES.
##
## @seealso{tst_backward_euler,tst_odepkg,tst_theta_method,nls_newton_raphson,daspk}
##
## @end deftypefn

function [out] = tst_daspk (outstruct, x, t, tol, maxit, pltvars, verbosity, daspkopts, dae_fun)

  ## FIXME: add input check!
  if ((nargin < 6) || (nargin > 9))
    error ("tst_daspk: wrong number of input parameters.");
  endif

  if (! exist ("verbosity"))
    verbosity = [0, 0];
  elseif (length (verbosity) < 2)
    verbosity(2) = 0;
  endif

  if (verbosity(1))
    fprintf (1, "initial value:\n");
  endif
  
  daspk_options ("print initial condition info",1);
  daspk_options ("maximum order",2);
  daspk_options ("initial step size",t(2)-t(1));
  daspk_options ("relative tolerance",1e-3);

  if (nargin > 8)
    for ii = 1:2:length (daspkopts)
      daspk_options (daspkopts{ii}, daspkopts{ii+1});
    endfor
  endif
  

  [A0, B, C] = asm_initialize_system (outstruct, x);

  if (nargin > 9)
    JAC = @(x) dae_fun{1} (outstruct, x, t(1), B);
    RES = @(x) dae_fun{2} (outstruct, x, t(1), B, C);
    [x, ii, resnrm] = nls_newton_raphson (x, RES, JAC, tol, maxit, verbosity);
  else
    [out(:,1), ii] = nls_stationary (outstruct, x, tol, maxit); 
  endif
  
  if (nargin > 9)
    JAC = @(x) dae_fun{3} (outstruct, x, t(1), B);
    RES = @(x) dae_fun{4} (outstruct, x, t(1), B, C);
  else  
    JAC = @(x,xdot,t,c) TSTDASPKFUNJAC (outstruct, x, xdot, A0, B, t, c);
    RES = @(x,xdot,t)   TSTDASPKFUNRES (outstruct, x, xdot, A0, B, C, t);
  endif

  [out, xdot, istate, msg] = daspk ({RES,JAC}, out(:,1), zeros (size (x)), t);

  out = out.';
  if (verbosity(2))
    utl_plot_by_name (t, out, outstruct, pltvars)
  endif

endfunction

## Jacobian for transient problem
function lhs = TSTDASPKFUNJAC (outstruct, x, xdot, A0, B, t, c)

  [A1, Jac, res] = asm_build_system (outstruct, x, t);
  lhs = (c*(A0+A1) + B + Jac); 

endfunction

## Residual for transient problem
function rhs = TSTDASPKFUNRES (outstruct, x, xdot, A0, B, C, t)
  
  [A1, Jac, res] = asm_build_system (outstruct, x, t);
  rhs = (A0+A1)*xdot + B*x + C + res; 

endfunction