annotate scripts/deprecated/dmult.m @ 8874:bd1b1fe9c6e9 ss-3-1-53

bump version info for snapshot
author John W. Eaton <jwe@octave.org>
date Wed, 25 Feb 2009 18:35:47 -0500
parents 55d999c23728
children eb63fbe60fab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8826
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
1 ## Copyright (C) 1995, 1996, 1997, 1998, 2000, 2002, 2004, 2005, 2006,
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
2 ## 2007 Kurt Hornik
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
3 ##
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
4 ## This file is part of Octave.
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
5 ##
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
7 ## under the terms of the GNU General Public License as published by
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
9 ## your option) any later version.
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
10 ##
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
14 ## General Public License for more details.
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
15 ##
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
16 ## You should have received a copy of the GNU General Public License
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
18 ## <http://www.gnu.org/licenses/>.
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
19
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
20 ## -*- texinfo -*-
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
21 ## @deftypefn {Function File} {} dmult (@var{a}, @var{b})
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
22 ## This function has been deprecated. Use the direct syntax @code{diag(A)*B}
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
23 ## which is more readable and now also more efficient.
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
24 ## @end deftypefn
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
25
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
26 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
27 ## Description: Rescale the rows of a matrix
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
28
8827
55d999c23728 omission from last patch
Jaroslav Hajek <highegg@gmail.com>
parents: 8826
diff changeset
29 ## Deprecated in version 3.2
55d999c23728 omission from last patch
Jaroslav Hajek <highegg@gmail.com>
parents: 8826
diff changeset
30
8826
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
31 function M = dmult (a, B)
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
32
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
33 persistent warned = false;
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
34 if (! warned)
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
35 warned = true;
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
36 warning ("Octave:deprecated-function",
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
37 "dmult is obsolete and will be removed from a future version of Octave; please use the straightforward (and now efficient) syntax ""diag(A)*B"".");
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
38 endif
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
39
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
40 if (nargin != 2)
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
41 print_usage ();
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
42 endif
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
43 if (! isvector (a))
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
44 error ("dmult: a must be a vector of length rows (B)");
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
45 endif
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
46 a = a(:);
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
47 sb = size (B);
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
48 sb(1) = 1;
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
49 M = repmat (a(:), sb) .* B;
d49678a78fb9 make dmult deprecated
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
50 endfunction