fixed size data structure optimized for representing an array of bits.
More...
#include <FixedSizeBitset.h>
Inherits AzNetworking::IBitset.
|
using | SelfType = FixedSizeBitset< SIZE, ElementType > |
|
using | ContainerType = AZStd::array< ElementType, ElementCount > |
|
|
static const constexpr
AZStd::size_t | ElementTypeBits = sizeof(ElementType) * 8 |
|
static const constexpr
AZStd::size_t | ElementCount = (SIZE + ElementTypeBits - 1) / ElementTypeBits |
|
|
template<AZStd::size_t , typename > |
class | FixedSizeVectorBitset |
|
template<AZStd::size_t SIZE, typename ElementType = uint32_t>
class AzNetworking::FixedSizeBitset< SIZE, ElementType >
fixed size data structure optimized for representing an array of bits.
template<AZStd::size_t SIZE, typename ElementType >
Construct to a given initial state.
- Parameters
-
value | value to initialize all bits to |
template<AZStd::size_t SIZE, typename ElementType>
Construct from an array of raw input.
- Parameters
-
values | raw input array to initialize bit vector to |
template<AZStd::size_t SIZE, typename ElementType>
Construct from another bit set.
- Parameters
-
template<AZStd::size_t SIZE, typename ElementType >
Returns true if any of the bits are set.
- Returns
- boolean true if any bit is set, false otherwise
Implements AzNetworking::IBitset.
template<AZStd::size_t SIZE, typename ElementType >
Gets the current value of the specified bit.
- Parameters
-
index | index of the bit to retrieve the value of |
- Returns
- boolean true if the bit is set, false otherwise
Implements AzNetworking::IBitset.
template<AZStd::size_t SIZE, typename ElementType >
Const raw-buffer access.
- Returns
- const pointer to the raw buffer the bit array is stored in
template<AZStd::size_t SIZE, typename ElementType >
Non-const raw-buffer access.
- Returns
- non-const pointer to the raw buffer the bit array is stored in
template<AZStd::size_t SIZE, typename ElementType >
Returns the number of bits that are represented in this fixed size bitset.
- Returns
- the number of bits that are represented in this fixed size bitset
Implements AzNetworking::IBitset.
template<AZStd::size_t SIZE, typename ElementType >
Initializes all internal bits to the provided value.
- Parameters
-
value | value to initialize all bits to |
template<AZStd::size_t SIZE, typename ElementType >
Inequality operator.
- Parameters
-
rhs | instance to compare against |
- Returns
- boolean true if inputs are different, false otherwise
template<AZStd::size_t SIZE, typename ElementType >
Assignment from same type.
- Parameters
-
rhs | instance to assign from |
template<AZStd::size_t SIZE, typename ElementType >
Equality operator.
- Parameters
-
rhs | instance to compare against |
- Returns
- boolean true if inputs are the same, false otherwise
template<AZStd::size_t SIZE, typename ElementType >
Bitwise OR assignment operator.
- Parameters
-
rhs | instance to bitwise-or assign |
- Returns
- reference to the LHS
template<AZStd::size_t SIZE, typename ElementType >
Base serialize method for all serializable structures or classes to implement.
- Parameters
-
serializer | ISerializer instance to use for serialization |
- Returns
- boolean true for success, false for serialization failure
template<AZStd::size_t SIZE, typename ElementType >
Sets the specified bit to the provided value.
- Parameters
-
index | index of the bit to set |
value | value to set the bit to |
Implements AzNetworking::IBitset.
template<AZStd::size_t SIZE, typename ElementType>
Subtracts off the set bits of the passed in bitset.
- Parameters
-
rhs | the bits that we want to remove from the current bitset |
The documentation for this class was generated from the following files:
- Code/Framework/AzNetworking/AzNetworking/DataStructures/FixedSizeBitset.h
- Code/Framework/AzNetworking/AzNetworking/DataStructures/FixedSizeBitset.inl