ModeList(state)
ModeList(state,m)

Contrasting to ModeOccupation this list is of size n, the number of photons. Entry j is the index of the mode occupied by photon j.

This can also be used just to select modes for instance.

See also ModeOccupation.

fields:
    - n::Int
    - m::Union{Int, Nothing}
    - modes::Vector{Int}

ModeOccupation(state)

A list of the size of the number of modes m, with entry j of state being the number of photons in mode j. See also ModeList.

fields:
     - n::Int
     - m::Int
     - state::Vector{Int}

Partition(subsets::Vector{Subset})

Create a partition from multiple Subset.

PartitionOccupancy(counts::ModeOccupation, n::Int, partition::Partition)

Fields: - counts::ModeOccupation - partition::Partition - n::Int - m::Int

Subset(state::Vector{Int})

Create a mode occupation list with at most one count per mode.

Fields:
     - n::Int
     - m::Int
     - subset::Vector{Int}

mutable struct ThresholdModeOccupation

Holds threshold detector clicks. Example

ThresholdModeOccupation(ModeList([1,2,4], 4))

equilibrated_partition(m,n_subsets)

Returns a most equilibratedpartition according to the principles of [`equilibratedpartition_vector`](@ref).

equilibrated_partition_vector(m,n_subsets)

Returns a (most) equilibrated partition possible by euclidian division.

(a problem is that euclidian distribution may give nsubsets or nsubsets+1 if not done like below - here it is the most obvious thing I could think of to get a somewhat equilibrated partition with a constant number of subsets)

first_modes(n::Int, m::Int)

Create a ModeOccupation with n photons in the first sites of m modes.

    is_compatible(target_modes_in::ModeList, target_modes_out::ModeList)

Checks compatibility of ModeLists.

last_modes(n::Int, m::Int)

Create a ModeOccupation with n photons in the last sites of m modes.

    number_modes_occupied(mo::ModeOccupation)

Number of modes having at least a photon.

occupies_all_modes(part::Partition)

Check wether a partition occupies all modes or not.

partition_from_subset_lengths(subset_lengths)

Return a partition from a vector of subset lengths.

to_threshold(mo::ModeOccupation)

Converts a ModeOccupation into threshold detection.