diff src/DLD-FUNCTIONS/syl.cc @ 3372:f16c2ce14886

[project @ 1999-11-23 19:07:09 by jwe]
author jwe
date Tue, 23 Nov 1999 19:07:18 +0000
parents 38de16594cb4
children ab7fa5a8f23f
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/syl.cc	Sun Nov 21 17:31:10 1999 +0000
+++ b/src/DLD-FUNCTIONS/syl.cc	Tue Nov 23 19:07:18 1999 +0000
@@ -33,7 +33,31 @@
 #include "utils.h"
 
 DEFUN_DLD (syl, args, nargout,
-  "X = syl (A, B, C): solve the Sylvester equation A X + X B + C = 0")
+  "-*- texinfo -*-
+@deftypefn {Loadable Function} {@var{x} =} syl (@var{a}, @var{b}, @var{c})\n\
+Solve the Sylvester equation\n\
+@iftex\n\
+@tex\n\
+$$\n\
+ A X + X B + C = 0\n\
+$$\n\
+@end tex\n\
+@end iftex\n\
+@ifinfo\n\
+\n\
+@example\n\
+A X + X B + C = 0\n\
+@end example\n\
+@end ifinfo\n\
+using standard @sc{Lapack} subroutines.  For example,\n\
+\n\
+@example\n\
+@group\n\
+syl ([1, 2; 3, 4], [5, 6; 7, 8], [9, 10; 11, 12])\n\
+     @result{} [ -0.50000, -0.66667; -0.66667, -0.50000 ]\n\
+@end group\n\
+@end example\n\
+@end deftypefn")
 {
   octave_value_list retval;