Mercurial > octave
view scripts/ode/odeplot.m @ 27918:b442ec6dda5c
use centralized file for copyright info for individual contributors
* COPYRIGHT.md: New file.
* In most other files, use "Copyright (C) YYYY-YYYY The Octave Project
Developers" instead of tracking individual names in separate source
files. The motivation is to reduce the effort required to update the
notices each year.
Until now, the Octave source files contained copyright notices that
list individual contributors. I adopted these file-scope copyright
notices because that is what everyone was doing 30 years ago in the
days before distributed version control systems. But now, with many
contributors and modern version control systems, having these
file-scope copyright notices causes trouble when we update copyright
years or refactor code.
Over time, the file-scope copyright notices may become outdated as new
contributions are made or code is moved from one file to
another. Sometimes people contribute significant patches but do not
add a line claiming copyright. Other times, people add a copyright
notice for their contribution but then a later refactoring moves part
or all of their contribution to another file and the notice is not
moved with the code. As a practical matter, moving such notices is
difficult -- determining what parts are due to a particular
contributor requires a time-consuming search through the project
history. Even managing the yearly update of copyright years is
problematic. We have some contributors who are no longer
living. Should we update the copyright dates for their contributions
when we release new versions? Probably not, but we do still want to
claim copyright for the project as a whole.
To minimize the difficulty of maintaining the copyright notices, I
would like to change Octave's sources to use what is described here:
https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html
in the section "Maintaining centralized copyright notices":
The centralized notice approach consolidates all copyright
notices in a single location, usually a top-level file.
This file should contain all of the copyright notices
provided project contributors, unless the contribution was
clearly insignificant. It may also credit -- without a copyright
notice -- anyone who helped with the project but did not
contribute code or other copyrighted material.
This approach captures less information about contributions
within individual files, recognizing that the DVCS is better
equipped to record those details. As we mentioned before, it
does have one disadvantage as compared to the file-scope
approach: if a single file is separated from the distribution,
the recipient won't see the contributors' copyright notices.
But this can be easily remedied by including a single
copyright notice in each file's header, pointing to the
top-level file:
Copyright YYYY-YYYY The Octave Project Developers
See the COPYRIGHT file at the top-level directory
of this distribution or at https://octave.org/COPYRIGHT.html.
followed by the usual GPL copyright statement.
For more background, see the discussion here:
https://lists.gnu.org/archive/html/octave-maintainers/2020-01/msg00009.html
Most files in the following directories have been skipped intentinally
in this changeset:
doc
libgui/qterminal
liboctave/external
m4
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 06 Jan 2020 15:38:17 -0500 |
parents | 00f796120a6d |
children | 1891570abac8 |
line wrap: on
line source
## Copyright (C) 2006-2019 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this distribution ## or <https://octave.org/COPYRIGHT.html/>. ## ## ## 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/>. ## Author: Thomas Treichl <treichl@users.sourceforge.net> ## -*- texinfo -*- ## @deftypefn {} {@var{stop_solve} =} odeplot (@var{t}, @var{y}, @var{flag}) ## ## Open a new figure window and plot the solution of an ode problem at each ## time step during the integration. ## ## The types and values of the input parameters @var{t} and @var{y} depend on ## the input @var{flag} that is of type string. Valid values of @var{flag} ## are: ## ## @table @option ## @item @qcode{"init"} ## The input @var{t} must be a column vector of length 2 with the first and ## last time step (@code{[@var{tfirst} @var{tlast}]}. The input @var{y} ## contains the initial conditions for the ode problem (@var{y0}). ## ## @item @qcode{""} ## The input @var{t} must be a scalar double specifying the time for which ## the solution in input @var{y} was calculated. ## ## @item @qcode{"done"} ## The inputs should be empty, but are ignored if they are present. ## @end table ## ## @code{odeplot} always returns false, i.e., don't stop the ode solver. ## ## Example: solve an anonymous implementation of the ## @nospell{@qcode{"Van der Pol"}} equation and display the results while ## solving. ## ## @example ## @group ## fvdp = @@(t,y) [y(2); (1 - y(1)^2) * y(2) - y(1)]; ## ## opt = odeset ("OutputFcn", @@odeplot, "RelTol", 1e-6); ## sol = ode45 (fvdp, [0 20], [2 0], opt); ## @end group ## @end example ## ## Background Information: ## This function is called by an ode solver function if it was specified in ## the @qcode{"OutputFcn"} property of an options structure created with ## @code{odeset}. The ode solver will initially call the function with the ## syntax @code{odeplot ([@var{tfirst}, @var{tlast}], @var{y0}, "init")}. The ## function initializes internal variables, creates a new figure window, and ## sets the x limits of the plot. Subsequently, at each time step during the ## integration the ode solver calls @code{odeplot (@var{t}, @var{y}, [])}. ## At the end of the solution the ode solver calls ## @code{odeplot ([], [], "done")} so that odeplot can perform any clean-up ## actions required. ## @seealso{odeset, odeget, ode23, ode45} ## @end deftypefn function stop_solve = odeplot (t, y, flag) ## No input argument checking is done for better performance persistent hlines num_lines told yold; ## odeplot never stops the integration stop_solve = false; if (isempty (flag)) ## Default case, plot and return a value told = [told; t(:)]; yold = [yold, y]; for i = 1:num_lines set (hlines(i), "xdata", told, "ydata", yold(i,:)); endfor drawnow; retval = false; elseif (strcmp (flag, "init")) ## t is either the time slot [tstart tstop] or [t0, t1, ..., tn] ## y is the initial value vector for the ode solution told = t(1); yold = y(:); figure (); hlines = plot (told, yold, "o-"); xlim ([t(1), t(end)]); # Fix limits which also speeds up plotting num_lines = numel (hlines); elseif (strcmp (flag, "done")) ## Cleanup after ode solver has finished. hlines = num_lines = told = yold = []; endif endfunction %!demo %! ## Solve an anonymous implementation of the Van der Pol equation %! ## and display the results while solving %! fvdp = @(t,y) [y(2); (1 - y(1)^2) * y(2) - y(1)]; %! opt = odeset ("OutputFcn", @odeplot, "RelTol", 1e-6); %! sol = ode45 (fvdp, [0 20], [2 0], opt);