/usr/include/openturns/swig/TriangularComplexMatrix_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 42 43 44 45 | %feature("docstring") OT::TriangularComplexMatrix
"Hermitian Matrix.
Available constructors:
TriangularComplexMatrix(*dim*)
TriangularComplexMatrix(*dim, isLower*)
Parameters
----------
dim : integer
The dimension of the triangular matrix (square matrix with *dim* rows and
*dim* columns).
isLower : bool
Flag telling if the matrix is triangular lower (*True*) or upper (*False*).
Default is *True*.
See also
--------
ComplexMatrix
Notes
-----
The triangular complex 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::TriangularComplexMatrix::isLowerTriangular
"Test whether the matrix is lower triangular or upper triangular.
Returns
-------
isLower : bool
Flag telling if the matrix is triangular lower (*True*) or upper (*False*)."
// ---------------------------------------------------------------------
%feature("docstring") OT::TriangularComplexMatrix::getDimension
"Accessor to the matrix dimension.
Returns
-------
dim : integer
The dimension of the matrix."
|