diff scripts/general/common_size.m @ 3369:f37ca3017116

[project @ 1999-11-21 16:26:02 by jwe]
author jwe
date Sun, 21 Nov 1999 16:26:08 +0000
parents 1dca28c213f0
children f8dde1807dee
line wrap: on
line diff
--- a/scripts/general/common_size.m	Sat Nov 20 17:23:01 1999 +0000
+++ b/scripts/general/common_size.m	Sun Nov 21 16:26:08 1999 +0000
@@ -14,24 +14,27 @@
 ## along with this file.  If not, write to the Free Software Foundation,
 ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
-## usage:  [errorcode, y_1, ...] = common_size (x_1, ...)
-##
+## -*- texinfo -*-
+## @deftypefn {Function File} {[@var{err}, @var{y1}, ...] =} common_size (@var{x1}, ...)
 ## Determine if all input arguments are either scalar or of common
-## size.  In this case, errorcode is zero, and y_i is a matrix of the
-## common size with all entries equal to x_i if this is a scalar or
-## x_i otherwise.
-##
-## If the inputs cannot be brought to a common size, errorcode is 1, and
-## y_i is x_i.
-##
-## For example,
-##
-##   [errorcode, a, b] = common_size ([1 2; 3 4], 5)
-##
-## returns errorcode = 0, a = [1 2, 3 4], b = [5 5; 5 5].
-##
+## size.  If so, @var{err} is zero, and @var{yi} is a matrix of the
+## common size with all entries equal to @var{xi} if this is a scalar or
+## @var{xi} otherwise.  If the inputs cannot be brought to a common size,
+## errorcode is 1, and @var{yi} is @var{xi}.  For example,
+## 
+## @example
+## @group
+## [errorcode, a, b] = common_size ([1 2; 3 4], 5)
+##      @result{} errorcode = 0
+##      @result{} a = [ 1, 2; 3, 4 ]
+##      @result{} b = [ 5, 5; 5, 5 ]
+## @end group
+## @end example
+## 
+## @noindent
 ## This is useful for implementing functions where arguments can either
 ## be scalars or of common size.
+## @end deftypefn
 
 ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
 ## Created: 15 October 1994