Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Structure recognizer types.

See overview of the structure recognizer feature in Swarm.Game.Scenario.Topography.Structure.Recognition.Precompute.

The following structure template shall be used to illustrate roles of the types in this module:

cdc
aab
cdc

Documentation

type OriginalName = Text

A NamedStructure has its own newtype name (StructureName), but we standardize on Text here to avoid parameterizing our NamedOriginal datatype on bespoke name types.

type AtomicKeySymbol a = Maybe a

A "needle" consisting of a single cell within the haystack (a row of cells) to be searched.

Example

A single entity a in the row:

aab

type SymbolSequence a = [AtomicKeySymbol a]

A "needle" consisting row of cells within the haystack (a sequence of rows) to be searched.

Example

The complete row:

aab

data StructureSearcher b a

This is returned as a value of the 1-D searcher. It contains search automatons customized to the 2-D structures that may possibly contain the row found by the 1-D searcher.

Constructors

StructureSearcher

Fields

• automaton2D :: AutomatonInfo a (SymbolSequence a) (StructureWithGrid b a)
• needleContent :: SymbolSequence a
• singleRowItems :: NonEmpty (SingleRowEntityOccurrences b a)

data PositionWithinRow b a

Position specific to a single entity within a horizontal row.

Example

For entity b within the row:

aab

Its _position is 2.

Constructors

PositionWithinRow

Fields

• _position :: Int32

  horizontal index of the entity within the row

• structureRow :: StructureRow b a

data SingleRowEntityOccurrences b a

Constructors

SingleRowEntityOccurrences

Fields

• myRow :: StructureRow b a
• myEntity :: a
• entityOccurrences :: NonEmpty (PositionWithinRow b a)
• expandedOffsets :: InspectionOffsets

data StructureRow b a

A a specific row within a particular structure.

Example

For the second occurrence of cdc within the structure:

cdc
aab
cdc

it's rowIndex is 2.

The two type parameters, b and a, correspond to StructureCells and Entity, respectively.

Constructors

StructureRow

Fields

• wholeStructure :: StructureWithGrid b a
• rowIndex :: Int32

  vertical index of the row within the structure

• rowContent :: SymbolSequence a

data NamedOriginal a

This wrapper facilitates naming the original structure (i.e. the "payload" for recognition) for the purpose of both UI display and internal uniqueness, while remaining agnostic to its internals.

Constructors

NamedOriginal

Fields

• getName :: OriginalName
• orig :: a

Instances

Show a => Show (NamedOriginal a)

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Methods

showsPrec :: Int -> NamedOriginal a -> ShowS

show :: NamedOriginal a -> String

showList :: [NamedOriginal a] -> ShowS

Eq a => Eq (NamedOriginal a)

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Methods

(==) :: NamedOriginal a -> NamedOriginal a -> Bool

(/=) :: NamedOriginal a -> NamedOriginal a -> Bool

data StructureWithGrid b a

The original definition of a structure, bundled with its grid of cells having been extracted for convenience.

The two type parameters, b and a, correspond to StructureCells and Entity, respectively.

Constructors

StructureWithGrid

Fields

• originalDefinition :: NamedOriginal b
• rotatedTo :: AbsoluteDir
• entityGrid :: [SymbolSequence a]

Instances

(Eq b, Eq a) => Eq (StructureWithGrid b a)

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Methods

(==) :: StructureWithGrid b a -> StructureWithGrid b a -> Bool

(/=) :: StructureWithGrid b a -> StructureWithGrid b a -> Bool

data RotationalSymmetry

Constructors

NoSymmetry

Aka 1-fold symmetry

TwoFold

Equivalent under rotation by 180 degrees

FourFold

Equivalent under rotation by 90 degrees

Instances

Show RotationalSymmetry

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Methods

showsPrec :: Int -> RotationalSymmetry -> ShowS

show :: RotationalSymmetry -> String

showList :: [RotationalSymmetry] -> ShowS

Eq RotationalSymmetry

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Methods

(==) :: RotationalSymmetry -> RotationalSymmetry -> Bool

(/=) :: RotationalSymmetry -> RotationalSymmetry -> Bool

data SymmetryAnnotatedGrid a

Constructors

SymmetryAnnotatedGrid

Fields

• namedGrid :: a
• symmetry :: RotationalSymmetry

Instances

Show a => Show (SymmetryAnnotatedGrid a)

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Methods

showsPrec :: Int -> SymmetryAnnotatedGrid a -> ShowS

show :: SymmetryAnnotatedGrid a -> String

showList :: [SymmetryAnnotatedGrid a] -> ShowS

data StructureInfo b a

Structure definitions with precomputed metadata for consumption by the UI

Constructors

StructureInfo

Fields

• annotatedGrid :: SymmetryAnnotatedGrid b
• entityProcessedGrid :: [SymbolSequence a]
• entityCounts :: Map a Int

data InspectionOffsets

For all of the rows that contain a given entity (and are recognized by a single automaton), compute the left-most and right-most position within the row that the given entity may occur.

This determines how far to the left and to the right our search of the world cells needs to begin and end, respectively.

The Semigroup instance always grows in extent, taking the minimum of the leftward offsets and the maximum of the rightward offsets.

Constructors

InspectionOffsets

Fields

• startOffset :: Min Int32

  Always non-positive (i.e. either zero or negative). For the first-level search, this extends to the left. For the second-level search, this extends upward.

• endOffset :: Max Int32

  Always non-negative. For the first-level search, this extends to the right. For the second-level search, this extends downward.

Instances

ToJSON InspectionOffsets

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Methods

toJSON :: InspectionOffsets -> Value

toEncoding :: InspectionOffsets -> Encoding

toJSONList :: [InspectionOffsets] -> Value

toEncodingList :: [InspectionOffsets] -> Encoding

omitField :: InspectionOffsets -> Bool

Semigroup InspectionOffsets

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Methods

(<>) :: InspectionOffsets -> InspectionOffsets -> InspectionOffsets

sconcat :: NonEmpty InspectionOffsets -> InspectionOffsets

stimes :: Integral b => b -> InspectionOffsets -> InspectionOffsets

Generic InspectionOffsets

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Associated Types

type Rep InspectionOffsets :: Type -> Type

Methods

from :: InspectionOffsets -> Rep InspectionOffsets x

to :: Rep InspectionOffsets x -> InspectionOffsets

Show InspectionOffsets

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Methods

showsPrec :: Int -> InspectionOffsets -> ShowS

show :: InspectionOffsets -> String

showList :: [InspectionOffsets] -> ShowS

type Rep InspectionOffsets

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

type Rep InspectionOffsets = D1 ('MetaData "InspectionOffsets" "Swarm.Game.Scenario.Topography.Structure.Recognition.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-topography" 'False) (C1 ('MetaCons "InspectionOffsets" 'PrefixI 'True) (S1 ('MetaSel ('Just "startOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Min Int32)) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Max Int32))))

data AutomatonInfo en k v

Each automaton shall be initialized to recognize a certain subset of structure rows, that may either all be within one structure, or span multiple structures.

Constructors

AutomatonInfo

Fields

• _participatingEntities :: HashSet en
• _inspectionOffsets :: InspectionOffsets
• _automaton :: StateMachine k v

Instances

Generic (AutomatonInfo en k v)

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Associated Types

type Rep (AutomatonInfo en k v) :: Type -> Type

Methods

from :: AutomatonInfo en k v -> Rep (AutomatonInfo en k v) x

to :: Rep (AutomatonInfo en k v) x -> AutomatonInfo en k v

type Rep (AutomatonInfo en k v)

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

type Rep (AutomatonInfo en k v) = D1 ('MetaData "AutomatonInfo" "Swarm.Game.Scenario.Topography.Structure.Recognition.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-topography" 'False) (C1 ('MetaCons "AutomatonInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "_participatingEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashSet en)) :*: (S1 ('MetaSel ('Just "_inspectionOffsets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InspectionOffsets) :*: S1 ('MetaSel ('Just "_automaton") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (StateMachine k v)))))

participatingEntities :: forall en k v en. Lens (AutomatonInfo en k v) (AutomatonInfo en k v) (HashSet en) (HashSet en)

inspectionOffsets :: forall en k v. Lens' (AutomatonInfo en k v) InspectionOffsets

automaton :: forall en k v k v. Lens (AutomatonInfo en k v) (AutomatonInfo en k v) (StateMachine k v) (StateMachine k v)

data RecognizerAutomatons b a

The complete set of data needed to identify applicable structures, based on a just-placed entity.

Constructors

RecognizerAutomatons

Fields

• _originalStructureDefinitions :: Map OriginalName (StructureInfo b a)

  all of the structures that shall participate in automatic recognition. This list is used only by the UI and by the Floorplan command.

• _automatonsByEntity :: HashMap a (AutomatonInfo a (AtomicKeySymbol a) (StructureSearcher b a))

Instances

Generic (RecognizerAutomatons b a)

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Associated Types

type Rep (RecognizerAutomatons b a) :: Type -> Type

Methods

from :: RecognizerAutomatons b a -> Rep (RecognizerAutomatons b a) x

to :: Rep (RecognizerAutomatons b a) x -> RecognizerAutomatons b a

type Rep (RecognizerAutomatons b a)

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

type Rep (RecognizerAutomatons b a) = D1 ('MetaData "RecognizerAutomatons" "Swarm.Game.Scenario.Topography.Structure.Recognition.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-topography" 'False) (C1 ('MetaCons "RecognizerAutomatons" 'PrefixI 'True) (S1 ('MetaSel ('Just "_originalStructureDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map OriginalName (StructureInfo b a))) :*: S1 ('MetaSel ('Just "_automatonsByEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap a (AutomatonInfo a (AtomicKeySymbol a) (StructureSearcher b a))))))

originalStructureDefinitions :: forall b a. Lens' (RecognizerAutomatons b a) (Map OriginalName (StructureInfo b a))

automatonsByEntity :: forall b a. Lens' (RecognizerAutomatons b a) (HashMap a (AutomatonInfo a (AtomicKeySymbol a) (StructureSearcher b a)))

data FoundStructure b a

Final output of the search process. These are the elements that are stored in the FoundRegistry.

The two type parameters, b and a, correspond to StructureCells and Entity, respectively.

Constructors

FoundStructure

Fields

• structureWithGrid :: StructureWithGrid b a
• upperLeftCorner :: Cosmic Location

Instances

(Eq b, Eq a) => Eq (FoundStructure b a)

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Methods

(==) :: FoundStructure b a -> FoundStructure b a -> Bool

(/=) :: FoundStructure b a -> FoundStructure b a -> Bool

(Eq b, Eq a) => Ord (FoundStructure b a)

Ordering is by increasing preference between simultaneously completed structures. The preference heuristic is for:

1. Primarily, larger area.
2. Secondarily, lower X-Y coords (X is compared first)

Since the natural order of coordinates increases as described, we need to invert it with Down so that this ordering is by increasing preference.

Defined in Swarm.Game.Scenario.Topography.Structure.Recognition.Type

Methods

compare :: FoundStructure b a -> FoundStructure b a -> Ordering

(<) :: FoundStructure b a -> FoundStructure b a -> Bool

(<=) :: FoundStructure b a -> FoundStructure b a -> Bool

(>) :: FoundStructure b a -> FoundStructure b a -> Bool

(>=) :: FoundStructure b a -> FoundStructure b a -> Bool

max :: FoundStructure b a -> FoundStructure b a -> FoundStructure b a

min :: FoundStructure b a -> FoundStructure b a -> FoundStructure b a

genOccupiedCoords :: FoundStructure b a -> [Cosmic Location]

Yields coordinates that are occupied by an entity of a placed structure. Cells within the rectangular bounds of the structure that are unoccupied are not included.