octave-nkf: src/DLD-FUNCTIONS/quad.cc annotate

annotate src/DLD-FUNCTIONS/quad.cc @ 9064:7c02ec148a3c

Check grammar on all .cc files Same check as previously done on .m files Attempt to enforce some conformity in documentation text for rules such as two spaces after a period, commas around latin abbreviations, etc.

author	Rik <rdrider0-list@yahoo.com>
date	Sat, 28 Mar 2009 13:57:22 -0700
parents	eb63fbe60fab
children	610bf90fce2a

rev	line source
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	1 /*
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	2
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	3 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2002, 2004, 2005, 2006,
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 8810 diff changeset	4 2007, 2008, 2009 John W. Eaton
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	5
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	7
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	8 Octave is free software; you can redistribute it and/or modify it
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	9 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6741 diff changeset	10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6741 diff changeset	11 option) any later version.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	12
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	16 for more details.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	17
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	18 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6741 diff changeset	19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6741 diff changeset	20 <http://www.gnu.org/licenses/>.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	21
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	22 */
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	23
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	24 #ifdef HAVE_CONFIG_H
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	25 #include <config.h>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	26 #endif
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	27
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	28 #include <string>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	29
3567 dd8998699aa8 [project @ 2000-02-03 09:54:28 by jwe] jwe parents: 3544 diff changeset	30 #include <iomanip>
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3419 diff changeset	31 #include <iostream>
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	32
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	33 #include "Quad.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	34 #include "lo-mappers.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	35
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	36 #include "defun-dld.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	37 #include "error.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	38 #include "gripes.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	39 #include "pager.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	40 #include "oct-obj.h"
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2928 diff changeset	41 #include "ov-fcn.h"
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	42 #include "unwind-prot.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	43 #include "utils.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	44 #include "variables.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	45
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: 3964 diff changeset	46 #include "Quad-opts.cc"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: 3964 diff changeset	47
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	48 #if defined (quad)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	49 #undef quad
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	50 #endif
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	51
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	52 // Global pointer for user defined function required by quadrature functions.
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2928 diff changeset	53 static octave_function *quad_fcn;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	54
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	55 // Have we warned about imaginary values returned from user function?
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	56 static bool warned_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	57
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	58 // Is this a recursive call?
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	59 static int call_depth = 0;
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	60
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	61 double
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	62 quad_user_function (double x)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	63 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	64 double retval = 0.0;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	65
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	66 octave_value_list args;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	67 args(0) = x;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	68
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	69 if (quad_fcn)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	70 {
3544 71bd2d124119 [project @ 2000-02-02 21:02:31 by jwe] jwe parents: 3523 diff changeset	71 octave_value_list tmp = quad_fcn->do_multi_index_op (1, args);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	72
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	73 if (error_state)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	74 {
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5307 diff changeset	75 quad_integration_error = 1; // FIXME
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	76 gripe_user_supplied_eval ("quad");
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	77 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	78 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	79
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	80 if (tmp.length () && tmp(0).is_defined ())
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	81 {
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	82 if (! warned_imaginary && tmp(0).is_complex_type ())
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	83 {
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	84 warning ("quad: ignoring imaginary part returned from user-supplied function");
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	85 warned_imaginary = true;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	86 }
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	87
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	88 retval = tmp(0).double_value ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	89
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	90 if (error_state)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	91 {
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5307 diff changeset	92 quad_integration_error = 1; // FIXME
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	93 gripe_user_supplied_eval ("quad");
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	94 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	95 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	96 else
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	97 {
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5307 diff changeset	98 quad_integration_error = 1; // FIXME
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	99 gripe_user_supplied_eval ("quad");
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	100 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	101 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	102
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	103 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	104 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	105
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	106 float
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	107 quad_float_user_function (float x)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	108 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	109 float retval = 0.0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	110
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	111 octave_value_list args;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	112 args(0) = x;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	113
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	114 if (quad_fcn)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	115 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	116 octave_value_list tmp = quad_fcn->do_multi_index_op (1, args);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	117
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	118 if (error_state)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	119 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	120 quad_integration_error = 1; // FIXME
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	121 gripe_user_supplied_eval ("quad");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	122 return retval;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	123 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	124
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	125 if (tmp.length () && tmp(0).is_defined ())
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	126 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	127 if (! warned_imaginary && tmp(0).is_complex_type ())
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	128 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	129 warning ("quad: ignoring imaginary part returned from user-supplied function");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	130 warned_imaginary = true;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	131 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	132
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	133 retval = tmp(0).float_value ();
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	134
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	135 if (error_state)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	136 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	137 quad_integration_error = 1; // FIXME
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	138 gripe_user_supplied_eval ("quad");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	139 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	140 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	141 else
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	142 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	143 quad_integration_error = 1; // FIXME
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	144 gripe_user_supplied_eval ("quad");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	145 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	146 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	147
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	148 return retval;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	149 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	150
3323 511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	151 #define QUAD_ABORT() \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	152 do \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	153 { \
4954 ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	154 if (fcn_name.length()) \
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	155 clear_function (fcn_name); \
3323 511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	156 unwind_protect::run_frame ("Fquad"); \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	157 return retval; \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	158 } \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	159 while (0)
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	160
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	161 #define QUAD_ABORT1(msg) \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	162 do \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	163 { \
3747 50f30e40abca [project @ 2000-12-07 05:47:06 by jwe] jwe parents: 3568 diff changeset	164 ::error ("quad: " msg); \
3323 511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	165 QUAD_ABORT (); \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	166 } \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	167 while (0)
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	168
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	169 #define QUAD_ABORT2(fmt, arg) \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	170 do \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	171 { \
3747 50f30e40abca [project @ 2000-12-07 05:47:06 by jwe] jwe parents: 3568 diff changeset	172 ::error ("quad: " fmt, arg); \
3323 511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	173 QUAD_ABORT (); \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	174 } \
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	175 while (0)
511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	176
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	177 DEFUN_DLD (quad, args, nargout,
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	178 "-- texinfo --\n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	179 @deftypefn {Loadable Function} {[@var{v}, @var{ier}, @var{nfun}, @var{err}] =} quad (@var{f}, @var{a}, @var{b}, @var{tol}, @var{sing})\n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	180 Integrate a nonlinear function of one variable using Quadpack.\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	181 The first argument is the name of the function, the function handle or\n\
4954 ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	182 the inline function to call to compute the value of the integrand. It\n\
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	183 must have the form\n\
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	184 \n\
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	185 @example\n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	186 y = f (x)\n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	187 @end example\n\
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	188 \n\
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	189 @noindent\n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	190 where @var{y} and @var{x} are scalars.\n\
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	191 \n\
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	192 The second and third arguments are limits of integration. Either or\n\
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	193 both may be infinite.\n\
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	194 \n\
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	195 The optional argument @var{tol} is a vector that specifies the desired\n\
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	196 accuracy of the result. The first element of the vector is the desired\n\
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	197 absolute tolerance, and the second element is the desired relative\n\
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	198 tolerance. To choose a relative test only, set the absolute\n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	199 tolerance to zero. To choose an absolute test only, set the relative\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	200 tolerance to zero. \n\
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	201 \n\
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	202 The optional argument @var{sing} is a vector of values at which the\n\
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	203 integrand is known to be singular.\n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	204 \n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	205 The result of the integration is returned in @var{v} and @var{ier}\n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	206 contains an integer error code (0 indicates a successful integration).\n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	207 The value of @var{nfun} indicates how many function evaluations were\n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	208 required, and @var{err} contains an estimate of the error in the\n\
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	209 solution.\n\
3964 3030cb6cb559 [project @ 2002-06-28 17:17:55 by jwe] jwe parents: 3747 diff changeset	210 \n\
3030cb6cb559 [project @ 2002-06-28 17:17:55 by jwe] jwe parents: 3747 diff changeset	211 You can use the function @code{quad_options} to set optional\n\
3030cb6cb559 [project @ 2002-06-28 17:17:55 by jwe] jwe parents: 3747 diff changeset	212 parameters for @code{quad}.\n\
6741 00116015904d [project @ 2007-06-18 16:07:14 by jwe] jwe parents: 5823 diff changeset	213 \n\
00116015904d [project @ 2007-06-18 16:07:14 by jwe] jwe parents: 5823 diff changeset	214 It should be noted that since @code{quad} is written in Fortran it\n\
00116015904d [project @ 2007-06-18 16:07:14 by jwe] jwe parents: 5823 diff changeset	215 cannot be called recursively.\n\
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3325 diff changeset	216 @end deftypefn")
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	217 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	218 octave_value_list retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	219
4954 ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	220 std::string fcn_name;
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	221
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	222 warned_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	223
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	224 unwind_protect::begin_frame ("Fquad");
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	225
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	226 unwind_protect_int (call_depth);
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	227 call_depth++;
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	228
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	229 if (call_depth > 1)
3323 511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	230 QUAD_ABORT1 ("invalid recursive call");
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	231
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	232 int nargin = args.length ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	233
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	234 if (nargin > 2 && nargin < 6 && nargout < 5)
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	235 {
4954 ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	236 if (args(0).is_function_handle () \|\| args(0).is_inline_function ())
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	237 quad_fcn = args(0).function_value ();
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	238 else
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	239 {
4962 0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe] jwe parents: 4954 diff changeset	240 fcn_name = unique_symbol_name ("__quad_fcn_");
4954 ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	241 std::string fname = "function y = ";
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	242 fname.append (fcn_name);
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	243 fname.append ("(x) y = ");
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	244 quad_fcn = extract_function (args(0), "quad", fcn_name, fname,
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	245 "; endfunction");
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	246 }
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	247
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	248 if (! quad_fcn)
3323 511caaa5e98e [project @ 1999-10-27 02:21:46 by jwe] jwe parents: 3321 diff changeset	249 QUAD_ABORT ();
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	250
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	251 if (args(1).is_single_type () \|\| args(2).is_single_type ())
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	252 {
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	253 float a = args(1).float_value ();
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	254
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	255 if (error_state)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	256 QUAD_ABORT1 ("expecting second argument to be a scalar");
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: 3964 diff changeset	257
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	258 float b = args(2).float_value ();
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	259
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	260 if (error_state)
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	261 QUAD_ABORT1 ("expecting third argument to be a scalar");
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	262
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	263 int indefinite = 0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	264 FloatIndefQuad::IntegralType indef_type = FloatIndefQuad::doubly_infinite;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	265 float bound = 0.0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	266 if (xisinf (a) && xisinf (b))
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	267 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	268 indefinite = 1;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	269 indef_type = FloatIndefQuad::doubly_infinite;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	270 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	271 else if (xisinf (a))
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	272 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	273 indefinite = 1;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	274 bound = b;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	275 indef_type = FloatIndefQuad::neg_inf_to_bound;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	276 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	277 else if (xisinf (b))
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	278 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	279 indefinite = 1;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	280 bound = a;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	281 indef_type = FloatIndefQuad::bound_to_inf;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	282 }
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	283
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	284 octave_idx_type ier = 0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	285 octave_idx_type nfun = 0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	286 float abserr = 0.0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	287 float val = 0.0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	288 bool have_sing = false;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	289 FloatColumnVector sing;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	290 FloatColumnVector tol;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	291
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	292 switch (nargin)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	293 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	294 case 5:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	295 if (indefinite)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	296 QUAD_ABORT1 ("singularities not allowed on infinite intervals");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	297
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	298 have_sing = true;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	299
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	300 sing = FloatColumnVector (args(4).float_vector_value ());
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	301
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	302 if (error_state)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	303 QUAD_ABORT1 ("expecting vector of singularities as fourth argument");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	304
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	305 case 4:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	306 tol = FloatColumnVector (args(3).float_vector_value ());
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	307
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	308 if (error_state)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	309 QUAD_ABORT1 ("expecting vector of tolerances as fifth argument");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	310
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	311 switch (tol.capacity ())
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	312 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	313 case 2:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	314 quad_opts.set_single_precision_relative_tolerance (tol (1));
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	315
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	316 case 1:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	317 quad_opts.set_single_precision_absolute_tolerance (tol (0));
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	318 break;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	319
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	320 default:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	321 QUAD_ABORT1 ("expecting tol to contain no more than two values");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	322 }
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	323
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	324 case 3:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	325 if (indefinite)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	326 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	327 FloatIndefQuad iq (quad_float_user_function, bound,
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	328 indef_type);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	329 iq.set_options (quad_opts);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	330 val = iq.float_integrate (ier, nfun, abserr);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	331 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	332 else
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	333 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	334 if (have_sing)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	335 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	336 FloatDefQuad dq (quad_float_user_function, a, b, sing);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	337 dq.set_options (quad_opts);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	338 val = dq.float_integrate (ier, nfun, abserr);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	339 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	340 else
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	341 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	342 FloatDefQuad dq (quad_float_user_function, a, b);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	343 dq.set_options (quad_opts);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	344 val = dq.float_integrate (ier, nfun, abserr);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	345 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	346 }
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	347 break;
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	348
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	349 default:
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	350 panic_impossible ();
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	351 break;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	352 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	353
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	354 retval(3) = abserr;
8810 c9e1db15035b eliminate unnecessary casts John W. Eaton <jwe@octave.org> parents: 7805 diff changeset	355 retval(2) = nfun;
c9e1db15035b eliminate unnecessary casts John W. Eaton <jwe@octave.org> parents: 7805 diff changeset	356 retval(1) = ier;
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	357 retval(0) = val;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	358
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	359 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	360 else
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	361 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	362 double a = args(1).double_value ();
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	363
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	364 if (error_state)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	365 QUAD_ABORT1 ("expecting second argument to be a scalar");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	366
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	367 double b = args(2).double_value ();
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	368
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	369 if (error_state)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	370 QUAD_ABORT1 ("expecting third argument to be a scalar");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	371
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	372 int indefinite = 0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	373 IndefQuad::IntegralType indef_type = IndefQuad::doubly_infinite;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	374 double bound = 0.0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	375 if (xisinf (a) && xisinf (b))
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	376 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	377 indefinite = 1;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	378 indef_type = IndefQuad::doubly_infinite;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	379 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	380 else if (xisinf (a))
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	381 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	382 indefinite = 1;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	383 bound = b;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	384 indef_type = IndefQuad::neg_inf_to_bound;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	385 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	386 else if (xisinf (b))
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	387 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	388 indefinite = 1;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	389 bound = a;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	390 indef_type = IndefQuad::bound_to_inf;
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	391 }
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	392
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	393 octave_idx_type ier = 0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	394 octave_idx_type nfun = 0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	395 double abserr = 0.0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	396 double val = 0.0;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	397 bool have_sing = false;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	398 ColumnVector sing;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	399 ColumnVector tol;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	400
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	401 switch (nargin)
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	402 {
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	403 case 5:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	404 if (indefinite)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	405 QUAD_ABORT1 ("singularities not allowed on infinite intervals");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	406
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	407 have_sing = true;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	408
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	409 sing = ColumnVector (args(4).vector_value ());
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	410
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	411 if (error_state)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	412 QUAD_ABORT1 ("expecting vector of singularities as fourth argument");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	413
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	414 case 4:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	415 tol = ColumnVector (args(3).vector_value ());
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	416
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	417 if (error_state)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	418 QUAD_ABORT1 ("expecting vector of tolerances as fifth argument");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	419
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	420 switch (tol.capacity ())
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	421 {
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	422 case 2:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	423 quad_opts.set_relative_tolerance (tol (1));
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	424
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	425 case 1:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	426 quad_opts.set_absolute_tolerance (tol (0));
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	427 break;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	428
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	429 default:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	430 QUAD_ABORT1 ("expecting tol to contain no more than two values");
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	431 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	432
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	433 case 3:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	434 if (indefinite)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	435 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	436 IndefQuad iq (quad_user_function, bound, indef_type);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	437 iq.set_options (quad_opts);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	438 val = iq.integrate (ier, nfun, abserr);
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	439 }
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	440 else
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	441 {
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	442 if (have_sing)
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	443 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	444 DefQuad dq (quad_user_function, a, b, sing);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	445 dq.set_options (quad_opts);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	446 val = dq.integrate (ier, nfun, abserr);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	447 }
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	448 else
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	449 {
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	450 DefQuad dq (quad_user_function, a, b);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	451 dq.set_options (quad_opts);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	452 val = dq.integrate (ier, nfun, abserr);
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	453 }
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	454 }
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	455 break;
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	456
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	457 default:
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	458 panic_impossible ();
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	459 break;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	460 }
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	461
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	462 retval(3) = abserr;
8810 c9e1db15035b eliminate unnecessary casts John W. Eaton <jwe@octave.org> parents: 7805 diff changeset	463 retval(2) = nfun;
c9e1db15035b eliminate unnecessary casts John W. Eaton <jwe@octave.org> parents: 7805 diff changeset	464 retval(1) = ier;
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	465 retval(0) = val;
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	466 }
4954 ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	467
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	468 if (fcn_name.length())
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4140 diff changeset	469 clear_function (fcn_name);
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	470 }
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	471 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	472 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	473
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	474 unwind_protect::run_frame ("Fquad");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	475
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	476 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	477 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	478
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	479 /*
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	480
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	481 %!function y = f (x)
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	482 %! y = x + 1;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	483 %!test
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	484 %! [v, ier, nfun, err] = quad ("f", 0, 5);
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	485 %! assert(ier == 0 && abs (v - 17.5) < sqrt (eps) && nfun > 0 &&
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	486 %! err < sqrt (eps))
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	487 %!test
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	488 %! [v, ier, nfun, err] = quad ("f", single(0), single(5));
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	489 %! assert(ier == 0 && abs (v - 17.5) < sqrt (eps ("single")) && nfun > 0 &&
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	490 %! err < sqrt (eps ("single")))
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	491
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	492 %!function y = f (x)
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	493 %! y = x .* sin (1 ./ x) .* sqrt (abs (1 - x));
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	494 %!test
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	495 %! [v, ier, nfun, err] = quad ("f", 0.001, 3);
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	496 %! assert((ier == 0 \|\| ier == 1) && abs (v - 1.98194120273598) < sqrt (eps) && nfun > 0);
7805 62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	497 %!test
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	498 %! [v, ier, nfun, err] = quad ("f", single(0.001), single(3));
62affb34e648 Make quad work with single precision David Bateman <dbateman@free.fr> parents: 7562 diff changeset	499 %! assert((ier == 0 \|\| ier == 1) && abs (v - 1.98194120273598) < sqrt (eps ("single")) && nfun > 0);
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	500
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	501 %!error <Invalid call to quad.*> quad ();
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	502
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	503 %!error <Invalid call to quad.*> quad ("f", 1, 2, 3, 4, 5);
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	504
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	505 %!test
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	506 %! quad_options ("absolute tolerance", eps);
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	507 %! assert(quad_options ("absolute tolerance") == eps);
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	508
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	509 %!error <Invalid call to quad_options.*> quad_options (1, 2, 3);
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	510
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	511 */
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	512
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	513 /*
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	514 ;;; Local Variables: ***
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	515 ;;; mode: C++ ***
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	516 ;;; End: ***
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	517 */

Mercurial > octave-nkf

annotate src/DLD-FUNCTIONS/quad.cc @ 9064:7c02ec148a3c