henad-core 0.3.0

Model authoring traits, primitives and shared types of Henad, a parallel agent-based modelling engine.
Documentation 
1
2
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

//! Display layers a model presents, and the neighbourhood a grid rule reads.

/// Display layers a model presents.
///
/// The layers form a set, and a composite model presents more than one layer. They must match what the
/// state's `grid_view`, `point_view` and `edge_view` return, and the testing kit checks that they do.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct TopologyHint {
    /// Whether the model draws a grid layer.
    pub grid: bool,
    /// Whether the model draws agents or nodes.
    pub agents: bool,
    /// Whether the model draws edges between its nodes.
    pub edges: bool,
}

impl TopologyHint {
    /// A grid alone.
    pub const GRID: Self = Self {
        grid: true,
        agents: false,
        edges: false,
    };
    /// Agents alone.
    pub const AGENTS: Self = Self {
        grid: false,
        agents: true,
        edges: false,
    };
    /// Agents over a grid.
    pub const COMPOSITE: Self = Self {
        grid: true,
        agents: true,
        edges: false,
    };
    /// Nodes drawn as agents, with edges between them.
    pub const NETWORK: Self = Self {
        grid: false,
        agents: true,
        edges: true,
    };
    /// No layer.
    pub const NONE: Self = Self {
        grid: false,
        agents: false,
        edges: false,
    };
}

/// Neighbourhood a grid rule reads.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum NeighborhoodKind {
    /// The 8 surrounding cells.
    Moore,
    /// The 4 orthogonal neighbours.
    VonNeumann,
}