Skip to content

Commit e045378

Browse files
borisdevoslkdvos
andauthored
add docstring for fusiontensor (#48)
* add docstring for `fusiontensor` * move docstring and make generic * code suggestions * Restrict docstring to `Sector` --------- Co-authored-by: Lukas Devos <[email protected]>
1 parent 6f8ab3e commit e045378

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/sectors.jl

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,15 @@ Base.:&(f₁::UnitStyle, f₂::UnitStyle) = f₂ & f₁
349349

350350
Base.:&(::GenericUnit, ::SimpleUnit) = GenericUnit()
351351

352+
@doc """
353+
fusiontensor(a::I, b::I, c::I) where {I <: Sector} -> AbstractArray{T, 4}
354+
355+
Return the fusion tensor for the fusion `a ⊗ b -> c`. The dimensions of the returned array
356+
are `(dim(a), dim(b), dim(c), Nsymbol(a, b, c))`. The components of the fusion tensor are
357+
simply the Clebsch-Gordan coefficients, describing the unitary basis change from the tensor
358+
product of irreps `a` and `b` to the coupled irrep `c`.
359+
""" fusiontensor(::I, ::I, ::I) where {I <: Sector}
360+
352361
"""
353362
Fsymbol(a::I, b::I, c::I, d::I, e::I, f::I) where {I <: Sector}
354363

0 commit comments

Comments
 (0)