Mercurial > octave
view scripts/general/subsindex.m @ 31063:451fb63a10a0
update integral to call quadgk for 'ArrayValued' integrations (bug #62468)
* integral.m: Modify integrator selection so that calls with ‘ArrayValued’ go
to quadgk instead of quadv. Remove error checks for previously incompatible
parameter combinations. Update docstring to remove mention of quadv, point
'ArrayValued' reference to quadgk, change returned error parameter description
to match current behavior, and remove parameter incompatibility note. Add BIST
to verify combined parameter functionality, and change BISTs checking quadv
err parameter.
* quadgk.m: Correct parameter name in docstring.
* NEWS.8.md: Under General Improvements add note about quadgk now accepting
'ArrayValued' parameter and update integral improvement description of
optional returned error parameter. Under Matlab Compatibility add note about
integral now accepting all parameter combinations.
author | Nicholas R. Jankowski <jankowski.nicholas@gmail.com> |
---|---|
date | Thu, 02 Jun 2022 19:56:15 -0400 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2008-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{idx} =} subsindex (@var{obj}) ## Convert an object to an index vector. ## ## When @var{obj} is a class object defined with a class constructor, then ## @code{subsindex} is the overloading method that allows the conversion of ## this class object to a valid indexing vector. It is important to note that ## @code{subsindex} must return a zero-based real integer vector of the class ## @qcode{"double"}. For example, if the class constructor were ## ## @example ## @group ## function obj = myclass (a) ## obj = class (struct ("a", a), "myclass"); ## endfunction ## @end group ## @end example ## ## @noindent ## then the @code{subsindex} function ## ## @example ## @group ## function idx = subsindex (obj) ## idx = double (obj.a) - 1.0; ## endfunction ## @end group ## @end example ## ## @noindent ## could be used as follows ## ## @example ## @group ## a = myclass (1:4); ## b = 1:10; ## b(a) ## @result{} 1 2 3 4 ## @end group ## @end example ## ## @seealso{class, subsref, subsasgn} ## @end deftypefn function idx = subsindex (obj) if (nargin < 1) print_usage (); endif ## Only way to get here is if subsindex has not been overloaded by a class. error ('subsindex: not defined for class "%s"', class (obj)); endfunction %!error <not defined for class "double"> subsindex (1) ## Test input validation %!error <Invalid call> subsindex ()