1%define OT_ComplexMatrix_doc
2"Complex Matrix.
3
4Available constructors:
5    ComplexMatrix(*nr, nc*)
6
7    ComplexMatrix(*nr, nc, values*)
8
9Parameters
10----------
11nr : integer
12    The number of rows of the complex matrix.
13nc : integer
14    The number of columns of the complex matrix.
15values : sequence of complex number
16    The sequence must have :math:`n_r \times n_c` elements. It might be a
17    :class:`~openturns.ComplexCollection` or a :class:`~openturns.ScalarCollection`. Default is (0, 0).
18
19See also
20--------
21ComplexTensor
22
23Examples
24--------
25>>> import openturns as ot
26>>> m = ot.ComplexMatrix(2, 2, [1+2j, 3+4j , 5+6j, 7+8j])
27>>> print(m)
28[[ (1,2) (5,6) ]
29 [ (3,4) (7,8) ]]
30>>> m = ot.ComplexMatrix(2, 3, range(2*3))
31>>> print(m)
32[[ (0,0) (2,0) (4,0) ]
33 [ (1,0) (3,0) (5,0) ]]
34
35Create a matrix from a numpy array:
36
37>>> import numpy as np
38>>> array = np.array([[1, 2], [3, 4], [5, 6]])
39>>> m = ot.ComplexMatrix(array)
40>>> print(m)
41[[ (1,0) (2,0) ]
42 [ (3,0) (4,0) ]
43 [ (5,0) (6,0) ]]
44"
45%enddef
46%feature("docstring") OT::ComplexMatrixImplementation
47OT_ComplexMatrix_doc
48
49// ---------------------------------------------------------------------
50
51%define OT_ComplexMatrix_clean_doc
52"Clean the matrix according to a specific threshold.
53
54Parameters
55----------
56threshold : positive float
57    Numerical sample which is the collection of points stored by the history
58    strategy."
59%enddef
60%feature("docstring") OT::ComplexMatrixImplementation::clean
61OT_ComplexMatrix_clean_doc
62
63// ---------------------------------------------------------------------
64
65%define OT_ComplexMatrix_conjugate_doc
66"Accessor to the conjugate complex matrix.
67
68Returns
69-------
70N : :class:`~openturns.ComplexMatrix`
71    The conjugate matrix :math:`\mat{N}` of size :math:`n_r \times n_c`
72    associated with the given complex matrix :math:`\mat{M}` such as
73    :math:`N_{i, j} = \overline{M}_{i, j}`."
74%enddef
75%feature("docstring") OT::ComplexMatrixImplementation::conjugate
76OT_ComplexMatrix_conjugate_doc
77
78// ---------------------------------------------------------------------
79
80%define OT_ComplexMatrix_conjugateTranspose_doc
81"Accessor to the transposed conjugate complex matrix.
82
83Returns
84-------
85N : :class:`~openturns.ComplexMatrix`
86    The transposed conjugate matrix :math:`\mat{N}` of size :math:`n_c \times n_r`
87    associated with the given complex matrix :math:`\mat{M}` such as
88    :math:`N_{i, j} = \overline{M}_{j, i}`."
89%enddef
90%feature("docstring") OT::ComplexMatrixImplementation::conjugateTranspose
91OT_ComplexMatrix_conjugateTranspose_doc
92
93// ---------------------------------------------------------------------
94
95%define OT_ComplexMatrix_getNbColumns_doc
96"Accessor to the number of columns.
97
98Returns
99-------
100nc : integer
101    The number of columns of :math:`\mat{M}`."
102%enddef
103%feature("docstring") OT::ComplexMatrixImplementation::getNbColumns
104OT_ComplexMatrix_getNbColumns_doc
105
106// ---------------------------------------------------------------------
107
108%define OT_ComplexMatrix_getNbRows_doc
109"Accessor to the number of rows.
110
111Returns
112-------
113nr : integer
114    The number of rows of :math:`\mat{M}`."
115%enddef
116%feature("docstring") OT::ComplexMatrixImplementation::getNbRows
117OT_ComplexMatrix_getNbRows_doc
118
119// ---------------------------------------------------------------------
120
121%define OT_ComplexMatrix_imag_doc
122"Accessor to the imaginary part.
123
124Returns
125-------
126imat : :class:`~openturns.Matrix`
127    A real matix :math:`\mat{A}` of size :math:`n_r \times n_c` such
128    :math:`A_{i, j} = \mathrm{Im} (M_{i, j})`."
129%enddef
130%feature("docstring") OT::ComplexMatrixImplementation::imag
131OT_ComplexMatrix_imag_doc
132
133// ---------------------------------------------------------------------
134
135%define OT_ComplexMatrix_isEmpty_doc
136"Test whether the matrix is empty or not.
137
138Returns
139-------
140isEmpty : bool
141    Flag telling whether the dimensions of the matrix is zero."
142%enddef
143%feature("docstring") OT::ComplexMatrixImplementation::isEmpty
144OT_ComplexMatrix_isEmpty_doc
145
146// ---------------------------------------------------------------------
147
148%define OT_ComplexMatrix_real_doc
149"Accessor to the real part.
150
151Returns
152-------
153rmat : :class:`~openturns.Matrix`
154    A real matix :math:`\mat{A}` of size :math:`n_r \times n_c` such
155    :math:`A_{i, j} = \mathrm{Re} (M_{i, j})`."
156%enddef
157%feature("docstring") OT::ComplexMatrixImplementation::real
158OT_ComplexMatrix_real_doc
159
160// ---------------------------------------------------------------------
161
162%define OT_ComplexMatrix_transpose_doc
163"Accessor to the transposed complex matrix.
164
165Returns
166-------
167N : :class:`~openturns.ComplexMatrix`
168    The transposed matrix :math:`\mat{N}` of size :math:`n_c \times n_r`
169    associated with the given complex matrix :math:`\mat{M}` such as
170    :math:`N_{i, j} = M_{j, i}`."
171%enddef
172%feature("docstring") OT::ComplexMatrixImplementation::transpose
173OT_ComplexMatrix_transpose_doc