Mercurial > octave-libtiff
view scripts/sparse/private/__alltohandles__.m @ 30564:796f54d4ddbf stable
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2021.
In all .txi and .texi files except gpl.txi and gpl.texi in the
doc/liboctave and doc/interpreter directories, change the copyright
to "Octave Project Developers", the same as used for other source
files. Update copyright notices for 2022 (not done since 2019). For
gpl.txi and gpl.texi, change the copyright notice to be "Free Software
Foundation, Inc." and leave the date at 2007 only because this file
only contains the text of the GPL, not anything created by the Octave
Project Developers.
Add Paul Thomas to contributors.in.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 28 Dec 2021 18:22:40 -0500 |
parents | 628f26e122d9 |
children | e1788b1a315f |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2016-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {[@var{Afun}, @var{M1fun}, @var{M2fun}] =} __alltohandles__ (@var{A}, @var{b}, @var{M1}, @var{M2}, @var{solver_name}) ## ## Check if the parameters @var{A} (matrix of our linear system), @var{b} ## (right hand side vector), @var{M1}, @var{M2} (preconditioner matrices) are ## really matrices or functions handle, summarizing if they are void or not. ## ## The input parameters are: ## ## @itemize ## @item @var{A} is the matrix of the linear system. ## ## @item @var{b} is the right hand side vector. ## ## @item @var{M1}, @var{M2} preconditioners. They can be []. ## ## @item @var{solver_name} is the name of the solver as string. ## ## @end itemize ## ## The output parameters are: ## ## @itemize ## ## @item @var{Afun}, @var{M1fun}, @var{M2fun} are the corresponding ## function handles. ## ## @end itemize ## @end deftypefn function [Afun, M1fun, M2fun] = __alltohandles__ (A, b, M1, M2, solver_name) A_is_numeric = false; M1_is_numeric = false; M2_is_numeric = false; ## Check A and set its type if (is_function_handle (A)) Afun = A; elseif (ischar (A)) Afun = str2func (A); elseif (! isnumeric (A) || ! issquare (A)) error ([solver_name, ": A must be a square matrix or a function handle"]); else A_is_numeric = true; if (columns (A) != rows (b)) error ("__alltohandles__: dimension of B is not consistent with A"); endif endif ## Check M1 and sets its type if (isempty (M1)) # M1 empty, set to identity function switch (solver_name) case {"pcg", "gmres", "bicgstab", "cgs", "tfqmr"} ## methods which do not require the transpose M1fun = @(x) x; case {"bicg"} ## methods which do require the transpose M1fun = @(x, ~) x; otherwise error (["__alltohandles__: unknown method: ", solver_name]); endswitch else # M1 not empty if (is_function_handle (M1)) M1fun = M1; elseif (ischar (M1)) M1fun = str2func (M1); elseif (! isnumeric (M1) || ! issquare (M1)) error ([solver_name, ": M1 must be a square matrix or a function handle"]); else M1_is_numeric = true; endif endif if (isempty (M2)) # M2 empty, then I set is to the identity function switch (solver_name) case {"pcg", "gmres", "bicgstab", "cgs", "tfqmr"} ## methods which do not require the transpose M2fun = @(x) x; case {"bicg"} ## methods which do require the transpose M2fun = @(x, ~) x; otherwise error (["__alltohandles__: unknown method: ", solver_name]); endswitch else # M2 not empty if (is_function_handle (M2)) M2fun = M2; elseif (ischar (M2)) M2fun = str2func (M2); elseif (! isnumeric (M2) || ! issquare (M2)) error ([solver_name, ": M2 must be a square matrix or a function handle"]); else M2_is_numeric = true; endif endif switch (solver_name) case {"pcg", "gmres", "bicgstab", "cgs", "tfqmr"} ## methods which do not require the transpose if (A_is_numeric) Afun = @(x) A * x; endif if (M1_is_numeric) M1fun = @(x) M1 \ x; endif if (M2_is_numeric) M2fun = @(x) M2 \ x; endif case {"bicg"} ## methods which do require the transpose if (A_is_numeric) Afun = @(x, trans) A_sub (A, x, trans); endif if (M1_is_numeric) M1fun = @(x, trans) M_sub (M1, x, trans); endif if (M2_is_numeric) M2fun = @(x, trans) M_sub (M2, x, trans); endif otherwise error (["__alltohandles__: unknown method: ", solver_name]); endswitch endfunction function y = A_sub (A, x, trans) if (strcmp (trans, "transp")) y = A' * x; else y = A * x; endif endfunction function y = M_sub (M, x, trans) if (strcmp (trans, "transp")) y = M' \ x; else y = M \ x; endif endfunction