Skip to content

Subset

Subset

Bases: AbstractSet

A subset of people within a particular Venue. For example, children in a household.

Source code in may/population/subset.py 
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
class Subset(AbstractSet):
    """A subset of people within a particular Venue. For example, children in a household."""
#    external = False
    __slots__ = (
        "venue",
        "subset_index",
        'subset_name',
        'members',
        'member_metadata',
    )

    def __init__(self,
                 venue: "Venue",
                 subset_index: int,
                 subset_name: str = None,
                 members: set["Person"]=None,
                 ):
        """
        Args:
          venue (Venue): the location in which this subset is situated.
          subset_index (int): index of the subset within the Venue's contact matrix.
          subset_name (str, optional): the string denoting which subset this is within the Venue. Default is str(subset_index).
          members (set[Person], optional): an optional set of the people in this subset.
        """
        self.venue = venue
        self.subset_index = subset_index
        self.subset_name = subset_name if subset_name is not None else str(self.subset_index)
        self.members= members if members is not None else set()
        # Generic per-member numeric metadata (Design B side-table). Keyed by
        # person.id, value is a dict of named numeric fields (e.g.
        # {"t_board_min": 0, "t_alight_min": 20} for a transport leg). Empty by
        # default; populated by distributors that need per-membership state.
        self.member_metadata = {}

    def _collate(self, attribute: str, ifnot=False) -> list["Person"]:
        """Collates Persons from self.members that have a particular attribute == True.

        Requires that the attribute called for is truthy (a boolean).

        Args:
            attribute (str): the attribute to look at (e.g. 'dead', or 'susceptible', or 'infected').
            ifnot (bool, optional): if True, looks for people where the attribute is False.

        Returns:
            (list[Person]) : a list of members filtered so the given attribute is True/False.
        """
        if ifnot:
            return [person for person in self.members if not getattr(person, attribute)]
        else:
            return [person for person in self.members if getattr(person, attribute)]

    @property
    def size_collated(self, attribute, ifnot=False) -> int:
        """ """
        return len(self._collate(attribute, ifnot=ifnot))

    @property
    def spec(self):
        """ """
        return self.venue.type , self.subset_index

    def __contains__(self, item):
        return item in self.members

    def __iter__(self):
        return iter(self.members)

    def __len__(self):
        return len(self.members)

    def __str__(self):
        return "Class : {} , subset_name : {}, venue.id : {}, venue_name : {}, subset_membership : {}, members_present : {}".format(type(self), self.subset_name, self.venue.id, self.venue.name, len(self.members), len(self))

    def __eq__(self, other):
        if not self.size == other.size:            
            return False
        if not self.spec == other.spec:
            return False
        if not self.venue == other.venue:
            return False
        if not self.subset_index == other.subset_index:
            return False
        for p, p2 in zip(self.members, other.members):
            if not p == p2:
                return False
        return True

    def __getitem__(self, item):
        return list(self.members)[item]

    def add_member(self, person: "Person"):
        """ Add a person's membership to this subset"""
        self.members.add(person)

    def remove_member(self, person: "Person"):
        """ Add a person's membership to this subset"""
        self.members.remove(person)

    @property
    def num_members(self):
        return len(self.members)

size_collated property

spec property

__init__(venue, subset_index, subset_name=None, members=None)

Parameters:

Name Type Description Default
venue Venue

the location in which this subset is situated.

 required
subset_index int

index of the subset within the Venue's contact matrix.

 required
subset_name str

the string denoting which subset this is within the Venue. Default is str(subset_index).

 None
members set[Person]

an optional set of the people in this subset.

 None
Source code in may/population/subset.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def __init__(self,
             venue: "Venue",
             subset_index: int,
             subset_name: str = None,
             members: set["Person"]=None,
             ):
    """
    Args:
      venue (Venue): the location in which this subset is situated.
      subset_index (int): index of the subset within the Venue's contact matrix.
      subset_name (str, optional): the string denoting which subset this is within the Venue. Default is str(subset_index).
      members (set[Person], optional): an optional set of the people in this subset.
    """
    self.venue = venue
    self.subset_index = subset_index
    self.subset_name = subset_name if subset_name is not None else str(self.subset_index)
    self.members= members if members is not None else set()
    # Generic per-member numeric metadata (Design B side-table). Keyed by
    # person.id, value is a dict of named numeric fields (e.g.
    # {"t_board_min": 0, "t_alight_min": 20} for a transport leg). Empty by
    # default; populated by distributors that need per-membership state.
    self.member_metadata = {}

add_member(person)

Add a person's membership to this subset

Source code in may/population/subset.py 
93
94
95
def add_member(self, person: "Person"):
    """ Add a person's membership to this subset"""
    self.members.add(person)

remove_member(person)

Add a person's membership to this subset

Source code in may/population/subset.py 
97
98
99
def remove_member(self, person: "Person"):
    """ Add a person's membership to this subset"""
    self.members.remove(person)