Apecs.Stores

Documentation

data Map c

A map based on Data.Intmap.Strict. O(log(n)) for most operations.

Instances

ExplMembers (Map c)

Defined in Apecs.Stores

Methods

explMembers :: Map c -> IO (Vector Int)

ExplDestroy (Map c)

Defined in Apecs.Stores

Methods

explDestroy :: Map c -> Int -> IO ()

ExplSet (Map c)

Defined in Apecs.Stores

Methods

explSet :: Map c -> Int -> Elem (Map c) -> IO ()

ExplGet (Map c)

Defined in Apecs.Stores

Methods

explGet :: Map c -> Int -> IO (Elem (Map c))

explExists :: Map c -> Int -> IO Bool

ExplInit (Map c)

Defined in Apecs.Stores

Methods

explInit :: IO (Map c)

Cachable (Map s)

Defined in Apecs.Stores

type Elem (Map c)

Defined in Apecs.Stores

type Elem (Map c) = c

data Cache (n :: Nat) s

A cache around another store. Caches store their members in a fixed-size vector, so operations run in O(1). Caches can provide huge performance boosts, especially for large numbers of components. The cache size is given as a type-level argument.

Note that iterating over a cache is linear in cache size, so sparsely populated caches might actually decrease performance. In general, the exact size of the cache does not matter as long as it reasonably approximates the number of components present.

The cache uses entity (-1) to internally represent missing entities, so be wary when manually manipulating entities.

Instances

ExplMembers s => ExplMembers (Cache n s)

Defined in Apecs.Stores

Methods

explMembers :: Cache n s -> IO (Vector Int)

ExplDestroy s => ExplDestroy (Cache n s)

Defined in Apecs.Stores

Methods

explDestroy :: Cache n s -> Int -> IO ()

ExplSet s => ExplSet (Cache n s)

Defined in Apecs.Stores

Methods

explSet :: Cache n s -> Int -> Elem (Cache n s) -> IO ()

ExplGet s => ExplGet (Cache n s)

Defined in Apecs.Stores

Methods

explGet :: Cache n s -> Int -> IO (Elem (Cache n s))

explExists :: Cache n s -> Int -> IO Bool

(ExplInit s, KnownNat n, Cachable s) => ExplInit (Cache n s)

Defined in Apecs.Stores

Methods

explInit :: IO (Cache n s)

(KnownNat n, Cachable s) => Cachable (Cache n s)

Defined in Apecs.Stores

type Elem (Cache n s)

Defined in Apecs.Stores

type Elem (Cache n s) = Elem s

data Unique c

A Unique contains zero or one component. Writing to it overwrites both the previous component and its owner. Its main purpose is to be a Map optimized for when only ever one component inhabits it.

Instances

ExplMembers (Unique c)

Defined in Apecs.Stores

Methods

explMembers :: Unique c -> IO (Vector Int)

ExplDestroy (Unique c)

Defined in Apecs.Stores

Methods

explDestroy :: Unique c -> Int -> IO ()

ExplSet (Unique c)

Defined in Apecs.Stores

Methods

explSet :: Unique c -> Int -> Elem (Unique c) -> IO ()

ExplGet (Unique c)

Defined in Apecs.Stores

Methods

explGet :: Unique c -> Int -> IO (Elem (Unique c))

explExists :: Unique c -> Int -> IO Bool

ExplInit (Unique c)

Defined in Apecs.Stores

Methods

explInit :: IO (Unique c)

type Elem (Unique c)

Defined in Apecs.Stores

type Elem (Unique c) = c

data Global c

A Global contains exactly one component. The initial value is mempty from the component's Monoid instance. When operating on a global, any entity arguments are ignored. For example, we can get a global component with get 0 or get 1 or even get undefined.

Instances

ExplSet (Global c)

Defined in Apecs.Stores

Methods

explSet :: Global c -> Int -> Elem (Global c) -> IO ()

ExplGet (Global c)

Defined in Apecs.Stores

Methods

explGet :: Global c -> Int -> IO (Elem (Global c))

explExists :: Global c -> Int -> IO Bool

Monoid c => ExplInit (Global c)

Defined in Apecs.Stores

Methods

explInit :: IO (Global c)

type Elem (Global c)

Defined in Apecs.Stores

type Elem (Global c) = c

class Cachable s

An empty type class indicating that the store behaves like a regular map, and can therefore safely be cached. An example of a store that cannot be cached is Unique.

Instances

Cachable (Map s)

Defined in Apecs.Stores

(KnownNat n, Cachable s) => Cachable (Cache n s)

Defined in Apecs.Stores