SelectionModes

Collaboration diagram for SelectionModes:

Enumerations
enum class	Utopia::SelectionMode {   Utopia::SelectionMode::condition = 0 , Utopia::SelectionMode::sample = 1 , Utopia::SelectionMode::probability = 2 , Utopia::SelectionMode::clustered_simple = 20 ,   Utopia::SelectionMode::position = 100 , Utopia::SelectionMode::boundary = 101 , Utopia::SelectionMode::lanes = 102 }
	Possible selection modes; availability depends on choice of manager. More...

Functions
std::string	Utopia::selection_mode_to_string (const SelectionMode &mode)
	Given a SelectionMode enum value, return the corresponding string key.

Variables
const std::map< std::string, SelectionMode >	Utopia::selection_mode_map
	A map from strings to Select enum values.

Detailed Description

Enumeration Type Documentation

SelectionMode

enum class Utopia::SelectionMode

strong

Possible selection modes; availability depends on choice of manager.

For further details, consult the actual implementations.

Warning

Associated integer values may be subject to change.

Enumerator
condition	Select if a condition is fulfilled.
sample	Select a random sample of entities with a known sample size.
probability	Select an entity with a given probability.
clustered_simple	Select entity clusters using a simple neighborhood-based algorithm. Uses the "simple" algorithm: From a given start population, iterate over neighbors and attach them with a certain probability. Note Currently only implemented for CellManager, but expandable to all managers that provide a neighborhood interface for the entities they manage.
position	(For CellManager only) Selects cells at given positions in space
boundary	(For CellManager only) Select the boundary cells of a grid
lanes	(For CellManager only) Selects horizontal or vertical lanes of cells

                         {
    // .. Working on entities . . . . . . . . . . . . . . . . . . . . . . . . .
    condition = 0,
 
    sample = 1,
 
    probability = 2,
 
    // .. Clustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
    // (Offset by 20 to accomodate different algorithms)
 
    clustered_simple = 20,
 
    // .. Only relevant for CellManager . . . . . . . . . . . . . . . . . . . .
    // (Offset by 100)
    position = 100,
 
    boundary = 101,
 
    lanes = 102
 
    // .. Only relevant for AgentManager . . . . . . . . . . . . . . . . . . .
    // (Offset by 200)
 
    // .. Only relevant for GraphManager . . . . . . . . . . . . . . . . . . .
    // (Offset by 300)
 
    // NOTE When adding new enum members, take care to update the
    //      select_key_map!
};

Function Documentation

selection_mode_to_string()

std::string Utopia::selection_mode_to_string

(

const SelectionMode &

mode

)

Given a SelectionMode enum value, return the corresponding string key.

This iterates over the selection_mode_map and returns the first key that matches the given enum value.

                                                              {
    for (const auto& m : selection_mode_map) {
        if (m.second == mode) {
            return m.first;
        }
    }
    // Entry is missing; this should not happen, as the map is meant to
    // include all possible enum values. Inform about it ...
    throw std::invalid_argument("The given entity selection mode is not "
        "available! Are all SelectionMode values represented in the map?");
};

Variable Documentation

selection_mode_map

const std::map<std::string, SelectionMode> Utopia::selection_mode_map

Initial value:

{
    
    {"condition",           SelectionMode::condition},
    {"sample",              SelectionMode::sample},
    {"probability",         SelectionMode::probability},
 
    
    {"position",            SelectionMode::position},
    {"boundary",            SelectionMode::boundary},
    {"lanes",               SelectionMode::lanes},
 
    
    {"clustered_simple",    SelectionMode::clustered_simple}
}

A map from strings to Select enum values.

                                                          {
    // General
    {"condition",           SelectionMode::condition},
    {"sample",              SelectionMode::sample},
    {"probability",         SelectionMode::probability},
 
    // CellManager
    {"position",            SelectionMode::position},
    {"boundary",            SelectionMode::boundary},
    {"lanes",               SelectionMode::lanes},
 
    // Clustered
    {"clustered_simple",    SelectionMode::clustered_simple}
};