Mercurial > octave
view oct-conf-post-public.in.h @ 31263:449ed6f427cb
ode45/23/23s: Implement Events, OutputFcn, & Refine options (bug #49408 and #63063)
* scripts/ode/ode23.m: Remove disabling of Refine option with struct output.
Modify solution struct to output two sets of solution variables: output_t,
output_x and ode_t and ode_x, and transpose struct output variables for
improved Matlab compatibility. Update BISTs and perform minor code formatting.
* scripts/ode/ode23s.m: Make same changes as ode23.m.
* scripts/ode/ode45.m: Make same changes as ode23.m. Remove comment indicating
that Refine is not implemented.
* scripts/ode/private/integrate_adaptive.m: Update internal handling of
variables t and x, separating them into ode_t & ode_x for internal integration
and output_t & output_x for function output or calls to OutputFcn. Replace
prior attempt at Refine option with new implementation. Specify time output or
Refine != 0 are both interpolated from internal variables (ode_t, ode_x) for
output of non-struct variables and/or for use with OutputFcn. Improve event
handling when multiple Events (including at least one terminal Event) are
detected in a single simulation step so that all Events up to and including the
first terminal one are reported, and final data point is set to that of
terminal Event. Send multiple data points in a single call to OutputFcn if they
are all interpolated from a single integration step. Remove warning for
termination when term signal is received from Events or OutputFcn. Return both
internal variables (ode_t, ode_x) and interpolated variables (output_t,
output_x) to allow calling function to correctly return either struct or
separate variables.
* scripts/ode/private/ode_event_handler.m: Sort multiple Events in ascending
time order when they are encountered in one integration step. Remove any events
after the time of a terminal Event.
* scripts/ode/odeset.m: Update docstring to remove indication that Refine is
not implemented
* scripts/ode/odeplot.m: Update docstring to indicate that input t can be a
scalar or vector. Add file test.
* etc/NEWS.8.md: Add descriptions of changes under General improvements and
Matlab compatibility.
author | Ken Marek <marek_ka@mercer.edu> |
---|---|
date | Wed, 05 Oct 2022 16:53:01 -0400 |
parents | 3e395f6fc03a |
children | e7fc6251b698 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1993-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/>. // //////////////////////////////////////////////////////////////////////// #if defined (__cplusplus) # include <cinttypes> #else # include <inttypes.h> #endif # define OCTAVE_NAMESPACE_BEGIN namespace octave { # define OCTAVE_NAMESPACE_END } /* The C++ standard is evolving to allow attribute hints in a compiler-independent manner. In C++ 2011 support for noreturn was added. In C++ 2014 support for deprecated was added. The Octave code base has been future-proofed by using macros of the form OCTAVE_ATTRIBUTE_NAME in place of vendor specific attribute mechanisms. As compilers evolve, the underlying implementation can be changed with the macro definitions below. FIXME: Update macros to use C++ standard attribute syntax when Octave moves to C++ 2011 standard. */ #if defined (__GNUC__) /* The following attributes are used with gcc and clang compilers. */ # if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) # define OCTAVE_DEPRECATED(ver, msg) __attribute__ ((__deprecated__ ("[" #ver "]: " msg))) # else # define OCTAVE_DEPRECATED(ver, msg) __attribute__ ((__deprecated__)) # endif # define HAVE_OCTAVE_DEPRECATED_ATTR 1 # define OCTAVE_NORETURN __attribute__ ((__noreturn__)) # define HAVE_OCTAVE_NORETURN_ATTR 1 # define OCTAVE_UNUSED __attribute__ ((__unused__)) # define HAVE_OCTAVE_UNUSED_ATTR 1 #else # define OCTAVE_DEPRECATED(ver, msg) # define OCTAVE_NORETURN # define OCTAVE_UNUSED /* # undef HAVE_OCTAVE_DEPRECATED_ATTR */ /* # undef HAVE_OCTAVE_NORETURN_ATTR */ /* # undef HAVE_OCTAVE_UNUSED_ATTR */ #endif #if defined (__MINGW32__) /* MinGW requires special handling due to different format specifiers * on different platforms. The macro __MINGW_PRINTF_FORMAT maps to * either gnu_printf or ms_printf depending on where we are compiling * to avoid warnings on format specifiers that are legal. * See: https://bugzilla.mozilla.org/show_bug.cgi?id=1331349 */ # if defined (__cplusplus) # include <cstdio> # else # include <stdio.h> # endif # define OCTAVE_FORMAT_PRINTF(stringIndex, firstToCheck) \ __attribute__ ((format (__MINGW_PRINTF_FORMAT, stringIndex, firstToCheck))) # define HAVE_OCTAVE_FORMAT_PRINTF_ATTR 1 #elif defined (__GNUC__) /* The following attributes are used with gcc and clang compilers. */ # define OCTAVE_FORMAT_PRINTF(index, first) \ __attribute__ ((__format__(printf, index, first))) # define HAVE_OCTAVE_FORMAT_PRINTF_ATTR 1 #else # define OCTAVE_FORMAT_PRINTF(index, first) /* # undef HAVE_OCTAVE_FORMAT_PRINTF_ATTR */ #endif #if ! defined (OCTAVE_FALLTHROUGH) # if defined (__cplusplus) && __cplusplus > 201402L # define OCTAVE_FALLTHROUGH [[fallthrough]] # elif defined (__GNUC__) && __GNUC__ < 7 # define OCTAVE_FALLTHROUGH ((void) 0) # else # define OCTAVE_FALLTHROUGH __attribute__ ((__fallthrough__)) # endif #endif #if defined (__cplusplus) template <typename T> static inline void octave_unused_parameter (const T&) { } #else # define octave_unused_parameter(param) (void) param; #endif #if defined (OCTAVE_ENABLE_LIB_VISIBILITY_FLAGS) # if defined (_WIN32) || defined (__CYGWIN__) # if defined (__GNUC__) /* GCC */ # define OCTAVE_EXPORT __attribute__ ((dllexport)) # define OCTAVE_IMPORT __attribute__ ((dllimport)) # else /* MSVC */ # define OCTAVE_EXPORT __declspec(dllexport) # define OCTAVE_IMPORT __declspec(dllimport) # endif # else /* All other platforms. */ # define OCTAVE_EXPORT __attribute__ ((visibility ("default"))) # define OCTAVE_IMPORT # endif #else # define OCTAVE_EXPORT # define OCTAVE_IMPORT #endif /* API macro for liboctave */ #if defined (OCTAVE_DLL) # define OCTAVE_API OCTAVE_EXPORT #else # define OCTAVE_API OCTAVE_IMPORT #endif /* API macro for liboctinterp */ #if defined (OCTINTERP_DLL) # define OCTINTERP_API OCTAVE_EXPORT #else # define OCTINTERP_API OCTAVE_IMPORT #endif /* API macro for the Array class in liboctave and liboctinterp */ #if (defined (OCTAVE_DLL) || defined (OCTINTERP_DLL)) # define OCTARRAY_API OCTAVE_EXPORT #else # define OCTARRAY_API OCTAVE_IMPORT #endif /* API macro for libinterp/graphics */ #if defined (OCTGRAPHICS_DLL) # define OCTGRAPHICS_API OCTAVE_EXPORT #else # define OCTGRAPHICS_API OCTAVE_IMPORT #endif /* API macro for libgui */ #if defined (OCTGUI_DLL) # define OCTGUI_API OCTAVE_EXPORT #else # define OCTGUI_API OCTAVE_IMPORT #endif #if defined (OCTAVE_ENABLE_64) # define OCTAVE_IDX_TYPE_FORMAT PRId64 #else # define OCTAVE_IDX_TYPE_FORMAT PRId32 #endif #if OCTAVE_SIZEOF_F77_INT_TYPE == 8 # define OCTAVE_F77_INT_TYPE_FORMAT PRId64 #else # define OCTAVE_F77_INT_TYPE_FORMAT PRId32 #endif #define OCTAVE_HAVE_F77_INT_TYPE 1 /* time type in API is always 64 bits wide */ #define OCTAVE_TIME_T int64_t #if defined (__cplusplus) && ! defined (OCTAVE_THREAD_LOCAL) # define OCTAVE_THREAD_LOCAL #endif typedef OCTAVE_IDX_TYPE octave_idx_type; typedef OCTAVE_F77_INT_TYPE octave_f77_int_type; /* Backward compatibility */ #if defined (OCTAVE_ENABLE_64) # define USE_64_BIT_IDX_T 1 #endif #if defined (OCTAVE_ENABLE_OPENMP) # define HAVE_OPENMP 1 #endif #if defined (OCTAVE_ENABLE_FLOAT_TRUNCATE) # define OCTAVE_FLOAT_TRUNCATE volatile #else # define OCTAVE_FLOAT_TRUNCATE #endif