FNetBitArray

Simple bit array with internal storage.

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 FNetBitArray : public UE::Net::FNetBitArrayBase

Remarks

Simple bit array with internal storage. Has very little error checking as it is used in performance critical code.

Constructors

  Type Name Description
Public function   FNetBitArray Implementation.
Public function  

FNetBitArray ( uint32 BitCount
)

 Creates an array with size BitCount bits.
Public function   Construct NetBitArray with the given BitCount but doesn't zero the allocated memory.

Functions

  Type Name Description
Public function void

AddBits ( uint32 BitCount
)

 Grows the size with the specified number of bits. New bits will be cleared.
Public function Const Private::FNetBitArrayRangedForConstIterator

begin ()

 FNetBitArrayRangedForConstIterator implementation.
Public function 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

Combine ( const FNetBitArray& 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 FNetBitArray& ArrayA,
WordOpFunctor2&& Op2,
const FNetBitArray& ArrayB
)

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

Copy ( const FNetBitArrayView& Other
)

  
Public function void

Copy ( const FNetBitArray& 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 void

Empty ()

 Release all memory and set capacity to 0 bits
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 Find first zero bit. Returns InvalidIndex if no zero 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 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 FNetBitArray& A,
const FNetBitArray& 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 Const void

ForAllSetBits ( T&& Functor
)

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

ForAllSetBits ( const FNetBitArray& A,
const FNetBitArray& 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 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 void

Init ( uint32 BitCount
)

 Sets a new size and resets the array's contents.
Public function void

InitAndCopy ( const FNetBitArrayView& Source
)

  
Public function void

InitAndCopy ( const FNetBitArray& Source
)

 Initialize a bit array with another array.
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.
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 ()

 Clear all bits in the array.
Public function void

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

 Overwrite this bit array with the result of a word operation from two other arrays
Public function void Sets all bits in the array, but clears padding bits.
Public function void

SetBit ( uint32 Index
)

 Set the bit with the specified index
Public function void

SetBits ( uint32 StartIndex,
uint32 Count
)

 Set the bit with the specified index to bValue
Public function void

SetBitValue ( uint32 Index,
bool bValue
)

 Set the bit with the specified index to bValue
Public function void

SetNumBits ( uint32 BitCount
)

 Sets the number of bits to BitCount.
Public function Const FString Only prints the amount of set bits in the array.

Operators

  Type Name Description
Public function Const bool

operator== ( const FNetBitArray& 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