FNetBitArrayView

Simple bit array view.

API > API/Runtime > API/Runtime/NetCore > API/Runtime/NetCore/Net > API/Runtime/NetCore/Net/Core

Inheritance Hierarchy

References

   
Module NetCore
Header /Engine/Source/Runtime/Net/Core/Public/Net/Core/NetBitArray.h
Include #include "Net/Core/NetBitArray.h"

Syntax

class FNetBitArrayView : public UE::Net::FNetBitArrayBase

Remarks

Simple bit array view. Assumes external storage and has very little error checking as it is used in performance critical code. Note: Trailing padding bits in storage will be zeroed unless the view is explicitly constructed to allow it. Certain operations assume the padding bits are cleared.

Constructors

  Type Name Description
Public function   Constructor will produce a valid but empty bitarray.
Public function  

FNetBitArrayView ( StorageWordType* StorageIn,
uint32 BitCountIn
)

 Construct NetBitArray from external storage.
Public function   Construct NetBitArray from external storage.
Public function  

FNetBitArrayView ( StorageWordType* StorageIn,
uint32 BitCountIn,
const EResetOnInitType
)

 Construct NetBitArray from external storage.

Functions

  Type Name Description
Public function Const Private::FNetBitArrayRangedForConstIterator

begin ()

 DO NOT USE DIRECTLY Range-based for loop support iterating over set bits and returning the index to the set bit.
Public function Static uint32 NetBitArrayView implementation.
Public function Const void

ClearBit ( uint32 Index
)

 Clear the bit with the specified index
Public function void

ClearBits ( uint32 StartIndex,
uint32 Count
)

 Clear the bits in the specified range
Public function void All padding bits will be set to zero
Public function void

Combine ( const FNetBitArrayView& Other,
WordOpFunctor&& WordOp
)

 Combine this array with another array using a word operation functor. Bit counts need to match.
Public function void

CombineMultiple ( WordOpFunctor1&& Op,
const FNetBitArrayView& ArrayA,
WordOpFunctor2&& Op2,
const FNetBitArrayView& ArrayB
)

 Combine this array with the result of a bitwise operation of two other arrays.
Public function void

Copy ( const FNetBitArray& Other
)

  
Public function void

Copy ( const FNetBitArrayView& Other
)

 Copy bits from other bit array. The other array must have the same bit count.
Public function Const uint32

CountSetBits ( uint32 StartIndex,
uint32 Count
)

 Counts the number of set bits in this array in the provided range.
Public function Const Private::FNetBitArrayRangedForConstIterator

end ()

  
Public function Const uint32 Find first set bit. Returns InvalidIndex if no zero bit was found
Public function Const uint32

FindFirstOne ( uint32 StartIndex
)

 Find first set bit starting from StartIndex. Returns InvalidIndex if no set bit was found.
Public function Const uint32

FindFirstZero ( uint32 StartIndex
)

 Find first zero bit starting from StartIndex. Returns InvalidIndex if no zero bit was found.
Public function Const uint32 Find first zero bit. Returns InvalidIndex if no zero bit was found
Public function Const uint32 Find last set bit. Returns InvalidIndex if no set bit was found.
Public function Const uint32 Find last zero bit. Returns InvalidIndex if no zero bit was found.
Public function Static void

ForAllExclusiveBits ( const FNetBitArrayView& A,
const FNetBitArrayView& B,
T&& FunctorA,
V&& FunctorB
)

 Compare two BitArrays bit by bit and invoke FunctorA(BitIndex) for bits set only in array A and invoke FunctorB(BitIndex) for bits set only in array B.
Public function Static void

ForAllSetBits ( const FNetBitArrayView& A,
const FNetBitArrayView& B,
T&& WordOpFunctor,
V&& Functor
)

 Iterate over all words and execute Functor, with signature void(uint32 BitIndex), for all set bits after executing WordOpFunctor
Public function Const void

ForAllSetBits ( T&& Functor
)

 Iterate over all set bits and invoke functor with signature void(uint32 BitIndex).
Public function Const bool

GetBit ( uint32 Index
)

 Get the bit with the specified index
Public function StorageWordType *

GetData ()

 Returns a pointer to the internal storage.
Public function Const const StorageWordType *

GetData ()

 Returns a pointer to the internal storage.
Public function Const uint32 Returns the number of bits
Public function Const uint32 Returns the number of words in our storage
Public function Const uint32

GetSetBitIndices ( uint32 StartIndex,
uint32 Count,
uint32* OutIndices,
uint32 OutIndicesCapacity
)

 Retrieves set bits in the provided range and returns how many indices were written to OutIndices.
Public function Const bool

IsAnyBitSet ( uint32 StartIndex,
uint32 Count
)

 Returns true if any bit is set in the specified range.
Public function Const bool Returns true if any bit is set in the bitset Note: Padding bits in storage are expected to be zero.
Public function Const bool

IsBitSet ( uint32 Index
)

 Return if a specified bit is set or not
Public function Const bool Returns true if no bit is set in the bitset. Note: Padding bits in storage are expected to be zero.
Public function void

Reset ()

 Reset the storage of the BitArray including any padding bits
Public function void

Set ( const FNetBitArrayView& First,
WordOpFunctor&& WordOp,
const FNetBitArrayView& Second
)

 Overwrite this bit array with the result of a word operation from two other arrays
Public function void Set all bits, padding bits will be zeroed
Public function void

SetBit ( uint32 Index
)

 Set the bit with the specified index
Public function void

SetBits ( uint32 StartIndex,
uint32 Count
)

 Set the bits in the specified range to true
Public function void

SetBitValue ( uint32 Index,
bool bValue
)

 Set the bit with the specified index to bValue
Public function Const FString Only prints the amount of set bits in the array.

Operators

  Type Name Description
Public function Const bool

operator== ( const FNetBitArrayView& Other
)

 Return true if equal including BitCount and padding bits

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page