[Getfem-commits] r4842 - /trunk/getfem/doc/sphinx/source/userdoc/gasm_high.rst

[Yves . Renard]

Author: renard
Date: Fri Jan 23 08:56:31 2015
New Revision: 4842

URL: http://svn.gna.org/viewcvs/getfem?rev=4842&view=rev
Log:
adding small documentation for expm, logm and Normalized operators*

Modified:
    trunk/getfem/doc/sphinx/source/userdoc/gasm_high.rst

Modified: trunk/getfem/doc/sphinx/source/userdoc/gasm_high.rst
URL: 
http://svn.gna.org/viewcvs/getfem/trunk/getfem/doc/sphinx/source/userdoc/gasm_high.rst?rev=4842&r1=4841&r2=4842&view=diff
==============================================================================
--- trunk/getfem/doc/sphinx/source/userdoc/gasm_high.rst        (original)
+++ trunk/getfem/doc/sphinx/source/userdoc/gasm_high.rst        Fri Jan 23 
08:56:31 2015
@@ -553,9 +553,15 @@
 
   - ``Norm_sqr(v)`` for ``v`` a vector or a matrix gives the square of the 
euclidean norm of a vector or of the |Frobenius| norm of a matrix. For a vector 
this is equivalent to ``v.v`` and for a matrix to ``m:m``.
 
+  - ``Normalized(v)`` for ``v`` a vector or a matrix gives ``v`` divided by 
its euclidean (for vectors) or frobenius (for matrices) norm.
+
   - ``Det(m)`` gives the determinant of a square matrix ``m``.
 
   - ``Inv(m)`` gives the inverse of a square matrix ``m``. The second 
derivative is not available since it is an order 6 tensor. This means that 
``Inv(m)`` cannot be used in the description of a potential energy.
+
+  - ``expm(m)`` gives the exponential of a square matrix ``m``.
+
+  - ``Logm(m)`` gives the logarithm of a square matrix ``m``.
 
   - ``Matrix_I2(m)`` gives the second invariants of a square matrix ``m`` 
which is defined by ``(sqr(Trace(m)) - Trace(m*m))/2``.