/usr/include/openturns/swig/HermitianMatrix_doc.i is in libopenturns-dev 1.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | %feature("docstring") OT::HermitianMatrix
"Hermitian Matrix.
Available constructors:
HermitianMatrix(*dim*)
Parameters
----------
dim : integer
The dimension of the Hermitian matrix (square matrix with *dim* rows and
*dim* columns).
See also
--------
ComplexMatrix
Notes
-----
The Hermitian matrix is filled with :math:`(0, 0)`. It is not possible to fill
the matrix from a collection of complex values (to be done later)."
// ---------------------------------------------------------------------
%feature("docstring") OT::HermitianMatrix::computeCholesky
"Compute the Cholesky factor.
Returns
-------
G : :class:`~openturns.ComplexMatrix`
The Cholesky factor :math:`\\\\mat{G}`, i.e. the complex matrix such as
:math:`\\\\mat{G} \\\\times \\\\Tr{\\\\mat{G}}` is the initial matrix."
// ---------------------------------------------------------------------
%feature("docstring") OT::HermitianMatrix::getDimension
"Accessor to the matrix dimension.
Returns
-------
dim : integer
The dimension of the Hermitian matrix."
|