Predicate register view. More...

#include <vec_pred_reg.hh>

Public Types
using	Container = typename std::conditional< Const, const VecPredRegContainer< NUM_BITS, Packed >, VecPredRegContainer< NUM_BITS, Packed > >::type
	Container type alias. More...

Public Member Functions
	VecPredRegT (Container &c)

template<bool Condition = !Const>
std::enable_if< Condition, void >::type	reset ()
	Reset the register to an all-false value. More...

template<bool Condition = !Const>
std::enable_if< Condition, void >::type	set ()
	Reset the register to an all-true value. More...

template<bool Condition = !Const>
std::enable_if< Condition, MyClass & >::type	operator= (const MyClass &that)

const bool &	operator[] (size_t idx) const

template<bool Condition = !Const>
std::enable_if< Condition, bool & >::type	operator[] (size_t idx)

uint8_t	get_raw (size_t idx) const
	Return an element of the predicate register as it appears in the raw (untyped) internal representation. More...

template<bool Condition = !Const>
std::enable_if< Condition, void >::type	set_raw (size_t idx, uint8_t val)
	Write a raw value in an element of the predicate register. More...

template<typename VE2 , size_t NE2, bool P2, bool C2>
bool	operator== (const VecPredRegT< VE2, NE2, P2, C2 > &that) const
	Equality operator, required to compare thread contexts. More...

template<typename VE2 , size_t NE2, bool P2, bool C2>
bool	operator!= (const VecPredRegT< VE2, NE2, P2, C2 > &that) const
	Inequality operator, required to compare thread contexts. More...

const std::string	print () const
	Returns a string representation of the register content. More...

template<bool MC>
bool	firstActive (const VecPredRegT< VecElem, NumElems, Packed, MC > &mask, size_t actual_num_elems) const
	Returns true if the first active element of the register is true. More...

template<bool MC>
bool	noneActive (const VecPredRegT< VecElem, NumElems, Packed, MC > &mask, size_t actual_num_elems) const
	Returns true if there are no active elements in the register. More...

template<bool MC>
bool	lastActive (const VecPredRegT< VecElem, NumElems, Packed, MC > &mask, size_t actual_num_elems) const
	Returns true if the last active element of the register is true. More...

Protected Types
using	MyClass = VecPredRegT< VecElem, NumElems, Packed, Const >

Protected Attributes
Container &	container
	Container corresponding to this view. More...

Static Protected Attributes
static constexpr size_t	NUM_BITS
	Size of the register in bits. More...

Friends
std::ostream &	operator<< (std::ostream &os, const MyClass &p)

Detailed Description

template<typename VecElem, size_t NumElems, bool Packed, bool Const>
class VecPredRegT< VecElem, NumElems, Packed, Const >

Predicate register view.

This generic class implements the View in an MVC pattern, similarly to

See also: VecRegT. Since predicates are mainly used in conjunction with vectors to specify which lanes are active in a vector operation, the class is templated on the vector element type to simplify ISA definitions.

Template Parameters

VecElem	Type of the vector elements.
NumElems	Number of vector elements making up the view.
Packed	True if the predicate register relies on a packed representation, i.e. adjacent bits refer to different vector elements irrespective of the vector element size (e.g. this is the case for AVX-512). If false, the predicate register relies on an unpacked representation, where each bit refers to the corresponding byte in a vector register (e.g. this is the case for ARM SVE).
Const	True if the underlying container can be modified through the view.

Definition at line 66 of file vec_pred_reg.hh.

Member Typedef Documentation

◆ Container

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

using VecPredRegT< VecElem, NumElems, Packed, Const >::Container = typename std::conditional< Const, const VecPredRegContainer<NUM_BITS, Packed>, VecPredRegContainer<NUM_BITS, Packed> >::type

Container type alias.

Definition at line 78 of file vec_pred_reg.hh.

◆ MyClass

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

using VecPredRegT< VecElem, NumElems, Packed, Const >::MyClass = VecPredRegT<VecElem, NumElems, Packed, Const>

protected

Definition at line 82 of file vec_pred_reg.hh.

Constructor & Destructor Documentation

◆ VecPredRegT()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

VecPredRegT< VecElem, NumElems, Packed, Const >::VecPredRegT ( Container & c )

inline

Definition at line 87 of file vec_pred_reg.hh.

Member Function Documentation

◆ firstActive()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

template<bool MC>

bool VecPredRegT< VecElem, NumElems, Packed, Const >::firstActive	(	const VecPredRegT< VecElem, NumElems, Packed, MC > &	mask,
		size_t	actual_num_elems
	)		const

inline

Returns true if the first active element of the register is true.

Parameters

mask	Input mask used to filter the predicates to be tested.
actual_num_elems	Actual number of vector elements considered for the test (corresponding to the current vector length).

Definition at line 175 of file vec_pred_reg.hh.

References ArmISA::i, and ArmISA::mask.

◆ get_raw()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

uint8_t VecPredRegT< VecElem, NumElems, Packed, Const >::get_raw ( size_t idx ) const

inline

Return an element of the predicate register as it appears in the raw (untyped) internal representation.

Definition at line 123 of file vec_pred_reg.hh.

References VecPredRegT< VecElem, NumElems, Packed, Const >::container.

◆ lastActive()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

template<bool MC>

bool VecPredRegT< VecElem, NumElems, Packed, Const >::lastActive	(	const VecPredRegT< VecElem, NumElems, Packed, MC > &	mask,
		size_t	actual_num_elems
	)		const

inline

Returns true if the last active element of the register is true.

Parameters

mask	Input mask used to filter the predicates to be tested.
actual_num_elems	Actual number of vector elements considered for the test (corresponding to the current vector length).

Definition at line 211 of file vec_pred_reg.hh.

References ArmISA::i, ArmISA::mask, and VecPredRegT< VecElem, NumElems, Packed, Const >::operator[]().

◆ noneActive()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

template<bool MC>

bool VecPredRegT< VecElem, NumElems, Packed, Const >::noneActive	(	const VecPredRegT< VecElem, NumElems, Packed, MC > &	mask,
		size_t	actual_num_elems
	)		const

inline

Returns true if there are no active elements in the register.

Parameters

mask	Input mask used to filter the predicates to be tested.
actual_num_elems	Actual number of vector elements considered for the test (corresponding to the current vector length).

Definition at line 193 of file vec_pred_reg.hh.

References ArmISA::i, and ArmISA::mask.

◆ operator!=()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

template<typename VE2 , size_t NE2, bool P2, bool C2>

bool VecPredRegT< VecElem, NumElems, Packed, Const >::operator!= ( const VecPredRegT< VE2, NE2, P2, C2 > & that ) const

inline

Inequality operator, required to compare thread contexts.

Definition at line 149 of file vec_pred_reg.hh.

References VecPredRegT< VecElem, NumElems, Packed, Const >::operator==().

◆ operator=()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

template<bool Condition = !Const>

std::enable_if<Condition, MyClass&>::type VecPredRegT< VecElem, NumElems, Packed, Const >::operator= ( const MyClass & that )

inline

Definition at line 101 of file vec_pred_reg.hh.

References VecPredRegT< VecElem, NumElems, Packed, Const >::container.

◆ operator==()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

template<typename VE2 , size_t NE2, bool P2, bool C2>

bool VecPredRegT< VecElem, NumElems, Packed, Const >::operator== ( const VecPredRegT< VE2, NE2, P2, C2 > & that ) const

inline

Equality operator, required to compare thread contexts.

Definition at line 141 of file vec_pred_reg.hh.

References VecPredRegT< VecElem, NumElems, Packed, Const >::container.

Referenced by VecPredRegT< VecElem, NumElems, Packed, Const >::operator!=().

◆ operator[]() [1/2]

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

template<bool Condition = !Const>

std::enable_if<Condition, bool&>::type VecPredRegT< VecElem, NumElems, Packed, Const >::operator[] ( size_t idx )

inline

Definition at line 115 of file vec_pred_reg.hh.

References VecPredRegT< VecElem, NumElems, Packed, Const >::container.

◆ operator[]() [2/2]

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

const bool& VecPredRegT< VecElem, NumElems, Packed, Const >::operator[] ( size_t idx ) const

inline

Definition at line 108 of file vec_pred_reg.hh.

References VecPredRegT< VecElem, NumElems, Packed, Const >::container.

Referenced by VecPredRegT< VecElem, NumElems, Packed, Const >::lastActive().

◆ print()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

const std::string VecPredRegT< VecElem, NumElems, Packed, Const >::print ( ) const

inline

Returns a string representation of the register content.

Definition at line 167 of file vec_pred_reg.hh.

References csprintf().

◆ reset()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

template<bool Condition = !Const>

std::enable_if<Condition, void>::type VecPredRegT< VecElem, NumElems, Packed, Const >::reset ( )

inline

Reset the register to an all-false value.

Definition at line 92 of file vec_pred_reg.hh.

References VecPredRegT< VecElem, NumElems, Packed, Const >::container.

◆ set()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

template<bool Condition = !Const>

std::enable_if<Condition, void>::type VecPredRegT< VecElem, NumElems, Packed, Const >::set ( )

inline

Reset the register to an all-true value.

Definition at line 97 of file vec_pred_reg.hh.

References VecPredRegT< VecElem, NumElems, Packed, Const >::container.

◆ set_raw()

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

template<bool Condition = !Const>

std::enable_if<Condition, void>::type VecPredRegT< VecElem, NumElems, Packed, Const >::set_raw	(	size_t	idx,
		uint8_t	val
	)

inline

Write a raw value in an element of the predicate register.

Definition at line 132 of file vec_pred_reg.hh.

References VecPredRegT< VecElem, NumElems, Packed, Const >::container, and X86ISA::val.

Friends And Related Function Documentation

◆ operator<<

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

std::ostream& operator<<	(	std::ostream &	os,
		const MyClass &	p
	)

friend

Definition at line 155 of file vec_pred_reg.hh.

Member Data Documentation

◆ container

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

Container& VecPredRegT< VecElem, NumElems, Packed, Const >::container

protected

Container corresponding to this view.

Definition at line 84 of file vec_pred_reg.hh.

Referenced by VecPredRegT< VecElem, NumElems, Packed, Const >::get_raw(), VecPredRegT< VecElem, NumElems, Packed, Const >::operator=(), VecPredRegT< VecElem, NumElems, Packed, Const >::operator==(), VecPredRegT< VecElem, NumElems, Packed, Const >::operator[](), VecPredRegT< VecElem, NumElems, Packed, Const >::reset(), VecPredRegT< VecElem, NumElems, Packed, Const >::set(), and VecPredRegT< VecElem, NumElems, Packed, Const >::set_raw().

◆ NUM_BITS

template<typename VecElem , size_t NumElems, bool Packed, bool Const>

constexpr size_t VecPredRegT< VecElem, NumElems, Packed, Const >::NUM_BITS

staticconstexprprotected

Initial value:

= Packed ? NumElems :

sizeof(VecElem) * NumElems

Size of the register in bits.

Definition at line 70 of file vec_pred_reg.hh.

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

arch/generic/vec_pred_reg.hh

Public Types

Public Member Functions

Protected Types

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

template<typename VecElem, size_t NumElems, bool Packed, bool Const> class VecPredRegT< VecElem, NumElems, Packed, Const >

Member Typedef Documentation

◆ Container

◆ MyClass

Constructor & Destructor Documentation

◆ VecPredRegT()

Member Function Documentation

◆ firstActive()

◆ get_raw()

◆ lastActive()

◆ noneActive()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ print()

◆ reset()

◆ set()

◆ set_raw()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ container

◆ NUM_BITS

template<typename VecElem, size_t NumElems, bool Packed, bool Const>
class VecPredRegT< VecElem, NumElems, Packed, Const >