module documentation

Includes all methods needed to generate initial marketplace environment.

Function generate_initial_agents Generates initial lists of buyers and sellers in the market.
Function get_inadequate_communities Gets a list of communities that do not contain the minimum number of buyers. Helper method for community generation.
Function initialize_market_environment Generate a generic initial market environment.
Function make_initial_communities Generate initial CommunitySet.
Function minimum_community_fill Checks if each community has the specific minimum number of buyers. Note: Helper method for community generation.
def generate_initial_agents(num_buyers, assemblage):

Generates initial lists of buyers and sellers in the market.

Parameters
num_buyersUndocumented
assemblagelist of items for sale in market @param num_buyers number of buyers to add to Market @return Market with initial agents
def get_inadequate_communities(group_of_communities, min_community_fill):

Gets a list of communities that do not contain the minimum number of buyers. Helper method for community generation.

Parameters
group_of_communitiesCommunitySet object
min_community_fillminimum number of buyers in each community. @return list of communities with less than min num buyers.
def initialize_market_environment(num_buyers, min_communities, min_community_fill, assemblage):

Generate a generic initial market environment.

Parameters
num_buyersnumber of buyers in market environment
min_communitiesminimum number of communities
min_community_fillminimum number of buyers per community @return CommunitySet object representing initialized market
assemblageUndocumented
def make_initial_communities(list_of_buyers, min_number_of_communities, min_community_fill, assemblage):

Generate initial CommunitySet.

Parameters
list_of_buyersbuyers in the market
min_number_of_communitiesminimum number of communities
min_community_fillminimum number of buyers per community
assemblagelist of items for sale
Returns
CommunitySet
def minimum_community_fill(group_of_communities, min_community_fill):

Checks if each community has the specific minimum number of buyers. Note: Helper method for community generation.

Parameters
group_of_communitiesCommunitySet object
min_community_fillminimum number of buyers in each community. @return True if all communities have minimum number of buyers; False otherwise.