Mercurial > octave-nkf
view scripts/deprecated/luinc.m @ 19631:db92e7e28e1f
strip trailing whitespace from most source files
* NEWS, doc/interpreter/contributors.in, doc/interpreter/func.txi,
doc/interpreter/genpropdoc.m, doc/interpreter/octave_logo.eps,
doc/interpreter/plot.txi, doc/interpreter/stmt.txi,
examples/data/Makefile.am, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/error.cc,
libinterp/corefcn/file-io.cc, libinterp/corefcn/gl-render.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/graphics.in.h,
libinterp/corefcn/load-path.cc, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pt-jit.cc, libinterp/corefcn/strfind.cc,
libinterp/corefcn/toplev.cc, libinterp/corefcn/toplev.h,
libinterp/corefcn/urlwrite.cc, libinterp/corefcn/variables.cc,
libinterp/octave-value/ov-classdef.cc,
libinterp/octave-value/ov-classdef.h, libinterp/octave.cc,
libinterp/parse-tree/lex.h, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-classdef.h, liboctave/system/file-ops.cc,
liboctave/system/oct-env.cc, m4/acinclude.m4,
scripts/deprecated/finite.m, scripts/deprecated/fmod.m,
scripts/deprecated/fnmatch.m, scripts/deprecated/luinc.m,
scripts/deprecated/octave_tmp_file_name.m, scripts/deprecated/syl.m,
scripts/deprecated/usage.m, scripts/general/inputParser.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/isequal.m,
scripts/general/private/__isequal__.m, scripts/geometry/voronoi.m,
scripts/image/image.m, scripts/image/imshow.m,
scripts/image/ind2rgb.m, scripts/linear-algebra/bandwidth.m,
scripts/linear-algebra/isbanded.m, scripts/miscellaneous/bzip2.m,
scripts/miscellaneous/cast.m, scripts/miscellaneous/copyfile.m,
scripts/miscellaneous/delete.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/getappdata.m, scripts/miscellaneous/gunzip.m,
scripts/miscellaneous/isappdata.m, scripts/miscellaneous/ls.m,
scripts/miscellaneous/mex.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/orderfields.m, scripts/miscellaneous/recycle.m,
scripts/miscellaneous/rmappdata.m, scripts/miscellaneous/setfield.m,
scripts/miscellaneous/symvar.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/ver.m, scripts/miscellaneous/what.m,
scripts/miscellaneous/xor.m, scripts/miscellaneous/zip.m,
scripts/optimization/fminbnd.m, scripts/optimization/sqp.m,
scripts/path/private/getsavepath.m, scripts/path/savepath.m,
scripts/pkg/pkg.m, scripts/pkg/private/installed_packages.m,
scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m,
scripts/plot/draw/private/__quiver__.m,
scripts/plot/draw/private/__scatter__.m,
scripts/plot/draw/private/__stem__.m, scripts/plot/draw/surface.m,
scripts/plot/draw/surfnorm.m, scripts/plot/util/copyobj.m,
scripts/plot/util/hgload.m, scripts/plot/util/hgsave.m,
scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m,
scripts/plot/util/private/__go_draw_axes__.m, scripts/set/setdiff.m,
scripts/set/union.m, scripts/signal/periodogram.m,
scripts/sparse/eigs.m, scripts/sparse/ilu.m, scripts/sparse/qmr.m,
scripts/sparse/sprand.m, scripts/sparse/sprandn.m,
scripts/specfun/beta.m, scripts/specfun/ellipke.m,
scripts/specfun/isprime.m, scripts/statistics/base/lscov.m,
scripts/testfun/__run_test_suite__.m, scripts/testfun/test.m:
Strip trailing whitespace.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 20 Jan 2015 10:29:54 -0500 |
parents | 71da5cce37d6 |
children | ebd27d8c63fd |
line wrap: on
line source
## Copyright (C) 2014 John W. Eaton ## ## This file is part of Octave. ## ## Octave 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; either version 3 of the License, or (at ## your option) any later version. ## ## Octave 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 Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## @deftypefn {Built-in Function} {[@var{L}, @var{U}, @var{P}, @var{Q}] =} luinc (@var{A}, '0') ## @deftypefnx {Built-in Function} {[@var{L}, @var{U}, @var{P}, @var{Q}] =} luinc (@var{A}, @var{droptol}) ## @deftypefnx {Built-in Function} {[@var{L}, @var{U}, @var{P}, @var{Q}] =} luinc (@var{A}, @var{opts}) ## ## @code{luinc} is deprecated and will be removed in Octave version 4.6. ## Please use @code{ilu} or @code{ichol} in all new code. ## ## Produce the incomplete LU@tie{}factorization of the sparse matrix @var{A}. ## Two types of incomplete factorization are possible, and the type ## is determined by the second argument to @code{luinc}. ## ## Called with a second argument of @qcode{'0'}, the zero-level incomplete ## LU@tie{}factorization is produced. This creates a factorization of @var{A} ## where the position of the nonzero arguments correspond to the same ## positions as in the matrix @var{A}. ## ## Alternatively, the fill-in of the incomplete LU@tie{}factorization can ## be controlled through the variable @var{droptol} or the structure ## @var{opts}. The @sc{umfpack} multifrontal factorization code by Tim A. ## Davis is used for the incomplete LU@tie{}factorization, (availability ## @url{http://www.cise.ufl.edu/research/sparse/umfpack/}) ## ## @var{droptol} determines the values below which the values in the ## LU@tie{} factorization are dropped and replaced by zero. It must be a ## positive scalar, and any values in the factorization whose absolute value ## are less than this value are dropped, expect if leaving them increase the ## sparsity of the matrix. Setting @var{droptol} to zero results in a complete ## LU@tie{}factorization which is the default. ## ## @var{opts} is a structure containing one or more of the fields ## ## @table @code ## @item droptol ## The drop tolerance as above. If @var{opts} only contains @code{droptol} ## then this is equivalent to using the variable @var{droptol}. ## ## @item milu ## A logical variable flagging whether to use the modified incomplete ## LU@tie{} factorization. In the case that @code{milu} is true, the dropped ## values are subtracted from the diagonal of the matrix @var{U} of the ## factorization. The default is @code{false}. ## ## @item udiag ## A logical variable that flags whether zero elements on the diagonal of ## @var{U} should be replaced with @var{droptol} to attempt to avoid singular ## factors. The default is @code{false}. ## ## @item thresh ## Defines the pivot threshold in the interval [0,1]. Values outside that ## range are ignored. ## @end table ## ## All other fields in @var{opts} are ignored. The outputs from @code{luinc} ## are the same as for @code{lu}. ## ## Given the string argument @qcode{\"vector\"}, @code{luinc} returns the ## values of @var{p} @var{q} as vector values. ## @seealso{ilu, ichol, lu, sparse} ## @end deftypefn ## Deprecated in version 4.2 function [L, U, P, Q] = luinc (varargin) persistent warned = false; if (! warned) warned = true; warning ("Octave:deprecated-function", "luinc is obsolete and will be removed from a future version of Octave, please use ilu or ichol instead"); endif [L, U, P, Q] = __luinc__ (varargin{:}); endfunction