Acts::BinnedGroupIterator< grid_t > Class Template Reference

Iterator over a binned group grid neighborhood. More...

#include <Acts/Seeding/BinnedGroupIterator.hpp>

Public Member Functions
	BinnedGroupIterator (BinnedGroup< grid_t > &&group, std::array< std::size_t, DIM > index, std::array< std::vector< std::size_t >, DIM > navigation)=delete
	Constructor Never take the ownership of the group.
	BinnedGroupIterator (BinnedGroupIterator< grid_t > &&other) noexcept=default
	Move Constructor.
	BinnedGroupIterator (const BinnedGroup< grid_t > &&group, std::array< std::size_t, DIM > index, std::array< std::vector< std::size_t >, DIM > navigation)=delete
	Constructor Never take the ownership of the group.
	BinnedGroupIterator (const BinnedGroup< grid_t > &group, std::array< std::size_t, DIM > index, std::array< std::vector< std::size_t >, DIM > navigation)
	Constructor.
	BinnedGroupIterator (const BinnedGroupIterator< grid_t > &other)=delete
	Do not allow Copy operations.
	~BinnedGroupIterator ()=default
	Default Destructor.
std::tuple< boost::container::small_vector< std::size_t, detail::ipow(3, grid_t::DIM)>, std::size_t, boost::container::small_vector< std::size_t, detail::ipow(3, grid_t::DIM)> >	operator* () const
	Return the current bin with the middle candidate, as well as all the bins with the possible bottom and top candidates.
BinnedGroupIterator< grid_t > &	operator++ ()
	Increment the iterator by one (pre).
BinnedGroupIterator< grid_t > &	operator= (BinnedGroupIterator &&other) noexcept=default
	Move assignment.
BinnedGroupIterator< grid_t > &	operator= (const BinnedGroupIterator< grid_t > &other)=delete
	Copy assignment.
bool	operator== (const BinnedGroupIterator< grid_t > &other) const
	Equality operator.

Static Public Attributes
static constexpr std::size_t	DIM = grid_t::DIM
	Grid dimensionality.

Detailed Description

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

Iterator over a binned group grid neighborhood.

Template Parameters

grid_t

Grid type used by the group.

Constructor & Destructor Documentation

BinnedGroupIterator() [1/5]

template<typename grid_t>

Acts::BinnedGroupIterator< grid_t >::BinnedGroupIterator ( BinnedGroup< grid_t > && group, std::array< std::size_t, DIM > index, std::array< std::vector< std::size_t >, DIM > navigation )

delete

Constructor Never take the ownership of the group.

Parameters

[in]	group	The group we are iterating on
[in]	index	Current local position in the grid
[in]	navigation	The navigation pattern in the grid

BinnedGroupIterator() [2/5]

template<typename grid_t>

Acts::BinnedGroupIterator< grid_t >::BinnedGroupIterator ( const BinnedGroup< grid_t > && group, std::array< std::size_t, DIM > index, std::array< std::vector< std::size_t >, DIM > navigation )

delete

Constructor Never take the ownership of the group.

Parameters

[in]	group	The group we are iterating on
[in]	index	Current local position in the grid
[in]	navigation	The navigation pattern in the grid

BinnedGroupIterator() [3/5]

template<typename grid_t>

Acts::BinnedGroupIterator< grid_t >::BinnedGroupIterator	(	const BinnedGroup< grid_t > &	group,
		std::array< std::size_t, DIM >	index,
		std::array< std::vector< std::size_t >, DIM >	navigation )

Constructor.

Parameters

[in]	group	The group we are iterating on
[in]	index	Current local position in the grid
[in]	navigation	The navigation pattern in the grid

BinnedGroupIterator() [4/5]

template<typename grid_t>

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

delete

Do not allow Copy operations.

Copy Constructor

Parameters

[in]

other

The BinnedGroupIterator to copy

BinnedGroupIterator() [5/5]

template<typename grid_t>

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

defaultnoexcept

Move Constructor.

Parameters

[in]

other

The BinnedGroupIterator to move

Member Function Documentation

operator*()

template<typename grid_t>

std::tuple< boost::container::small_vector< std::size_t, detail::ipow(3, grid_t::DIM)>, std::size_t, boost::container::small_vector< std::size_t, detail::ipow(3, grid_t::DIM)> > Acts::BinnedGroupIterator< grid_t >::operator*

(

)

const

Return the current bin with the middle candidate, as well as all the bins with the possible bottom and top candidates.

Returns

The collection of all the bins in the grid

operator++()

template<typename grid_t>

BinnedGroupIterator< grid_t > & Acts::BinnedGroupIterator< grid_t >::operator++

(

)

Increment the iterator by one (pre).

Returns

The incremented iterator

operator=() [1/2]

template<typename grid_t>

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

defaultnoexcept

Move assignment.

Parameters

[in]

other

The BinnedGroupIterator to move

Returns

The moved BinnedGroupIterator

operator=() [2/2]

template<typename grid_t>

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

delete

Copy assignment.

Parameters

[in]

other

The BinnedGroupIterator to copy

Returns

The copied BinnedGroupIterator

operator==()

template<typename grid_t>

bool Acts::BinnedGroupIterator< grid_t >::operator==

(

const BinnedGroupIterator< grid_t > &

other

)

const

Equality operator.

Parameters

[in]

other

The BinnedGroupIterator we are comparing against this one

Returns

The result of the comparison