CaloRecGPU::ClusterTag Class Reference

#include <TagDefinitions.h>

Inheritance diagram for CaloRecGPU::ClusterTag:

Collaboration diagram for CaloRecGPU::ClusterTag:

Public Types
using	carrier = unsigned long long int

Public Member Functions
constexpr bool	is_part_of_cluster () const
constexpr int32_t	cluster_index () const
constexpr int32_t	secondary_cluster_index () const
constexpr int32_t	secondary_cluster_weight () const
constexpr bool	is_shared_between_clusters () const
constexpr carrier	set_part_of_cluster (const bool is_part=true) const
constexpr carrier	set_cluster_index (const int32_t index) const
constexpr carrier	set_secondary_cluster_index (const int32_t index) const
constexpr carrier	set_secondary_cluster_weight (const int32_t weight) const
constexpr carrier	override_part_of_cluster (const bool is_part=true) const
constexpr carrier	override_cluster_index (const int32_t index) const
constexpr carrier	override_secondary_cluster_index (const int32_t index) const
constexpr carrier	override_secondary_cluster_weight (const int32_t weight) const
constexpr	TagBase (const carrier v)
constexpr	operator carrier () const
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_tag (const uint16_t cluster_index=0, const int32_t weight=0, const uint16_t second_cluster_index=0)
static constexpr bool	is_part_of_cluster (const ClusterTag tag)
static constexpr int32_t	cluster_index (const ClusterTag tag)
static constexpr int32_t	secondary_cluster_index (const ClusterTag tag)
static constexpr int32_t	secondary_cluster_weight (const ClusterTag tag)
static constexpr bool	is_shared_between_clusters (const ClusterTag tag)
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 class that actually expresses the cluster assignment. Supports cells that are shared between two clusters, storing the weight assigned to the first (as the weight assigned to the second will be one minus that); cells that are part of a single cluster have that weight set to (the bit pattern of the floating point representation of) 1.

See TagBase for more details.

Definition at line 221 of file TagDefinitions.h.

Member Typedef Documentation

carrier

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

inherited

Definition at line 35 of file TagDefinitions.h.

Member Function Documentation

clear_first_16bit()

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

inlineconstexprinherited

Definition at line 113 of file TagDefinitions.h.

    {
      return value & (~ s_first_16bit_mask);
    }

clear_flag()

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

inlineconstexprinherited

Definition at line 98 of file TagDefinitions.h.

    {
      return value & (~ s_bit_mask);
    }

clear_middle_31bit()

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

inlineconstexprinherited

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

inlineconstexprinherited

Definition at line 103 of file TagDefinitions.h.

    {
      return value & (~ s_second_16bit_mask);
    }

cluster_index() [1/2]

constexpr int32_t CaloRecGPU::ClusterTag::cluster_index ( ) const

inlineconstexpr

Definition at line 243 of file TagDefinitions.h.

    {
      return this->get_first_16bit();
    }

cluster_index() [2/2]

static constexpr int32_t CaloRecGPU::ClusterTag::cluster_index ( const ClusterTag  tag )

inlinestaticconstexpr

Definition at line 248 of file TagDefinitions.h.

    {
      return tag.cluster_index();
    }

get_first_16bit()

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

inlineconstexprinherited

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

inlineconstexprinherited

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

inlineconstexprinherited

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

inlineconstexprinherited

Definition at line 76 of file TagDefinitions.h.

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

is_part_of_cluster() [1/2]

constexpr bool CaloRecGPU::ClusterTag::is_part_of_cluster ( ) const

inlineconstexpr

Definition at line 233 of file TagDefinitions.h.

    {
      return this->get_flag();
    }

is_part_of_cluster() [2/2]

static constexpr bool CaloRecGPU::ClusterTag::is_part_of_cluster ( const ClusterTag  tag )

inlinestaticconstexpr

Definition at line 238 of file TagDefinitions.h.

    {
      return tag.is_part_of_cluster();
    }

is_shared_between_clusters() [1/2]

constexpr bool CaloRecGPU::ClusterTag::is_shared_between_clusters ( ) const

inlineconstexpr

Definition at line 273 of file TagDefinitions.h.

    {
      return this->is_part_of_cluster() && this->secondary_cluster_weight() > 0;
    }

is_shared_between_clusters() [2/2]

static constexpr bool CaloRecGPU::ClusterTag::is_shared_between_clusters ( const ClusterTag  tag )

inlinestaticconstexpr

Definition at line 278 of file TagDefinitions.h.

    {
      return tag.is_shared_between_clusters();
    }

keep_only_first_16bit()

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

inlineconstexprinherited

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

inlineconstexprinherited

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

inlineconstexprinherited

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

inlineconstexprinherited

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  )

inlinestaticconstexprinherited

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 ( )

inlinestaticconstexprinherited

Definition at line 201 of file TagDefinitions.h.

    {
      return 0ULL;
    }

make_tag()

static constexpr carrier CaloRecGPU::ClusterTag::make_tag ( const uint16_t  cluster_index = 0, const int32_t  weight = 0, const uint16_t  second_cluster_index = 0  )

inlinestaticconstexpr

Definition at line 228 of file TagDefinitions.h.

    {
      return make_base_tag(cluster_index, weight, second_cluster_index, true);
    }

operator carrier()

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

inlineconstexprinherited

Definition at line 40 of file TagDefinitions.h.

    {
      return value;
    }

or_first_16bit()

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

inlineconstexprinherited

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

inlineconstexprinherited

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

inlineconstexprinherited

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

inlineconstexprinherited

Definition at line 143 of file TagDefinitions.h.

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

override_cluster_index()

constexpr carrier CaloRecGPU::ClusterTag::override_cluster_index ( const int32_t  index ) const

inlineconstexpr

Definition at line 309 of file TagDefinitions.h.

    {
      return this->override_first_16bit(index & 0xFFFFU);
    }

override_first_16bit()

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

inlineconstexprinherited

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

inlineconstexprinherited

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

inlineconstexprinherited

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_part_of_cluster()

constexpr carrier CaloRecGPU::ClusterTag::override_part_of_cluster ( const bool  is_part = true ) const

inlineconstexpr

Definition at line 303 of file TagDefinitions.h.

    {
 
      return this->override_flag(is_part);
    }

override_second_16bit()

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

inlineconstexprinherited

Definition at line 169 of file TagDefinitions.h.

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

override_secondary_cluster_index()

constexpr carrier CaloRecGPU::ClusterTag::override_secondary_cluster_index ( const int32_t  index ) const

inlineconstexpr

Definition at line 314 of file TagDefinitions.h.

    {
      return this->override_second_16bit(index & 0xFFFFU);
    }

override_secondary_cluster_weight()

constexpr carrier CaloRecGPU::ClusterTag::override_secondary_cluster_weight ( const int32_t  weight ) const

inlineconstexpr

Definition at line 319 of file TagDefinitions.h.

    {
      return this->override_middle_31bit(weight);
    }

secondary_cluster_index() [1/2]

constexpr int32_t CaloRecGPU::ClusterTag::secondary_cluster_index ( ) const

inlineconstexpr

Definition at line 253 of file TagDefinitions.h.

    {
      return this->get_second_16bit();
    }

secondary_cluster_index() [2/2]

static constexpr int32_t CaloRecGPU::ClusterTag::secondary_cluster_index ( const ClusterTag  tag )

inlinestaticconstexpr

Definition at line 258 of file TagDefinitions.h.

    {
      return tag.secondary_cluster_index();
    }

secondary_cluster_weight() [1/2]

constexpr int32_t CaloRecGPU::ClusterTag::secondary_cluster_weight ( ) const

inlineconstexpr

Definition at line 263 of file TagDefinitions.h.

    {
      return this->get_middle_31bit();
    }

secondary_cluster_weight() [2/2]

static constexpr int32_t CaloRecGPU::ClusterTag::secondary_cluster_weight ( const ClusterTag  tag )

inlinestaticconstexpr

Definition at line 268 of file TagDefinitions.h.

    {
      return tag.secondary_cluster_weight();
    }

set_cluster_index()

constexpr carrier CaloRecGPU::ClusterTag::set_cluster_index ( const int32_t  index ) const

inlineconstexpr

Definition at line 288 of file TagDefinitions.h.

    {
      return this->or_first_16bit(index & 0xFFFFU);
    }

set_part_of_cluster()

constexpr carrier CaloRecGPU::ClusterTag::set_part_of_cluster ( const bool  is_part = true ) const

inlineconstexpr

Definition at line 283 of file TagDefinitions.h.

    {
      return this->or_flag(is_part);
    }

set_secondary_cluster_index()

constexpr carrier CaloRecGPU::ClusterTag::set_secondary_cluster_index ( const int32_t  index ) const

inlineconstexpr

Definition at line 293 of file TagDefinitions.h.

    {
      return this->or_second_16bit(index & 0xFFFFU);
    }

set_secondary_cluster_weight()

constexpr carrier CaloRecGPU::ClusterTag::set_secondary_cluster_weight ( const int32_t  weight ) const

inlineconstexpr

Definition at line 298 of file TagDefinitions.h.

    {
      return this->or_middle_31bit(weight);
    }

TagBase()

constexpr CaloRecGPU::TagBase::TagBase

inlineconstexpr

Definition at line 45 of file TagDefinitions.h.

                                       : value(v)
    {
    }

Member Data Documentation

s_bit_mask

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

staticconstexprprotectedinherited

Definition at line 57 of file TagDefinitions.h.

s_first_16bit_mask

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

staticconstexprprotectedinherited

Definition at line 66 of file TagDefinitions.h.

s_middle_31bit_mask

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

staticconstexprprotectedinherited

Definition at line 63 of file TagDefinitions.h.

s_second_16bit_mask

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

staticconstexprprotectedinherited

Definition at line 60 of file TagDefinitions.h.

value

carrier CaloRecGPU::TagBase::value

inherited

Definition at line 38 of file TagDefinitions.h.

---

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

• TagDefinitions.h