Skip to content

Commit 279f493

Browse files
committed
share docs of fusion and braiding style
1 parent c62a280 commit 279f493

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/sectors.jl

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,10 @@ struct SimpleFusion <: MultipleFusion end # multiple fusion but multiplicity fre
295295
struct GenericFusion <: MultipleFusion end # multiple fusion with multiplicities
296296
const MultiplicityFreeFusion = Union{UniqueFusion, SimpleFusion}
297297

298+
@doc (@doc FusionStyle) UniqueFusion
299+
@doc (@doc FusionStyle) SimpleFusion
300+
@doc (@doc FusionStyle) GenericFusion
301+
298302
# combine fusion properties of tensor products of sectors
299303
Base.:&(f::F, ::F) where {F <: FusionStyle} = f
300304
Base.:&(f₁::FusionStyle, f₂::FusionStyle) = f₂ & f₁
@@ -320,6 +324,9 @@ UnitStyle(a::Sector) = UnitStyle(typeof(a))
320324
struct SimpleUnit <: UnitStyle end
321325
struct GenericUnit <: UnitStyle end
322326

327+
@doc (@doc UnitStyle) SimpleUnit
328+
@doc (@doc UnitStyle) GenericUnit
329+
323330
UnitStyle(::Type{I}) where {I <: Sector} = length(allunits(I)) == 1 ? SimpleUnit() : GenericUnit()
324331

325332
@noinline function throw_genericunit_error(I)
@@ -452,6 +459,7 @@ end
452459
BraidingStyle(I::Type{<:Sector}) -> ::BraidingStyle
453460
454461
Return the type of braiding and twist behavior of sectors of type `I`, which can be either
462+
* `NoBraiding()`: no braiding structure
455463
* `Bosonic()`: symmetric braiding with trivial twist (i.e. identity)
456464
* `Fermionic()`: symmetric braiding with non-trivial twist (squares to identity)
457465
* `Anyonic()`: general ``R^{ab}_c`` phase or matrix (depending on `SimpleFusion` or
@@ -471,6 +479,11 @@ struct Bosonic <: SymmetricBraiding end # all twists are one
471479
struct Fermionic <: SymmetricBraiding end # twists one and minus one
472480
struct Anyonic <: HasBraiding end
473481

482+
@doc (@doc BraidingStyle) NoBraiding
483+
@doc (@doc BraidingStyle) Bosonic
484+
@doc (@doc BraidingStyle) Fermionic
485+
@doc (@doc BraidingStyle) Anyonic
486+
474487
Base.:&(b::B, ::B) where {B <: BraidingStyle} = b
475488
Base.:&(B1::BraidingStyle, B2::BraidingStyle) = B2 & B1
476489
Base.:&(::Bosonic, ::Fermionic) = Fermionic()

0 commit comments

Comments
 (0)