Skip to content

Commit 207a1a6

Browse files
committed
Add docstring
1 parent 08102a2 commit 207a1a6

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs/src/reference/standard_form.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ List of recognized matrix sets.
141141
```@docs
142142
PositiveSemidefiniteConeTriangle
143143
PositiveSemidefiniteConeSquare
144+
HermitianPositiveSemidefiniteConeTriangle
144145
LogDetConeTriangle
145146
LogDetConeSquare
146147
RootDetConeTriangle

src/sets.jl

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -795,6 +795,33 @@ function triangular_form(::Type{PositiveSemidefiniteConeSquare})
795795
return PositiveSemidefiniteConeTriangle
796796
end
797797

798+
"""
799+
HermitianPositiveSemidefiniteConeTriangle(side_dimension) <: AbstractVectorSet
800+
801+
The (vectorized) cone of hermitian positive semidefinite matrices, with
802+
`side_dimension` rows and columns.
803+
804+
As the matrix is hermitian, the diagonal is real and the lower triangular
805+
entries are obtained as the conjugate of corresponding upper triangular entries.
806+
The vectorized form starts with real part of the entries of the upper-right
807+
triangular part of the matrix given column by column as explained in
808+
[`AbstractSymmetricMatrixSetSquare`](@ref).
809+
It is then followed by the imaginary part of the off-diagonal entries of the
810+
upper-right triangular part given column by column.
811+
812+
813+
### Examples
814+
815+
The matrix
816+
```math
817+
\\begin{bmatrix}
818+
1 & 2 + 7im & 4 + 8im\\\\
819+
2 - 7im & 3 & 5 + 9im\\\\
820+
4 - 8im & 5 - 9im & 6
821+
\\end{bmatrix}
822+
```
823+
has [`side_dimension`](@ref) 3 and vectorization ``(1, 2, 3, 4, 5, 6, 7, 8, 9)``.
824+
"""
798825
struct HermitianPositiveSemidefiniteConeTriangle <: AbstractVectorSet
799826
side_dimension::Int
800827
end

0 commit comments

Comments
 (0)