Mercurial > octave
view scripts/sparse/private/__alltohandles__.m @ 24892:2e94172bc1c1 stable
maint: update GPL license text and license header blocks
* COPYING: Update to the latest upstream license text from gnu.org.
* doc/liboctave/gpl.texi: Likewise.
* __alltohandles__.m, __default__input__.m, tfqmr.m: Update GPLv3 license
header punctuation and formatting for consistency.
author | Mike Miller <mtmiller@octave.org> |
---|---|
date | Wed, 14 Mar 2018 22:26:31 -0700 |
parents | 6266e321ef22 |
children | d85b2485af9e |
line wrap: on
line source
## Copyright (C) 2016 Cristiano Dorigo, Octave Arena ## ## 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 (isa (A, "function_handle")) 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 (size (A, 2) != size (b, 1)) 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 M1fun = @(x) x; else # M1 not empty if (isa (M1, "function_handle")) 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 M2fun = @(x) x; else # M2 not empty if (isa (M2, "function_handle")) 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