bitpit::PiercedKernelRange< id_t > Class Template Reference

The PiercedKernelRange allow to iterate using range-based loops over a PiercedStorage. More...

#include <piercedKernelRange.hpp>

Inheritance diagram for bitpit::PiercedKernelRange< id_t >:

Public Types
typedef const_iterator_t	const_iterator
typedef id_t	id_type
typedef kernel_t	kernel_type

Public Member Functions
	PiercedKernelRange ()
	PiercedKernelRange (const const_iterator &begin, const const_iterator &end)
	PiercedKernelRange (const kernel_t *kernel)
	PiercedKernelRange (const kernel_t *kernel, id_t first, id_t last)
const_iterator	begin () const noexcept
const_iterator	cbegin () const noexcept
const_iterator	cend () const noexcept
const_iterator	end () const noexcept
std::size_t	evalSize () const
void	initialize (const const_iterator &begin, const const_iterator &end)
void	initialize (const kernel_t *kernel)
void	initialize (const kernel_t *kernel, id_t first, id_t last)
template<typename other_id_t = long>
bool	operator!= (const PiercedKernelRange< other_id_t > &rhs) const
template<typename other_id_t = long>
bool	operator== (const PiercedKernelRange< other_id_t > &rhs) const
void	swap (PiercedKernelRange &other) noexcept

Protected Attributes
const_iterator	m_cbegin
const_iterator	m_cend

Friends
template<typename PK_id_t>
class	PiercedKernel

Detailed Description

template<typename id_t = long>
class bitpit::PiercedKernelRange< id_t >

The PiercedKernelRange allow to iterate using range-based loops over a PiercedStorage.

Definition at line 35 of file piercedKernelRange.hpp.

Member Typedef Documentation

const_iterator

template<typename id_t = long>

typedef const_iterator_t bitpit::PiercedKernelRange< id_t >::const_iterator

Type of constant iterator

Definition at line 66 of file piercedKernelRange.hpp.

id_type

template<typename id_t = long>

typedef id_t bitpit::PiercedKernelRange< id_t >::id_type

Type of ids stored in the container

Definition at line 63 of file piercedKernelRange.hpp.

kernel_type

template<typename id_t = long>

typedef kernel_t bitpit::PiercedKernelRange< id_t >::kernel_type

Kernel type

Definition at line 60 of file piercedKernelRange.hpp.

Constructor & Destructor Documentation

PiercedKernelRange() [1/4]

template<typename id_t>

bitpit::PiercedKernelRange< id_t >::PiercedKernelRange

(

)

Constructor.

Definition at line 34 of file piercedKernelRange.tpp.

PiercedKernelRange() [2/4]

template<typename id_t>

bitpit::PiercedKernelRange< id_t >::PiercedKernelRange

(

const kernel_t *

kernel

)

Constructor.

Parameters

kernel

is the kernel that will be associated to the range

Definition at line 46 of file piercedKernelRange.tpp.

PiercedKernelRange() [3/4]

template<typename id_t>

bitpit::PiercedKernelRange< id_t >::PiercedKernelRange	(	const kernel_t *	kernel,
		id_t	first,
		id_t	last )

Constructor.

Parameters

kernel	is the kernel that will be associated to the range
first	is the id of the first element in the range
last	is the id of the last element in the range

Definition at line 59 of file piercedKernelRange.tpp.

PiercedKernelRange() [4/4]

template<typename id_t>

bitpit::PiercedKernelRange< id_t >::PiercedKernelRange	(	const const_iterator &	begin,
		const const_iterator &	end )

Constructor.

Parameters

begin	is the begin of the range
end	is the end of the range

Definition at line 71 of file piercedKernelRange.tpp.

Member Function Documentation

begin()

template<typename id_t>

PiercedKernelRange< id_t >::const_iterator bitpit::PiercedKernelRange< id_t >::begin ( ) const

noexcept

Returns a constant iterator pointing to the first element in the range.

Returns

A constant iterator pointing to the first element in the range.

Definition at line 161 of file piercedKernelRange.tpp.

cbegin()

template<typename id_t>

PiercedKernelRange< id_t >::const_iterator bitpit::PiercedKernelRange< id_t >::cbegin ( ) const

noexcept

Returns a constant iterator pointing to the first element in the range.

Returns

A constant iterator pointing to the first element in the range.

Definition at line 185 of file piercedKernelRange.tpp.

cend()

template<typename id_t>

PiercedKernelRange< id_t >::const_iterator bitpit::PiercedKernelRange< id_t >::cend ( ) const

noexcept

Returns a constant iterator pointing to the past-the-end element in the range.

Returns

A constant iterator pointing to the past-the-end element in the range.

Definition at line 198 of file piercedKernelRange.tpp.

end()

template<typename id_t>

PiercedKernelRange< id_t >::const_iterator bitpit::PiercedKernelRange< id_t >::end ( ) const

noexcept

Returns a constant iterator pointing to the past-the-end element in the range.

Returns

A constant iterator pointing to the past-the-end element in the range.

Definition at line 174 of file piercedKernelRange.tpp.

evalSize()

template<typename id_t>

std::size_t bitpit::PiercedKernelRange< id_t >::evalSize

(

)

const

Evaluates the number of elements contained in the range.

Returns

The number of elements contained in the range.

Definition at line 137 of file piercedKernelRange.tpp.

initialize() [1/3]

template<typename id_t>

void bitpit::PiercedKernelRange< id_t >::initialize	(	const const_iterator &	begin,
		const const_iterator &	end )

Initialize the range.

Parameters

begin	is the begin of the range
end	is the end of the range

Definition at line 109 of file piercedKernelRange.tpp.

initialize() [2/3]

template<typename id_t>

void bitpit::PiercedKernelRange< id_t >::initialize

(

const kernel_t *

kernel

)

Initialize the range.

Parameters

kernel

is the kernel that will be associated to the range

Definition at line 82 of file piercedKernelRange.tpp.

initialize() [3/3]

template<typename id_t>

void bitpit::PiercedKernelRange< id_t >::initialize	(	const kernel_t *	kernel,
		id_t	first,
		id_t	last )

Initialize the range.

Parameters

kernel	is the kernel that will be associated to the range
first	is the id of the first element in the range
last	is the id of the last element in the range

Definition at line 96 of file piercedKernelRange.tpp.

operator!=()

template<typename id_t = long>

template<typename other_id_t = long>

bool bitpit::PiercedKernelRange< id_t >::operator!= ( const PiercedKernelRange< other_id_t > & rhs ) const

inline

Two-way comparison.

Definition at line 110 of file piercedKernelRange.hpp.

operator==()

template<typename id_t = long>

template<typename other_id_t = long>

bool bitpit::PiercedKernelRange< id_t >::operator== ( const PiercedKernelRange< other_id_t > & rhs ) const

inline

Two-way comparison.

Definition at line 93 of file piercedKernelRange.hpp.

swap()

template<typename id_t>

void bitpit::PiercedKernelRange< id_t >::swap ( PiercedKernelRange< id_t > & other )

noexcept

Exchanges the values of the current range and the range recevied as argument.

Parameters

other

the range to exchange values with

Definition at line 125 of file piercedKernelRange.tpp.

Friends And Related Symbol Documentation

PiercedKernel

template<typename id_t = long>

template<typename PK_id_t>

friend class PiercedKernel

friend

Definition at line 39 of file piercedKernelRange.hpp.

Member Data Documentation

m_cbegin

template<typename id_t = long>

const_iterator bitpit::PiercedKernelRange< id_t >::m_cbegin

protected

Begin

Definition at line 125 of file piercedKernelRange.hpp.

m_cend

template<typename id_t = long>

const_iterator bitpit::PiercedKernelRange< id_t >::m_cend

protected

End

Definition at line 128 of file piercedKernelRange.hpp.

---

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

• src/containers/piercedKernelRange.hpp
• src/containers/piercedKernelRange.tpp