create_Xu_problem_from_scratch_given_params: Generate a Xu problem from scratch given parameters

In langfob/bdpg: Package For Building and Testing Biodiversity Problem Generators

Generate a Xu problem from scratch given parameters

Description

Generate a Xu biodiversity problem based on a set of specific parameters (not necessarily derived from derive_Xu_control_parameters()) passed in rather than reading the problem from a file. The purpose of this function is to do the main work of building the problem once parameters have been chosen. It allows dependency injection for testing and it allows for experiments that want to bypass the original Xu indirect creation pathway that depends on the 4 values n, alpha, p, and r.

Usage

create_Xu_problem_from_scratch_given_params(
  tot_num_nodes,
  num_nodes_per_group,
  n__num_groups,
  num_independent_nodes_per_group,
  max_possible_tot_num_links,
  target_num_links_between_2_groups_per_round,
  num_rounds_of_linking_between_groups,
  duplicate_links_allowed
)

Arguments

tot_num_nodes	integer
num_nodes_per_group	integer
n__num_groups	integer
num_independent_nodes_per_group	integer
max_possible_tot_num_links	integer
target_num_links_between_2_groups_per_round	integer
num_rounds_of_linking_between_groups	integer
duplicate_links_allowed	boolean (defaults to FALSE)

Details

The 4 original Xu parameters are not necessary for deriving a problem and its correct answer. It is the values derived from them that are necessary for building the problem (e.g., number of dependent nodes, etc.). The code in this function is where the actual building of the problem occurs.

In some cases, it may be more desirable in experimental setup to manipulate the derived values directly, e.g., to make sure that a problem ends up having a specific number of planning units or species, etc. The 4 original parameters are most useful in theoretically motivating and predicting where to look for problems with a given level of difficulty. Once we can see the different regions of problem structure implied by combinations of those parameters, then the values derived from them may be easier to manipulate in search algorithms and explanations, etc.

Value

Returns a PU_spp_pair_info_class object

See Also

Other interfaces to creation of Xu problems: create_Xu_problem_from_scratch_given_4_Xu_metaparams(), create_Xu_problem_from_scratch_not_using_4_Xu_metaparams(), create_Xu_problem_from_scratch()

langfob/bdpg documentation built on Dec. 8, 2022, 5:33 a.m.