def test_orbits(self, dim):
"""Test if function returns all the integer partitions of 5. This test does not
require ``similarity.orbits`` to return the orbits in any specified order."""
partition = all_orbits[dim]
orb = similarity.orbits(dim)
assert sorted(partition) == sorted(orb)
##############################################################################
# Here, ``[1, 1]`` means that two photons were detected, each in a separate mode. Other samples
# can be randomly generated from the ``[1, 1]`` orbit using:
print(similarity.orbit_to_sample([1, 1], modes=m0.modes))
##############################################################################
# Orbits provide a useful way to coarse-grain the samples from GBS into outcomes that are
# statistically more likely to be observed. However, we are interested in coarse-graining further
# into *events*, which correspond to a combination of orbits with the same photon number such
# that the number of photons counted in each mode does not exceed a fixed value
# ``max_count_per_mode``. To understand this, let's look at all of the orbits with a photon
# number of 5:
print(list(similarity.orbits(5)))
##############################################################################
# All 5-photon samples belong to one of the orbits above. A 5-photon event with
# ``max_count_per_mode = 3`` means that we include the orbits: ``[[1, 1, 1, 1, 1], [2, 1, 1, 1],
# [3, 1, 1], [2, 2, 1], [3, 2]]`` and ignore the orbits ``[[4, 1], [5]]``. For example,
# the sample ``[0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 0, 0, 3, 0, 0, 0]`` is a 5-photon event:
print(
similarity.sample_to_event(
[0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 0, 0, 3, 0, 0, 0], 3))
##############################################################################
# Samples with more than ``max_count_per_mode`` in any mode are not counted as part of the event:
print(
def test_orbit_sorted(self, dim):
"""Test if function generates orbits that are lists sorted in descending order."""
assert all(
[o == sorted(o, reverse=True) for o in similarity.orbits(dim)])
def test_orbit_sum(self, dim):
"""Test if function generates orbits that are lists that sum to ``dim``."""
assert all([sum(o) == dim for o in similarity.orbits(dim)])