ACTS
Experiment-independent tracking
Loading...
Searching...
No Matches
Acts::VariableSubspaceHelper< FullSize, index_t > Class Template Reference

Helper class for variable subspace operations. More...

#include <Acts/EventData/SubspaceHelpers.hpp>

Inheritance diagram for Acts::VariableSubspaceHelper< FullSize, index_t >:
[legend]
Collaboration diagram for Acts::VariableSubspaceHelper< FullSize, index_t >:
[legend]

Public Types

using Container = boost::container::static_vector<IndexType, FullSize>
 Type alias for container holding subspace indices.
using IndexType = index_t
 Type alias for index type.

Public Member Functions

template<std::ranges::sized_range other_index_range_t>
 VariableSubspaceHelper (const other_index_range_t &indices)
 Construct a variable subspace helper with specified indices.
auto begin () const
 Get iterator to beginning of indices.
bool empty () const
 Check if the subspace is empty.
auto end () const
 Get iterator to end of indices.
const Containerindices () const
 Get the container of subspace indices.
IndexType operator[] (std::size_t i) const
 Access subspace index at position i.
std::size_t size () const
 Get the size of the subspace.

Static Public Attributes

static constexpr std::size_t kFullSize = FullSize
 Size of the full parameter space.

Detailed Description

template<std::size_t FullSize, typename index_t = std::uint8_t>
class Acts::VariableSubspaceHelper< FullSize, index_t >

Helper class for variable subspace operations.

Template Parameters
FullSizethe full size of the subspace
index_tthe index type

Member Typedef Documentation

◆ Container

template<std::size_t FullSize, typename index_t = std::uint8_t>
using Acts::VariableSubspaceHelper< FullSize, index_t >::Container = boost::container::static_vector<IndexType, FullSize>

Type alias for container holding subspace indices.

◆ IndexType

template<std::size_t FullSize, typename index_t = std::uint8_t>
using Acts::VariableSubspaceHelper< FullSize, index_t >::IndexType = index_t

Type alias for index type.

Constructor & Destructor Documentation

◆ VariableSubspaceHelper()

template<std::size_t FullSize, typename index_t = std::uint8_t>
template<std::ranges::sized_range other_index_range_t>
Acts::VariableSubspaceHelper< FullSize, index_t >::VariableSubspaceHelper ( const other_index_range_t & indices)
explicit

Construct a variable subspace helper with specified indices.

Template Parameters
other_index_range_tType of the index range
Parameters
indicesRange of indices defining the subspace

Member Function Documentation

◆ begin()

template<std::size_t FullSize, typename index_t = std::uint8_t>
auto Acts::VariableSubspaceHelper< FullSize, index_t >::begin ( ) const

Get iterator to beginning of indices.

Returns
Iterator to the first index

◆ empty()

template<std::size_t FullSize, typename index_t = std::uint8_t>
bool Acts::VariableSubspaceHelper< FullSize, index_t >::empty ( ) const

Check if the subspace is empty.

Returns
True if the subspace contains no indices

◆ end()

template<std::size_t FullSize, typename index_t = std::uint8_t>
auto Acts::VariableSubspaceHelper< FullSize, index_t >::end ( ) const

Get iterator to end of indices.

Returns
Iterator past the last index

◆ indices()

template<std::size_t FullSize, typename index_t = std::uint8_t>
const Container & Acts::VariableSubspaceHelper< FullSize, index_t >::indices ( ) const

Get the container of subspace indices.

Returns
Reference to the container holding the indices

◆ operator[]()

template<std::size_t FullSize, typename index_t = std::uint8_t>
IndexType Acts::VariableSubspaceHelper< FullSize, index_t >::operator[] ( std::size_t i) const

Access subspace index at position i.

Parameters
iPosition index
Returns
The subspace index at position i

◆ size()

template<std::size_t FullSize, typename index_t = std::uint8_t>
std::size_t Acts::VariableSubspaceHelper< FullSize, index_t >::size ( ) const

Get the size of the subspace.

Returns
Number of indices in the subspace

Member Data Documentation

◆ kFullSize

template<std::size_t FullSize, typename index_t = std::uint8_t>
std::size_t Acts::VariableSubspaceHelper< FullSize, index_t >::kFullSize = FullSize
staticconstexpr

Size of the full parameter space.