Skip to content

Docstring out of date for fermionic x_min_x_plus operators #17

@Yue-Zhengyuan

Description

@Yue-Zhengyuan

@doc """
u_min_u_plus(elt::Type{<:Number}, particle_symmetry::Type{<:Sector}, spin_symmetry::Type{<:Sector}; slave_fermion::Bool = false)
u⁻u⁺(elt::Type{<:Number}, particle_symmetry::Type{<:Sector}, spin_symmetry::Type{<:Sector}; slave_fermion::Bool = false)
Return the Hermitian conjugate of `u_plus_u_min`, i.e.
``(e†_{1,↑}, e_{2,↑})† = -e_{1,↑}, e†_{2,↑}`` (note the extra minus sign).
It annihilates a spin-up electron at the first site and creates a spin-up electron at the second.
The only nonzero matrix element corresponds to `|0↑⟩ <-- |↑0⟩`.
""" u_min_u_plus
function u_min_u_plus(P::Type{<:Sector}, S::Type{<:Sector}; slave_fermion::Bool=false)
return u_min_u_plus(ComplexF64, P, S; slave_fermion)
end
function u_min_u_plus(elt::Type{<:Number}, particle_symmetry::Type{<:Sector},
spin_symmetry::Type{<:Sector};
slave_fermion::Bool=false)
return -copy(adjoint(u_plus_u_min(elt, particle_symmetry, spin_symmetry; slave_fermion)))
end
const u⁻u⁺ = u_min_u_plus

I see that in #15 u_min_u_plus is defined as minus the adjoint of u_plus_u_min. But you forgot to change docstrings. For example, in the above case, we should say

Return `e_{1,↑}, e†_{2,↑}`, which is the negative of the Hermitian conjugate of `u_plus_u_min`.

This docstring update should also be made in several places, including tjoperators.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions