[Octave-cvsupdate] SF.net SVN: octave:[9162] trunk/octave-forge/extra/quaternion_oo

[<par...@us...>]

Revision: 9162
          http://octave.svn.sourceforge.net/octave/?rev=9162&view=rev
Author:   paramaniac
Date:     2011-11-21 10:53:02 +0000 (Mon, 21 Nov 2011)
Log Message:
-----------
quaternion_oo: add example to docstring

Modified Paths:
--------------
    trunk/octave-forge/extra/quaternion_oo/inst/@quaternion/quaternion.m

Added Paths:
-----------
    trunk/octave-forge/extra/quaternion_oo/devel/q_2x3.m

Added: trunk/octave-forge/extra/quaternion_oo/devel/q_2x3.m
===================================================================
--- trunk/octave-forge/extra/quaternion_oo/devel/q_2x3.m	                        (rev 0)
+++ trunk/octave-forge/extra/quaternion_oo/devel/q_2x3.m	2011-11-21 10:53:02 UTC (rev 9162)
@@ -0,0 +1,10 @@
+w = [2, 6, 10; 14, 18, 22];
+
+x = [3, 7, 11; 15, 19, 23];
+
+y = [4, 8, 12; 16, 20, 24];
+
+z = [5, 9, 13; 17, 21, 25];
+
+q = quaternion (w, x, y, z)
+

Modified: trunk/octave-forge/extra/quaternion_oo/inst/@quaternion/quaternion.m
===================================================================
--- trunk/octave-forge/extra/quaternion_oo/inst/@quaternion/quaternion.m	2011-11-21 01:27:28 UTC (rev 9161)
+++ trunk/octave-forge/extra/quaternion_oo/inst/@quaternion/quaternion.m	2011-11-21 10:53:02 UTC (rev 9162)
@@ -24,7 +24,51 @@
 ## @end example
 ##
 ## Arguments @var{w}, @var{x}, @var{y} and @var{z} can be scalars or
-## matrices, but they must be real and of equal size.
+## matrices, but they must be real and of equal size.  If scalar part
+## @var{w} or components @var{x}, @var{y} and @var{z} of the vector
+## part are not specified, zero matrices of appropriate size are
+## assumed.
+##
+## @strong{Example}
+## @example
+## @group
+## octave:1> q = quaternion (2)
+## q = 2 + 0i + 0j + 0k
+## 
+## octave:2> q = quaternion (3, 4, 5)
+## q = 0 + 3i + 4j + 5k
+## 
+## octave:3> q = quaternion (2, 3, 4, 5)
+## q = 2 + 3i + 4j + 5k
+## @end group
+## @end example
+## @example
+## @group
+## octave:4> w = [2, 6, 10; 14, 18, 22];
+## octave:5> x = [3, 7, 11; 15, 19, 23];
+## octave:6> y = [4, 8, 12; 16, 20, 24];
+## octave:7> z = [5, 9, 13; 17, 21, 25];
+## octave:8> q = quaternion (w, x, y, z)
+## q.w =
+##     2    6   10
+##    14   18   22
+## 
+## q.x =
+##     3    7   11
+##    15   19   23
+## 
+## q.y =
+##     4    8   12
+##    16   20   24
+## 
+## q.z =
+##     5    9   13
+##    17   21   25
+## 
+## octave:9> 
+## @end group
+## @end example
+##
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.