#include <RangeBound.h>

Public Types
typedef TCallTraits< ElementType >::ParamType	ElementValueOrConstRef

Public Member Functions
	TRangeBound ()

	TRangeBound (ElementValueOrConstRef InValue)

bool	operator== (const TRangeBound &Other) const

bool	operator!= (const TRangeBound &Other) const

ElementValueOrConstRef	GetValue () const

void	SetValue (ElementValueOrConstRef NewValue)

UE_FORCEINLINE_HINT bool	IsClosed () const

UE_FORCEINLINE_HINT bool	IsExclusive () const

UE_FORCEINLINE_HINT bool	IsInclusive () const

UE_FORCEINLINE_HINT bool	IsOpen () const

Static Public Member Functions
static TRangeBound	Exclusive (ElementValueOrConstRef Value)

static TRangeBound	Inclusive (ElementValueOrConstRef Value)

static TRangeBound	Open ()

static TRangeBound	FlipInclusion (const TRangeBound &Bound)

static const TRangeBound &	MaxLower (const TRangeBound &A, const TRangeBound &B)

static const TRangeBound &	MaxUpper (const TRangeBound &A, const TRangeBound &B)

static const TRangeBound &	MinLower (const TRangeBound &A, const TRangeBound &B)

static const TRangeBound &	MinUpper (const TRangeBound &A, const TRangeBound &B)

Friends
class FArchive &	operator<< (class FArchive &Ar, TRangeBound &Bound)

uint32	GetTypeHash (const TRangeBound &Bound)

Detailed Description

template<typename ElementType>
class TRangeBound< ElementType >

Template for range bounds.

Member Typedef Documentation

◆ ElementValueOrConstRef

template<typename ElementType >

typedef TCallTraits<ElementType>::ParamType TRangeBound< ElementType >::ElementValueOrConstRef

Constructor & Destructor Documentation

◆ TRangeBound() [1/2]

template<typename ElementType >

TRangeBound< ElementType >::TRangeBound ( )

inline

Default constructor.

See also: Exclusive, Inclusive, Open

◆ TRangeBound() [2/2]

template<typename ElementType >

TRangeBound< ElementType >::TRangeBound ( ElementValueOrConstRef InValue )

inline

Creates a closed bound that includes the specified value.

Parameters

InValue The bound's value.

See also: Exclusive, Inclusive, Open

Member Function Documentation

◆ Exclusive()

template<typename ElementType >

static TRangeBound TRangeBound< ElementType >::Exclusive ( ElementValueOrConstRef Value )

inlinestatic

Returns a closed bound that excludes the specified value.

Parameters

Value The bound value.

Returns: An exclusive closed bound.

◆ FlipInclusion()

template<typename ElementType >

static TRangeBound TRangeBound< ElementType >::FlipInclusion ( const TRangeBound< ElementType > & Bound )

inlinestatic

Returns the given bound with its inclusion flipped between inclusive and exclusive.

If the bound is open it is returned unchanged.

Returns: A new bound.

◆ GetValue()

template<typename ElementType >

ElementValueOrConstRef TRangeBound< ElementType >::GetValue ( ) const

inline

Gets the bound's value.

Use IsClosed() to verify that this bound is closed before calling this method.

Returns: Bound value.

See also: IsOpen

◆ Inclusive()

template<typename ElementType >

static TRangeBound TRangeBound< ElementType >::Inclusive ( ElementValueOrConstRef Value )

inlinestatic

Returns a closed bound that includes the specified value.

Parameters

Value The bound value.

Returns: An inclusive closed bound.

◆ IsClosed()

template<typename ElementType >

UE_FORCEINLINE_HINT bool TRangeBound< ElementType >::IsClosed ( ) const

inline

Checks whether the bound is closed.

Returns: true if the bound is closed, false otherwise.

◆ IsExclusive()

template<typename ElementType >

UE_FORCEINLINE_HINT bool TRangeBound< ElementType >::IsExclusive ( ) const

inline

Checks whether the bound is exclusive.

Returns: true if the bound is exclusive, false otherwise.

◆ IsInclusive()

template<typename ElementType >

UE_FORCEINLINE_HINT bool TRangeBound< ElementType >::IsInclusive ( ) const

inline

Checks whether the bound is inclusive.

Returns: true if the bound is inclusive, false otherwise.

◆ IsOpen()

template<typename ElementType >

UE_FORCEINLINE_HINT bool TRangeBound< ElementType >::IsOpen ( ) const

inline

Checks whether the bound is open.

Returns: true if the bound is open, false otherwise.

◆ MaxLower()

template<typename ElementType >

static const TRangeBound & TRangeBound< ElementType >::MaxLower	(	const TRangeBound< ElementType > &	A,
		const TRangeBound< ElementType > &	B
	)

inlinestatic

Returns the greater of two lower bounds.

Parameters

A	The first lower bound.
B	The second lower bound.

Returns: The greater lower bound.

◆ MaxUpper()

template<typename ElementType >

static const TRangeBound & TRangeBound< ElementType >::MaxUpper	(	const TRangeBound< ElementType > &	A,
		const TRangeBound< ElementType > &	B
	)

inlinestatic

Returns the greater of two upper bounds.

Parameters

A	The first upper bound.
B	The second upper bound.

Returns: The greater upper bound.

◆ MinLower()

template<typename ElementType >

static const TRangeBound & TRangeBound< ElementType >::MinLower	(	const TRangeBound< ElementType > &	A,
		const TRangeBound< ElementType > &	B
	)

inlinestatic

Returns the lesser of two lower bounds.

Parameters

A	The first lower bound.
B	The second lower bound.

Returns: The lesser lower bound.

◆ MinUpper()

template<typename ElementType >

static const TRangeBound & TRangeBound< ElementType >::MinUpper	(	const TRangeBound< ElementType > &	A,
		const TRangeBound< ElementType > &	B
	)

inlinestatic

Returns the lesser of two upper bounds.

Parameters

A	The first upper bound.
B	The second upper bound.

Returns: The lesser upper bound.

◆ Open()

template<typename ElementType >

static TRangeBound TRangeBound< ElementType >::Open ( )

inlinestatic

Returns an open bound.

Returns: An open bound.

◆ operator!=()

template<typename ElementType >

bool TRangeBound< ElementType >::operator!= ( const TRangeBound< ElementType > & Other ) const

inline

Compares this range with the specified bound for inequality.

Parameters

Other The bound to compare with.

Returns: true if the bounds are not equal, false otherwise.

◆ operator==()

template<typename ElementType >

bool TRangeBound< ElementType >::operator== ( const TRangeBound< ElementType > & Other ) const

inline

Compares this bound with the specified bound for equality.

Parameters

Other The bound to compare with.

Returns: true if the bounds are equal, false otherwise.

◆ SetValue()

template<typename ElementType >

void TRangeBound< ElementType >::SetValue ( ElementValueOrConstRef NewValue )

inline

Sets the bound's value, maintining the inclusivity of the bound

Use IsClosed() to verify that this bound is closed before calling this method.

Parameters

NewValue New bound value.

See also: IsClosed

Friends And Related Symbol Documentation

◆ GetTypeHash

template<typename ElementType >

uint32 GetTypeHash ( const TRangeBound< ElementType > & Bound )

friend

Gets the hash for the specified bound.

Parameters

Bound The bound to get the hash for.

Returns: Hash value.

◆ operator<<

template<typename ElementType >

class FArchive & operator<<	(	class FArchive &	Ar,
		TRangeBound< ElementType > &	Bound
	)

friend

Serializes the given bound from or into the specified archive.

Parameters

Ar	The archive to serialize from or into.
Bound	The bound to serialize.

Returns: The archive.

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

Engine/Source/Runtime/Core/Public/Math/RangeBound.h

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ ElementValueOrConstRef

Constructor & Destructor Documentation

◆ TRangeBound() [1/2]

◆ TRangeBound() [2/2]

Member Function Documentation

◆ Exclusive()

◆ FlipInclusion()

◆ GetValue()

◆ Inclusive()

◆ IsClosed()

◆ IsExclusive()

◆ IsInclusive()

◆ IsOpen()

◆ MaxLower()

◆ MaxUpper()

◆ MinLower()

◆ MinUpper()

◆ Open()

◆ operator!=()

◆ operator==()

◆ SetValue()

Friends And Related Symbol Documentation

◆ GetTypeHash

◆ operator<<