--- Begin Message ---
- To: Debian Bug Tracking System <maintonly@bugs.debian.org>
- Subject: octave-forge: help of leasqr need improvements
- From: Francesco Potorti` <Potorti@isti.cnr.it>
- Date: Mon, 16 Oct 2006 17:49:45 +0200
- Message-id: <E1GZUin-0003kU-1e@tucano.isti.cnr.it>
Package: octave-forge
Version: 2006.07.09+dfsg1-2
Severity: minor
I suggest these improvements to the leasqr help test, which make the
text more consistent and readable and add some information.
--- leasqr.m~ 2006-10-16 17:28:25.000000000 +0200
+++ leasqr.m 2006-10-16 17:48:43.000000000 +0200
@@ -22,24 +22,30 @@ function [f,p,kvg,iter,corp,covp,covr,st
% Levenberg-Marquardt nonlinear regression of f(x,p) to y(x).
%
% Version 3.beta
-% {}= optional parameters
-% x=vec or mat of indep variables, 1 row/observation: x=[x0 x1....xm]
-% y=vec of obs values, same no. of rows as x.
-% wt=vec(dim=length(x)) of statistical weights. These should be set
-% to be proportional to (sqrt of var(y))^-1; (That is, the covariance
-% matrix of the data is assumed to be proportional to diagonal with diagonal
-% equal to (wt.^2)^-1. The constant of proportionality will be estimated.),
-% default=ones(length(y),1).
-% pin=vector of initial parameters to be adjusted by leasqr.
-% dp=fractional incr of p for numerical partials,default= .001*ones(size(pin))
-% dp(j)>0 means central differences.
-% dp(j)<0 means one-sided differences.
-% Note: dp(j)=0 holds p(j) fixed i.e. leasqr wont change initial guess: pin(j)
-% F=name of function in quotes,of the form y=f(x,p)
-% dFdp=name of partials M-file in quotes default is prt=dfdp(x,f,p,dp,F)
-% stol=scalar tolerances on fractional improvement in ss,default stol=.0001
-% niter=scalar max no. of iterations, default = 20
-% options=matrix of n rows (same number of rows as pin) containing
+% Optional parameters are in braces {}.
+% x = column vector or matrix of independent variables, 1 row per
+% observation: x = [x0 x1....xm].
+% y = column vector of observed values, same number of rows as x.
+% wt = column vector (dim=length(x)) of statistical weights. These
+% should be set to be proportional to (sqrt of var(y))^-1; (That is,
+% the covariance matrix of the data is assumed to be proportional to
+% diagonal with diagonal equal to (wt.^2)^-1. The constant of
+% proportionality will be estimated.); default = ones(length(y),1).
+% pin = column vec of initial parameters to be adjusted by leasqr.
+% dp = fractional increment of p for numerical partial derivatives;
+% default = .001*ones(size(pin))
+% dp(j) > 0 means central differences on j-th parameter p(j).
+% dp(j) < 0 means one-sided differences on j-th parameter p(j).
+% dp(j) = 0 holds p(j) fixed i.e. leasqr wont change initial guess: pin(j)
+% F = name of function in quotes; the function shall be of the form y=f(x,p),
+% with y, x, p of the form y, x, pin as described above.
+% dFdp = name of partial derivative function in quotes; default is "dfdp", a
+% slow but general partial derivatives function; the function shall be
+% of the form prt=dfdp(x,f,p,dp,F) (see dfdp.m).
+% stol = scalar tolerance on fractional improvement in scalar sum of
+% squares = sum((wt.*(y-f))^2); default stol = .0001;
+% niter = scalar maximum number of iterations; default = 20;
+% options = matrix of n rows (same number of rows as pin) containing
% column 1: desired fractional precision in parameter estimates.
% Iterations are terminated if change in parameter vector (chg) on two
% consecutive iterations is less than their corresponding elements
@@ -52,16 +58,16 @@ function [f,p,kvg,iter,corp,covp,covr,st
% default = Inf*ones().
%
% OUTPUT VARIABLES
-% f=vec function values computed in function func.
-% p=vec trial or final parameters. i.e, the solution.
-% kvg=scalar: =1 if convergence, =0 otherwise.
-% iter=scalar no. of interations used.
-% corp= correlation matrix for parameters
-% covp= covariance matrix of the parameters
-% covr = diag(covariance matrix of the residuals)
-% stdresid= standardized residuals
-% Z= matrix that defines confidence region
-% r2= coefficient of multiple determination
+% f = column vector of values computed: f = F(x,p).
+% p = column vector trial or final parameters. i.e, the solution.
+% kvg = scalar: = 1 if convergence, = 0 otherwise.
+% iter = scalar number of iterations used.
+% corp = correlation matrix for parameters.
+% covp = covariance matrix of the parameters.
+% covr = diag(covariance matrix of the residuals).
+% stdresid = standardized residuals.
+% Z = matrix that defines confidence region (see comments in the source).
+% r2 = coefficient of multiple determination.
%
% All Zero guesses not acceptable
@@ -113,7 +119,7 @@ function [f,p,kvg,iter,corp,covp,covr,st
% 8) Change to more efficent algorithm of Bard for selecting epsL.
% 9) Tighten up memory usage by making use of sparse matrices (if
% MATLAB version >= 4.0) in computation of covp, corp, stdresid.
-% Modified by Francesco Potorti
+% Modified by Francesco Potortì
% for use in Octave
%
% References:
-- System Information:
Debian Release: testing/unstable
APT prefers testing
APT policy: (990, 'testing'), (500, 'testing-proposed-updates')
Architecture: amd64 (x86_64)
Shell: /bin/sh linked to /bin/bash
Kernel: Linux 2.6.15-1-amd64-k8-smp
Locale: LANG=C, LC_CTYPE=it_IT@euro (charmap=ANSI_X3.4-1968) (ignored: LC_ALL set to C)
Versions of packages octave-forge depends on:
ii octave2.1-forge 2006.03.17+dfsg1-1 Contributed functions from the GNU
octave-forge recommends no packages.
-- no debconf information
--- End Message ---
--- Begin Message ---
- To: 393495-close@bugs.debian.org
- Subject: Bug#393495: fixed in octave2.9-forge 2006.07.09+dfsg1-5
- From: Rafael Laboissiere <rafael@debian.org>
- Date: Mon, 18 Dec 2006 22:47:03 +0000
- Message-id: <E1GwRGB-0008UX-4p@ries.debian.org>
Source: octave2.9-forge
Source-Version: 2006.07.09+dfsg1-5
We believe that the bug you reported is fixed in the latest version of
octave2.9-forge, which is due to be installed in the Debian FTP archive:
octave-forge_2006.07.09+dfsg1-5_all.deb
to pool/main/o/octave2.9-forge/octave-forge_2006.07.09+dfsg1-5_all.deb
octave2.9-forge_2006.07.09+dfsg1-5.diff.gz
to pool/main/o/octave2.9-forge/octave2.9-forge_2006.07.09+dfsg1-5.diff.gz
octave2.9-forge_2006.07.09+dfsg1-5.dsc
to pool/main/o/octave2.9-forge/octave2.9-forge_2006.07.09+dfsg1-5.dsc
octave2.9-forge_2006.07.09+dfsg1-5_i386.deb
to pool/main/o/octave2.9-forge/octave2.9-forge_2006.07.09+dfsg1-5_i386.deb
A summary of the changes between this version and the previous one is
attached.
Thank you for reporting the bug, which will now be closed. If you
have further comments please address them to 393495@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.
Debian distribution maintenance software
pp.
Rafael Laboissiere <rafael@debian.org> (supplier of updated octave2.9-forge package)
(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@debian.org)
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Format: 1.7
Date: Mon, 18 Dec 2006 23:11:24 +0100
Source: octave2.9-forge
Binary: octave-forge octave2.9-forge
Architecture: source i386 all
Version: 2006.07.09+dfsg1-5
Distribution: unstable
Urgency: low
Maintainer: Debian Octave Group <pkg-octave-devel@lists.alioth.debian.org>
Changed-By: Rafael Laboissiere <rafael@debian.org>
Description:
octave-forge - Contributed functions for GNU Octave (2.1 branch)
octave2.9-forge - Contributed functions from the GNU Octave Repository
Closes: 393495 403653
Changes:
octave2.9-forge (2006.07.09+dfsg1-5) unstable; urgency=low
.
* debian/patches/50-leasqr-doc.patch: Improved documentation for leasqr.
Thanks to Francesco Potortì for the patch, which has also been applied
upstream (closes: #393495).
* debian/patches/50-imagepath.patch: In imread.m, use IMAGE_PATH instead
of IMAGEPATH, which is the right name of the internal variable in
Octave 2.9 (closes: #403653, thanks to Tobias Eberle for the heads up)
Files:
21531c88211d758af5621abea8a7b9f8 1052 math optional octave2.9-forge_2006.07.09+dfsg1-5.dsc
05dc7454ee5353c277bbfcb3f85878f1 23077 math optional octave2.9-forge_2006.07.09+dfsg1-5.diff.gz
19c1ee3fa1243b98ba0c349f3074ceff 115956 math optional octave-forge_2006.07.09+dfsg1-5_all.deb
2895c19956152b9e3eab5b6514aac807 2593250 math optional octave2.9-forge_2006.07.09+dfsg1-5_i386.deb
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.5 (GNU/Linux)
iD8DBQFFhxitk3oga0pdcv4RAqLjAJ9huH/2Xe1jFObN2o1krE5ghrj7ugCgjZyD
rqhxJXfk/dRzTr7peqhug8g=
=WNxs
-----END PGP SIGNATURE-----
--- End Message ---