fs::topo::Location Class Reference

Inheritance diagram for fs::topo::Location:

Collaboration diagram for fs::topo::Location:

Public Member Functions
	Location (const Idx row, const Idx column, const HashSize hash) noexcept
	Construct using hash of row and column.
	Location (const Idx row, const Idx column) noexcept
	Constructor.
	Location (const Coordinates &coord)
constexpr	Location (const HashSize &hash_size) noexcept
	Construct with given hash that may contain data from subclasses.
template<class P >
constexpr	Location (const Position< P > &position) noexcept
	Construct with given hash that may contain data from subclasses.
	Position ()=default
constexpr	Position (const Topo &topo) noexcept
	Construct with given hash that may contain data from subclasses.
Public Member Functions inherited from fs::topo::Position< HashSize >
constexpr Idx	row () const noexcept
	Row.
constexpr Idx	column () const noexcept
	Column.
constexpr HashSize	hash () const noexcept
	Hash derived from row and column.
constexpr bool	operator== (const Position &rhs) const noexcept
	Equality operator.
constexpr bool	operator!= (const Position &rhs) const noexcept
	Inequality operator.

Additional Inherited Members
Protected Member Functions inherited from fs::topo::Position< HashSize >
constexpr	Position (const Topo &topo) noexcept
	Construct with given hash that may contain data from subclasses.
Static Protected Member Functions inherited from fs::topo::Position< HashSize >
static constexpr HashSize	doHash (const Idx row, const Idx column) noexcept
	Create a hash from given values.
static constexpr Idx	unhashRow (const Topo hash) noexcept
	Row from hash.
static constexpr Idx	unhashColumn (const Topo hash) noexcept
	Column.
Protected Attributes inherited from fs::topo::Position< HashSize >
HashSize	topo_data_
	Stored hash that contains row and column data.
Static Protected Attributes inherited from fs::topo::Position< HashSize >
static constexpr uint32_t	XYBits
	Number of bits to use for storing one coordinate of Position data.
static constexpr uint32_t	PositionBits
	Number of bits to use for storing Position data.
static constexpr Topo	ColumnMask
	Hash mask for bits being used for Position data.
static constexpr Topo	HashMask
	Hash mask for bits being used for Position data.

Constructor & Destructor Documentation

Location() [1/4]

fs::topo::Location::Location ( const Idx row, const Idx column, const HashSize hash )

inlineexplicitnoexcept

Construct using hash of row and column.

Parameters

hash	HashSize derived form row and column

Here is the call graph for this function:

Location() [2/4]

fs::topo::Location::Location ( const Idx row, const Idx column )

inlinenoexcept

Constructor.

Parameters

row	Row
column	Column

Here is the call graph for this function:

Location() [3/4]

fs::topo::Location::Location ( const HashSize & hash_size )

inlineexplicitconstexprnoexcept

Construct with given hash that may contain data from subclasses.

Parameters

hash_size

Hash to store

Location() [4/4]

template<class P >

fs::topo::Location::Location ( const Position< P > & position )

inlineexplicitconstexprnoexcept

Construct with given hash that may contain data from subclasses.

Parameters

hash_size

Hash to store

Member Function Documentation

Position()

fs::topo::Position< V >::Position ( const Topo & topo )

inlineexplicitconstexprnoexcept

Construct with given hash that may contain data from subclasses.

Parameters

topo	Hash to store

---

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

• firestarr/src/cpp/Location.h