Mercurial > octave
view scripts/sparse/private/__alltohandles__.m @ 28563:5a07c798eb08
avoid function call input or output argument number mismatch
Don't call functions with more inputs or outputs than they are defined
to accept. For example, always define graphics callback functions to
accept at least two arguments. To avoid creating unused variable
names, they may be defined as ignored (~).
* importdata.m: Call fileparts with three outputs, not four.
* inputParser.m: Define default validation function with ignored input.
* odemergeopts.m: Accept additional SOLVER argument.
* annotation.m, legend.m, movfun.m, bug-55321.tst: Define callback
functions with two inputs.
* annotation.m (addbasemenu): Also accept varargin.
* graphics.cc: Fix tests.
* pkg/private/install.m: Don't pass extra global_install argument to
getarchdir.
* sparse/private/__alltohandles__.m: Define function handles with two
inputs where needed.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Sat, 11 Jul 2020 10:15:57 -0400 |
parents | bd51beb6205e |
children | 0de38a6ef693 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2016-2020 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 (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 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