Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
joachimbrand committed Jan 10, 2024
1 parent c61c791 commit 8c81abf
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/src/addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ straightforward to implement efficient Hamiltonians. Examples are:

```@autodocs
Modules = [BitStringAddresses]
Pages = ["fockaddress.jl","bosefs.jl","fermifs.jl","multicomponent.jl","onrfs.jl"]
Pages = ["fockaddress.jl","bosefs.jl","fermifs.jl","multicomponent.jl","occupationnumberfs.jl"]
Private = false
```

Expand All @@ -34,6 +34,10 @@ The atomic addresses, [`BoseFS`](@ref) and [`FermiFS`](@ref), are implemented as
bitstrings or sorted lists of particles. Using these approaches over an occupation number
representation makes the addresses much more space-efficient.

Therewhile [`OccupationNumberFS`](@ref) internally uses the occupation number representation,
which allows it to handle excitation operations that change the particle number. This is fast
but requires more storage space.

### Internal APIs

```@autodocs
Expand Down

0 comments on commit 8c81abf

Please sign in to comment.