#include <TagDefinitions.h>

Inheritance diagram for CaloRecGPU::TagBase:

Collaboration diagram for CaloRecGPU::TagBase:

Public Types
using	carrier = unsigned long long int

Public Member Functions
constexpr	operator carrier () const

constexpr	TagBase (const carrier v)

constexpr TagBase &	operator= (const carrier v)

constexpr bool	get_flag () const

constexpr uint32_t	get_second_16bit () const

constexpr uint32_t	get_middle_31bit () const

constexpr uint32_t	get_first_16bit () const

constexpr carrier	clear_flag () const

constexpr carrier	clear_second_16bit () const

constexpr carrier	clear_middle_31bit () const

constexpr carrier	clear_first_16bit () const

constexpr carrier	keep_only_flag () const

constexpr carrier	keep_only_second_16bit () const

constexpr carrier	keep_only_middle_31bit () const

constexpr carrier	keep_only_first_16bit () const

constexpr carrier	or_flag (const bool bit) const

constexpr carrier	or_second_16bit (const uint16_t pattern) const

constexpr carrier	or_middle_31bit (const uint32_t pattern) const

constexpr carrier	or_first_16bit (const uint16_t pattern) const

constexpr carrier	override_flag (const bool bit) const

constexpr carrier	override_second_16bit (const uint16_t pattern) const

constexpr carrier	override_middle_31bit (const uint32_t pattern) const

constexpr carrier	override_first_16bit (const uint16_t pattern) const

Static Public Member Functions
static constexpr carrier	make_base_tag (const uint16_t lower=0, const uint32_t middle=0, const uint16_t upper=0, const bool last=false)

static constexpr carrier	make_invalid_tag ()

Public Attributes
carrier	value

Static Protected Attributes
constexpr static carrier	s_bit_mask = 0x8000000000000000ULL

constexpr static carrier	s_second_16bit_mask = 0x7FFF800000000000ULL

constexpr static carrier	s_middle_31bit_mask = 0x00007FFFFFFF0000ULL

constexpr static carrier	s_first_16bit_mask = 0x000000000000FFFFULL

Detailed Description

The base class for marking cells as belonging to clusters.

Currently 64-bit based:

Most significant bit is a flag
Next 16 bits are meant for a uint16_t
Next 31 bits are meant to hold the bit pattern of a non-negative float (sign bit is zero, so we ignore it)
Next 16 bits are meant for another uint16_t

The actual arrays are intended to be of TagBase::carrier rather than TagBase, to keep everything as native types on the GPU side.

Definition at line 31 of file TagDefinitions.h.

Member Typedef Documentation

◆ carrier

using CaloRecGPU::TagBase::carrier = unsigned long long int

Definition at line 35 of file TagDefinitions.h.

Constructor & Destructor Documentation

◆ TagBase()

constexpr CaloRecGPU::TagBase::TagBase ( const carrier v )

inlineconstexpr

Definition at line 45 of file TagDefinitions.h.

                                        : value(v)
     {
     }

Member Function Documentation

◆ clear_first_16bit()

constexpr carrier CaloRecGPU::TagBase::clear_first_16bit ( ) const

inlineconstexpr

Definition at line 113 of file TagDefinitions.h.

     {
       return value & (~ s_first_16bit_mask);
     }

◆ clear_flag()

constexpr carrier CaloRecGPU::TagBase::clear_flag ( ) const

inlineconstexpr

Definition at line 98 of file TagDefinitions.h.

     {
       return value & (~ s_bit_mask);
     }

◆ clear_middle_31bit()

constexpr carrier CaloRecGPU::TagBase::clear_middle_31bit ( ) const

inlineconstexpr

Definition at line 108 of file TagDefinitions.h.

     {
       return value & (~ s_middle_31bit_mask);
     }

◆ clear_second_16bit()

constexpr carrier CaloRecGPU::TagBase::clear_second_16bit ( ) const

inlineconstexpr

Definition at line 103 of file TagDefinitions.h.

     {
       return value & (~ s_second_16bit_mask);
     }

◆ get_first_16bit()

constexpr uint32_t CaloRecGPU::TagBase::get_first_16bit ( ) const

inlineconstexpr

Definition at line 91 of file TagDefinitions.h.

     {
       uint32_t ret = value & s_first_16bit_mask;
       return ret;
     }

◆ get_flag()

constexpr bool CaloRecGPU::TagBase::get_flag ( ) const

inlineconstexpr

Definition at line 71 of file TagDefinitions.h.

     {
       return value & s_bit_mask;
     }

◆ get_middle_31bit()

constexpr uint32_t CaloRecGPU::TagBase::get_middle_31bit ( ) const

inlineconstexpr

Definition at line 84 of file TagDefinitions.h.

     {
       carrier pre_shift = value & s_middle_31bit_mask;
       uint32_t ret = pre_shift >> 16;
       return ret;
     }

◆ get_second_16bit()

constexpr uint32_t CaloRecGPU::TagBase::get_second_16bit ( ) const

inlineconstexpr

Definition at line 76 of file TagDefinitions.h.

     {
       carrier pre_shift = value & s_second_16bit_mask;
       uint32_t ret = pre_shift >> 47;
       return ret;
     }

◆ keep_only_first_16bit()

constexpr carrier CaloRecGPU::TagBase::keep_only_first_16bit ( ) const

inlineconstexpr

Definition at line 133 of file TagDefinitions.h.

     {
       return value & s_first_16bit_mask;
     }

◆ keep_only_flag()

constexpr carrier CaloRecGPU::TagBase::keep_only_flag ( ) const

inlineconstexpr

Definition at line 118 of file TagDefinitions.h.

     {
       return value & s_bit_mask;
     }

◆ keep_only_middle_31bit()

constexpr carrier CaloRecGPU::TagBase::keep_only_middle_31bit ( ) const

inlineconstexpr

Definition at line 128 of file TagDefinitions.h.

     {
       return value & s_middle_31bit_mask;
     }

◆ keep_only_second_16bit()

constexpr carrier CaloRecGPU::TagBase::keep_only_second_16bit ( ) const

inlineconstexpr

Definition at line 123 of file TagDefinitions.h.

     {
       return value & s_second_16bit_mask;
     }

◆ make_base_tag()

static constexpr carrier CaloRecGPU::TagBase::make_base_tag	(	const uint16_t	lower = `0`,
		const uint32_t	middle = `0`,
		const uint16_t	upper = `0`,
		const bool	last = `false`
	)

inlinestaticconstexpr

Definition at line 190 of file TagDefinitions.h.

     {
       carrier ret = upper;
       ret = (ret << 31) | (middle & 0x7FFFFFFFU);
       ret = (ret << 16) | lower;
  
       ret = ret | (s_bit_mask * last);
  
       return ret;
     }

◆ make_invalid_tag()

static constexpr carrier CaloRecGPU::TagBase::make_invalid_tag ( )

inlinestaticconstexpr

Definition at line 201 of file TagDefinitions.h.

     {
       return 0ULL;
     }

◆ operator carrier()

constexpr CaloRecGPU::TagBase::operator carrier ( ) const

inlineconstexpr

Definition at line 40 of file TagDefinitions.h.

     {
       return value;
     }

◆ operator=()

constexpr TagBase& CaloRecGPU::TagBase::operator= ( const carrier v )

inlineconstexpr

Definition at line 49 of file TagDefinitions.h.

     {
       value = v;
       return (*this);
     }

◆ or_first_16bit()

constexpr carrier CaloRecGPU::TagBase::or_first_16bit ( const uint16_t pattern ) const

inlineconstexpr

Definition at line 157 of file TagDefinitions.h.

     {
       uint32_t temp = pattern;
       return value | temp;
     }

◆ or_flag()

constexpr carrier CaloRecGPU::TagBase::or_flag ( const bool bit ) const

inlineconstexpr

Definition at line 138 of file TagDefinitions.h.

     {
       return value | (bit * s_bit_mask);
     }

◆ or_middle_31bit()

constexpr carrier CaloRecGPU::TagBase::or_middle_31bit ( const uint32_t pattern ) const

inlineconstexpr

Definition at line 150 of file TagDefinitions.h.

     {
       carrier temp = pattern & 0x7FFFFFFFU;
       //To make sure the highest bit is unset.
       return value | (temp << 16);
     }

◆ or_second_16bit()

constexpr carrier CaloRecGPU::TagBase::or_second_16bit ( const uint16_t pattern ) const

inlineconstexpr

Definition at line 143 of file TagDefinitions.h.

     {
       carrier temp = pattern;
       return value | (temp << 47);
     }

◆ override_first_16bit()

constexpr carrier CaloRecGPU::TagBase::override_first_16bit ( const uint16_t pattern ) const

inlineconstexpr

Definition at line 183 of file TagDefinitions.h.

     {
       const uint32_t temp = pattern;
       return (value & (~ s_first_16bit_mask)) | temp;
     }

◆ override_flag()

constexpr carrier CaloRecGPU::TagBase::override_flag ( const bool bit ) const

inlineconstexpr

Definition at line 164 of file TagDefinitions.h.

     {
       return (value & (~ s_bit_mask)) | (bit * s_bit_mask);
     }

◆ override_middle_31bit()

constexpr carrier CaloRecGPU::TagBase::override_middle_31bit ( const uint32_t pattern ) const

inlineconstexpr

Definition at line 176 of file TagDefinitions.h.

     {
       const carrier temp = pattern & 0x7FFFFFFFU;
       //To make sure the highest bit is unset.
       return (value & (~ s_middle_31bit_mask)) | (temp << 16);
     }

◆ override_second_16bit()

constexpr carrier CaloRecGPU::TagBase::override_second_16bit ( const uint16_t pattern ) const

inlineconstexpr

Definition at line 169 of file TagDefinitions.h.

     {
       const carrier temp = pattern;
       return (value & (~ s_second_16bit_mask)) | (temp << 47);
     }

Member Data Documentation

◆ s_bit_mask

constexpr static carrier CaloRecGPU::TagBase::s_bit_mask = 0x8000000000000000ULL

staticconstexprprotected

Definition at line 57 of file TagDefinitions.h.

◆ s_first_16bit_mask

constexpr static carrier CaloRecGPU::TagBase::s_first_16bit_mask = 0x000000000000FFFFULL

staticconstexprprotected

Definition at line 66 of file TagDefinitions.h.

◆ s_middle_31bit_mask

constexpr static carrier CaloRecGPU::TagBase::s_middle_31bit_mask = 0x00007FFFFFFF0000ULL

staticconstexprprotected

Definition at line 63 of file TagDefinitions.h.

◆ s_second_16bit_mask

constexpr static carrier CaloRecGPU::TagBase::s_second_16bit_mask = 0x7FFF800000000000ULL

staticconstexprprotected

Definition at line 60 of file TagDefinitions.h.

◆ value

carrier CaloRecGPU::TagBase::value

Definition at line 38 of file TagDefinitions.h.

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

TagDefinitions.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ carrier

Constructor & Destructor Documentation

◆ TagBase()

Member Function Documentation

◆ clear_first_16bit()

◆ clear_flag()

◆ clear_middle_31bit()

◆ clear_second_16bit()

◆ get_first_16bit()

◆ get_flag()

◆ get_middle_31bit()

◆ get_second_16bit()

◆ keep_only_first_16bit()

◆ keep_only_flag()

◆ keep_only_middle_31bit()

◆ keep_only_second_16bit()

◆ make_base_tag()

◆ make_invalid_tag()

◆ operator carrier()

◆ operator=()

◆ or_first_16bit()

◆ or_flag()

◆ or_middle_31bit()

◆ or_second_16bit()

◆ override_first_16bit()

◆ override_flag()

◆ override_middle_31bit()

◆ override_second_16bit()

Member Data Documentation

◆ s_bit_mask

◆ s_first_16bit_mask

◆ s_middle_31bit_mask

◆ s_second_16bit_mask

◆ value