Acts::BinnedGroup< grid_t > Class Template Reference

#include <Acts/Seeding/BinnedGroup.hpp>

Inheritance diagram for Acts::BinnedGroup< grid_t >:

Public Member Functions
	BinnedGroup ()=delete
	Default constructor.
	BinnedGroup (BinnedGroup< grid_t > &&other) noexcept=default
	Move Constructor.
	BinnedGroup (const BinnedGroup< grid_t > &other)=delete
	Copy constructor.
	BinnedGroup (grid_t &&grid, const GridBinFinder< DIM > &bottomFinder, const GridBinFinder< DIM > &topFinder, std::array< std::vector< std::size_t >, DIM > navigation=std::array< std::vector< std::size_t >, DIM >())
	brief Constructor
	BinnedGroup (grid_t &&grid, std::vector< bool > mask, const GridBinFinder< DIM > &bottomFinder, const GridBinFinder< DIM > &topFinder, std::array< std::vector< std::size_t >, DIM > navigation=std::array< std::vector< std::size_t >, DIM >())
	Constructor with grid, mask, and finders.
	BinnedGroup (grid_t &grid, const GridBinFinder< DIM > &bottomFinder, const GridBinFinder< DIM > &topFinder, std::array< std::vector< std::size_t >, DIM > navigation=std::array< std::vector< std::size_t >, DIM >())=delete
	~BinnedGroup ()=default
	Default destructor.
BinnedGroupIterator< grid_t >	begin () const
	Get the begin iterator.
BinnedGroupIterator< grid_t >	end () const
	Get the end iterator.
grid_t &	grid ()
	Retrieve mutable reference to the Grid.
const grid_t &	grid () const
	Retrieve const reference to the Grid.
const std::vector< bool > &	mask () const
	Retrieve the mask Only const accessor is supported.
BinnedGroup< grid_t > &	operator= (BinnedGroup< grid_t > &&other) noexcept=default
	Move Assignment.
BinnedGroup< grid_t > &	operator= (const BinnedGroup< grid_t > &other)=delete
	Copy assignment.

Public Attributes
friend	BinnedGroupIterator< grid_t >
	Friend iterator class for accessing private members.

Static Public Attributes
static constexpr std::size_t	DIM = grid_t::DIM
	Dimension of the underlying grid.

Detailed Description

template<typename grid_t>
class Acts::BinnedGroup< grid_t >

Template Parameters

grid_t

Type of the grid the group owns

The assumption is that the grid has ownership of the space points and that the grid value_type (i.e. T in Grid<T, Axes ...>) is an iterable object of space points, such as a vector< ... >

Constructor & Destructor Documentation

BinnedGroup() [1/6]

template<typename grid_t>

Acts::BinnedGroup< grid_t >::BinnedGroup ( )

delete

Default constructor.

BinnedGroup() [2/6]

template<typename grid_t>

Acts::BinnedGroup< grid_t >::BinnedGroup	(	grid_t &&	grid,
		const GridBinFinder< DIM > &	bottomFinder,
		const GridBinFinder< DIM > &	topFinder,
		std::array< std::vector< std::size_t >, DIM >	navigation = std::array< std::vector< std::size_t >, DIM >() )

brief Constructor

Parameters

grid	The grid to use for binning
bottomFinder	The bottom bin finder
topFinder	The top bin finder
navigation	The navigation array for grid bins

BinnedGroup() [3/6]

template<typename grid_t>

Acts::BinnedGroup< grid_t >::BinnedGroup	(	grid_t &&	grid,
		std::vector< bool >	mask,
		const GridBinFinder< DIM > &	bottomFinder,
		const GridBinFinder< DIM > &	topFinder,
		std::array< std::vector< std::size_t >, DIM >	navigation = std::array< std::vector< std::size_t >, DIM >() )

Constructor with grid, mask, and finders.

Parameters

grid	Grid object (moved)
mask	Vector of boolean masks
bottomFinder	Bottom bin finder
topFinder	Top bin finder
navigation	Navigation array (optional)

BinnedGroup() [4/6]

template<typename grid_t>

Acts::BinnedGroup< grid_t >::BinnedGroup ( grid_t & grid, const GridBinFinder< DIM > & bottomFinder, const GridBinFinder< DIM > & topFinder, std::array< std::vector< std::size_t >, DIM > navigation = std::array< std::vector< std::size_t >, DIM >() )

delete

BinnedGroup() [5/6]

template<typename grid_t>

Acts::BinnedGroup< grid_t >::BinnedGroup ( const BinnedGroup< grid_t > & other )

delete

Copy constructor.

Parameters

[in]

other

The BinnedGroup to copy

BinnedGroup() [6/6]

template<typename grid_t>

Acts::BinnedGroup< grid_t >::BinnedGroup ( BinnedGroup< grid_t > && other )

defaultnoexcept

Move Constructor.

Parameters

[in]

other

The BinnedGroup to move

~BinnedGroup()

template<typename grid_t>

Acts::BinnedGroup< grid_t >::~BinnedGroup ( )

default

Default destructor.

Member Function Documentation

begin()

template<typename grid_t>

BinnedGroupIterator< grid_t > Acts::BinnedGroup< grid_t >::begin

(

)

const

Get the begin iterator.

Returns

The iterator

end()

template<typename grid_t>

BinnedGroupIterator< grid_t > Acts::BinnedGroup< grid_t >::end

(

)

const

Get the end iterator.

Returns

The iterator

grid() [1/2]

template<typename grid_t>

grid_t & Acts::BinnedGroup< grid_t >::grid

(

)

Retrieve mutable reference to the Grid.

Returns

Mutable reference to the stored grid

grid() [2/2]

template<typename grid_t>

const grid_t & Acts::BinnedGroup< grid_t >::grid

(

)

const

Retrieve const reference to the Grid.

Returns

Const reference to the stored grid

mask()

template<typename grid_t>

const std::vector< bool > & Acts::BinnedGroup< grid_t >::mask

(

)

const

Retrieve the mask Only const accessor is supported.

Returns

The mask

operator=() [1/2]

template<typename grid_t>

BinnedGroup< grid_t > & Acts::BinnedGroup< grid_t >::operator= ( BinnedGroup< grid_t > && other )

defaultnoexcept

Move Assignment.

Parameters

[in]

other

The BinnedGroup to move

Returns

The moved BinnedGroup

operator=() [2/2]

template<typename grid_t>

BinnedGroup< grid_t > & Acts::BinnedGroup< grid_t >::operator= ( const BinnedGroup< grid_t > & other )

delete

Copy assignment.

Parameters

[in]

other

The BinnedGroup to copy

Returns

The copied BinnedGroup

Member Data Documentation

BinnedGroupIterator< grid_t >

template<typename grid_t>

friend Acts::BinnedGroup< grid_t >::BinnedGroupIterator< grid_t >

Friend iterator class for accessing private members.

DIM

template<typename grid_t>

std::size_t Acts::BinnedGroup< grid_t >::DIM = grid_t::DIM

staticconstexpr

Dimension of the underlying grid.