Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Math > TBigInt

Light Theme

Dark Theme

TBigInt

N-bit integer.

Windows

MacOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Math/BigInt.h
Include	#include "Math/BigInt.h"

Syntax

template<int32 NumBits, bool bSigned>
class TBigInt

Remarks

N-bit integer.

Constructors

	Name	Description
	TBigInt()	Default constructor. Initializes the number to zero.
	TBigInt ( int64 Other )	Initializes this big int with a 64 bit integer value.
	TBigInt ( const uint32* InBits )	Initializes this big int with an array of words.
	TBigInt ( const FString& Value )	Initializes this big int with a string representing a hex value.
	TBigInt ( const uint8* InData, uint32 InNumBytes )	Initializes this big int with an array of bytes.

Functions

	Name	Description
void	Add ( const BigInt& Other )	Adds two integers.
void	BitwiseAnd ( const BigInt& Other )	Bitwise 'and'
void	BitwiseNot()	Bitwise 'not'
void	BitwiseOr ( const BigInt& Other )	Bitwise 'or'
void	Divide ( const BigInt& Divisor )	Divides two integers.
void	DivideWithRemainder ( const BigInt& Divisor, BigInt& Remainder )	Divides two integers with remainder.
int32	GetBit ( int32 BitIndex )	Returns a bit value as an integer value (0 or 1).
const uint32...	GetBits()
uint32 *	GetBits()
int32	GetHighestNonZeroBit()	Returns the index of the highest non-zero bit. -1 if no such bit exists.
int32	GetHighestNonZeroWord()	Returns the index of the highest word that is not zero. -1 if no such word exists.
bool	IsEqual ( const BigInt& Other )	Checks if two integers are equal.
bool	IsFirstBitSet()
bool	IsGreater ( const BigInt& Other )	This > Other
bool	IsGreaterOrEqual ( const BigInt& Other )	This >= Other
bool	IsGreaterThanZero()	This > 0
bool	IsLess ( const BigInt& Other )	This < Other
bool	IsLessOrEqual ( const BigInt& Other )	This <= Other
bool	IsLessThanZero()	This < 0
bool	IsNegative()	Checks if this integer is negative.
bool	IsZero()	This == 0
void	Modulo ( const BigInt& Modulus )	Performs modulo operation on this integer.
void	Multiply ( const BigInt& Factor )	Multiplies two integers.
void	MultiplyFast ( const BigInt& Factor )	Multiplies two positive integers.
void	Negate()	Negates this integer. value = -value
void	Parse ( const FString& Value )	Parses a string representing a hex value
void	Set ( int64 Value )	Initializes this big int with a 64 bit integer value.
void	SetBit ( int32 BitIndex, int32 Value )	Sets a bit value.
void	ShiftLeft ( const int32 BitCount )	Shift left by the specified amount of bits.
void	ShiftLeftByOneInternal()	Shift left by 1 bit.
void	ShiftLeftInternal ( const int32 BitCount )	Shift left by the specified amount of bits. Does not check if BitCount is valid.
void	ShiftRight ( const int32 BitCount )	Shift right by the specified amount of bits.
void	ShiftRightByOneInternal()	Shift right by 1 bit.
void	ShiftRightInternal ( const int32 BitCount )	Shift right by the specified amount of bits. Does not check if BitCount is valid.
int32	Sign()	Returns the sign of this integer.
void	Sqrt()	Calculates square root of this integer.
void	Subtract ( const BigInt& Other )	Subtracts two integers.
int64	ToInt()	Returns the value of this big int as a 64-bit integer.
FString	ToString()	Returns this big int as a string.
void	Zero()	Sets this integer to 0.

Operators

	Name	Description
BigInt	operator- ( const BigInt& Other )
BigInt &	operator--()
bool	operator!= ( const BigInt& Other )
BigInt	operator% ( const BigInt& Modulus )
BigInt &	operator%= ( const BigInt& Modulus )
BigInt	operator& ( const BigInt& Other )
BigInt &	operator&= ( const BigInt& Other )
BigInt	operator* ( const BigInt& Other )
BigInt &	operator*= ( const BigInt& Other )
BigInt	operator/ ( const BigInt& Divider )
BigInt &	operator/= ( const BigInt& Divider )
bool	operator[] ( int32 BitIndex )	Bit indexing operator
BigInt	operator\| ( const BigInt& Other )
BigInt &	operator\|= ( const BigInt& Other )
BigInt	operator~()
BigInt	operator+ ( const BigInt& Other )
BigInt &	operator++()
BigInt &	operator+= ( const BigInt& Other )
bool	operator< ( const BigInt& Other )
BigInt	operator<< ( int32 Count )
BigInt &	operator<<= ( int32 Count )
bool	operator<= ( const BigInt& Other )
TBigInt &	operator= ( int64 Other )	Assignment operator for int64 values.
BigInt &	operator-= ( const BigInt& Other )
bool	operator== ( const BigInt& Other )
bool	operator> ( const BigInt& Other )
bool	operator>= ( const BigInt& Other )
BigInt	operator>> ( int32 Count )	Begin operator overloads.
BigInt &	operator>>= ( int32 Count )

Typedefs

Name	Description
BigInt

Constants

Name	Description
BitsPerWord	Word size.
NumWords
One

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss