SmallSet< Tdir, items > Struct Template Reference

Set containing 'items' items of 'tile and Tdir' No tree structure is used because it would cause slowdowns in most usual cases. More...

Data Structures
struct	SSdata
	Element of set. More...

Public Member Functions
	SmallSet (std::string_view name)
	Constructor - just set default values and 'name'.
void	Reset ()
	Reset variables to default values.
bool	Overflowed ()
	Returns value of 'overflowed'.
bool	IsEmpty ()
	Checks for empty set.
bool	IsFull ()
	Checks for full set.
uint	Items ()
	Reads the number of items.
bool	Remove (TileIndex tile, Tdir dir)
	Tries to remove first instance of given tile and dir.
bool	IsIn (TileIndex tile, Tdir dir)
	Tries to find given tile and dir in the set.
bool	Add (TileIndex tile, Tdir dir)
	Adds tile & dir into the set, checks for full set Sets the 'overflowed' flag if the set was full.
bool	Get (TileIndex *tile, Tdir *dir)
	Reads the last added element into the set.

Private Attributes
uint	n = 0
	Actual number of units.
bool	overflowed = false
	Did we try to overflow the set?
const std::string_view	name
	Name, used for debugging purposes...
struct SmallSet::SSdata	data [items]

Detailed Description

template<typename Tdir, uint items>
struct SmallSet< Tdir, items >

Set containing 'items' items of 'tile and Tdir' No tree structure is used because it would cause slowdowns in most usual cases.

Definition at line 55 of file signal.cpp.

Constructor & Destructor Documentation

SmallSet()

template<typename Tdir, uint items>

SmallSet< Tdir, items >::SmallSet ( std::string_view name )

inline

Constructor - just set default values and 'name'.

Parameters

name	The name of the set.

Definition at line 72 of file signal.cpp.

References name.

Member Function Documentation

Add()

template<typename Tdir, uint items>

bool SmallSet< Tdir, items >::Add ( TileIndex tile, Tdir dir )

inline

Adds tile & dir into the set, checks for full set Sets the 'overflowed' flag if the set was full.

Parameters

tile	tile
dir	and dir to add

Returns

true iff the item could be added (set wasn't full)

Definition at line 158 of file signal.cpp.

References Debug, IsFull(), and name.

Get()

template<typename Tdir, uint items>

bool SmallSet< Tdir, items >::Get ( TileIndex * tile, Tdir * dir )

inline

Reads the last added element into the set.

Parameters

tile	pointer where tile is written to
dir	pointer where dir is written to

Returns

false iff the set was empty

Definition at line 179 of file signal.cpp.

IsEmpty()

template<typename Tdir, uint items>

bool SmallSet< Tdir, items >::IsEmpty ( )

inline

Checks for empty set.

Returns

is the set empty?

Definition at line 94 of file signal.cpp.

IsFull()

template<typename Tdir, uint items>

bool SmallSet< Tdir, items >::IsFull ( )

inline

Checks for full set.

Returns

is the set full?

Definition at line 103 of file signal.cpp.

References lengthof.

Referenced by Add().

IsIn()

template<typename Tdir, uint items>

bool SmallSet< Tdir, items >::IsIn ( TileIndex tile, Tdir dir )

inline

Tries to find given tile and dir in the set.

Parameters

tile	tile
dir	and dir to find

Returns

true iff the tile & dir element was found

Definition at line 142 of file signal.cpp.

Items()

template<typename Tdir, uint items>

uint SmallSet< Tdir, items >::Items ( )

inline

Reads the number of items.

Returns

current number of items

Definition at line 112 of file signal.cpp.

Overflowed()

template<typename Tdir, uint items>

bool SmallSet< Tdir, items >::Overflowed ( )

inline

Returns value of 'overflowed'.

Returns

did we try to overflow the set?

Definition at line 85 of file signal.cpp.

Remove()

template<typename Tdir, uint items>

bool SmallSet< Tdir, items >::Remove ( TileIndex tile, Tdir dir )

inline

Tries to remove first instance of given tile and dir.

Parameters

tile	tile
dir	and dir to remove

Returns

element was found and removed

Definition at line 124 of file signal.cpp.

Reset()

template<typename Tdir, uint items>

void SmallSet< Tdir, items >::Reset ( )

inline

Reset variables to default values.

Definition at line 75 of file signal.cpp.

Field Documentation

n

template<typename Tdir, uint items>

uint SmallSet< Tdir, items >::n = 0

private

Actual number of units.

Definition at line 57 of file signal.cpp.

name

template<typename Tdir, uint items>

const std::string_view SmallSet< Tdir, items >::name

private

Name, used for debugging purposes...

Definition at line 59 of file signal.cpp.

Referenced by Add(), and SmallSet().

overflowed

template<typename Tdir, uint items>

bool SmallSet< Tdir, items >::overflowed = false

private

Did we try to overflow the set?

Definition at line 58 of file signal.cpp.

---

The documentation for this struct was generated from the following file:

• src/signal.cpp