#include <OpenMS/DATASTRUCTURES/ExposedVector.h>

Inheritance diagram for ExposedVector< VectorElement >:

Collaboration diagram for ExposedVector< VectorElement >:

Public Types
using	VecMember = std::vector< VectorElement >

using	value_type = typename VecMember::value_type

using	iterator = typename VecMember::iterator

using	const_iterator = typename VecMember::const_iterator

using	reverse_iterator = typename VecMember::reverse_iterator

using	const_reverse_iterator = typename VecMember::const_reverse_iterator

using	size_type = typename VecMember::size_type

using	pointer = typename VecMember::pointer

using	reference = typename VecMember::reference

using	const_reference = typename VecMember::const_reference

using	difference_type = typename VecMember::difference_type

Public Member Functions
	ExposedVector ()=default

	ExposedVector (const size_t n)

	ExposedVector (const size_t n, const VectorElement &val)

template<class Iter >
	ExposedVector (Iter begin, Iter end)

	ExposedVector (const ExposedVector &rhs)=default
	Copy C'tor. More...

	ExposedVector (ExposedVector &&rhs) noexcept=default
	Move C'tor. More...

ExposedVector &	operator= (const ExposedVector &rhs)=default
	Assignment. More...

ExposedVector &	operator= (ExposedVector &&rhs) noexcept=default
	Move Assignment. More...

iterator	begin () noexcept

iterator	end () noexcept

const_iterator	begin () const noexcept

const_iterator	end () const noexcept

const_iterator	cbegin () const noexcept

const_iterator	cend () const noexcept

size_t	size () const noexcept

void	resize (const size_t new_size)

void	reserve (const size_t new_size)

bool	empty () const noexcept

VectorElement &	operator[] (size_t i) noexcept

const VectorElement &	operator[] (size_t i) const noexcept

VectorElement &	at (size_t i)

const VectorElement &	at (size_t i) const

VectorElement &	back () noexcept

const VectorElement &	back () const noexcept

void	push_back (const VectorElement &f)

void	push_back (VectorElement &&f)

template<typename... Args>
decltype(auto)	emplace_back (Args &&... args)

void	pop_back () noexcept

iterator	erase (const_iterator where) noexcept

iterator	erase (const_iterator from, const_iterator to) noexcept

template<typename T >
iterator	insert (const_iterator where, T from, T to)

void	clear () noexcept
	Clear all elements. More...

reverse_iterator	rbegin () noexcept
	Get reverse iterator to beginning. More...

const_reverse_iterator	rbegin () const noexcept
	Get const reverse iterator to beginning. More...

reverse_iterator	rend () noexcept
	Get reverse iterator to end. More...

const_reverse_iterator	rend () const noexcept
	Get const reverse iterator to end. More...

const_reverse_iterator	crbegin () const noexcept
	Get const reverse iterator to beginning. More...

const_reverse_iterator	crend () const noexcept
	Get const reverse iterator to end. More...

void	swap (ExposedVector &other) noexcept
	Swap contents with another ExposedVector. More...

template<typename InputIt >
void	assign (InputIt first, InputIt last)
	Assign values from iterators. More...

void	assign (size_type count, const VectorElement &value)
	Assign n copies of value. More...

void	assign (std::initializer_list< VectorElement > init)
	Assign from initializer list. More...

VectorElement &	front () noexcept
	Get first element. More...

const VectorElement &	front () const noexcept
	Get first element (const) More...

size_type	max_size () const noexcept
	Get maximum possible size. More...

size_type	capacity () const noexcept
	Get current capacity. More...

void	shrink_to_fit ()
	Shrink capacity to fit size. More...

iterator	insert (const_iterator pos, const VectorElement &value)
	Insert single element. More...

iterator	insert (const_iterator pos, VectorElement &&value)
	Insert single element (move) More...

iterator	insert (const_iterator pos, size_type count, const VectorElement &value)
	Insert n copies of value. More...

iterator	insert (const_iterator pos, std::initializer_list< VectorElement > init)
	Insert from initializer list. More...

template<typename... Args>
iterator	emplace (const_iterator pos, Args &&... args)
	Emplace element at position. More...

const VecMember &	getData () const
	read-only access to the underlying data More...

VecMember &	getData ()
	read access to the underlying data More...

bool	operator== (const ExposedVector &other) const
	Equality comparison. More...

bool	operator!= (const ExposedVector &other) const
	Inequality comparison. More...

bool	operator< (const ExposedVector &other) const requires LessThanComparable< VectorElement >

bool	operator<= (const ExposedVector &other) const requires LessThanComparable< VectorElement >

bool	operator> (const ExposedVector &other) const requires LessThanComparable< VectorElement >

bool	operator>= (const ExposedVector &other) const requires LessThanComparable< VectorElement >

Protected Attributes
VecMember	data_
	the container which holds all the data More...

Detailed Description

template<class VectorElement>
class OpenMS::ExposedVector< VectorElement >

@brief Makes a vector<VectorElement> available in the derived class and exposed commonly
       used vector member functions at class level.

This saves writing repetitive code which forwards commonly used functions of a data member, e.g. 'data_.begin()' 
as a member function of the class. Also it makes private inheritance from vector<VectorElement> obsolete.
The latter is problematic for many reasons (read up on 'prefer composition over inheritance'). In our case, even linking
can be problematic with private inheritance once you require RTTI (which some tools do, e.g. softwipe).

To fully utilize this class (i.e. access the 'iterator' type), insert

EXPOSED_VECTOR_INTERFACE(VectorElement)

EXPOSED_VECTOR_INTERFACE

#define EXPOSED_VECTOR_INTERFACE(InnerElement)

Macro to expose common dependent types, such as iterator in the derived class.

Definition: ExposedVector.h:26

in your derived class, where VectorElement is identical to the template argument of ExposedVector, e.g. 'Feature' for FeatureMap.

Member Typedef Documentation

◆ const_iterator

using const_iterator = typename VecMember::const_iterator

◆ const_reference

using const_reference = typename VecMember::const_reference

◆ const_reverse_iterator

using const_reverse_iterator = typename VecMember::const_reverse_iterator

◆ difference_type

using difference_type = typename VecMember::difference_type

◆ iterator

using iterator = typename VecMember::iterator

◆ pointer

using pointer = typename VecMember::pointer

◆ reference

using reference = typename VecMember::reference

◆ reverse_iterator

using reverse_iterator = typename VecMember::reverse_iterator

◆ size_type

using size_type = typename VecMember::size_type

◆ value_type

using value_type = typename VecMember::value_type

◆ VecMember

using VecMember = std::vector<VectorElement>

Constructor & Destructor Documentation

◆ ExposedVector() [1/6]

ExposedVector ( )

default

◆ ExposedVector() [2/6]

ExposedVector ( const size_t n )

inlineexplicit

◆ ExposedVector() [3/6]

ExposedVector	(	const size_t	n,
		const VectorElement &	val
	)

inline

◆ ExposedVector() [4/6]

ExposedVector	(	Iter	begin,
		Iter	end
	)

inline

◆ ExposedVector() [5/6]

ExposedVector ( const ExposedVector< VectorElement > & rhs )

default

Copy C'tor.

◆ ExposedVector() [6/6]

ExposedVector ( ExposedVector< VectorElement > && rhs )

defaultnoexcept

Move C'tor.

Member Function Documentation

◆ assign() [1/3]

void assign	(	InputIt	first,
		InputIt	last
	)

inline

Assign values from iterators.

References ExposedVector< VectorElement >::data_.

◆ assign() [2/3]

void assign	(	size_type	count,
		const VectorElement &	value
	)

inline

Assign n copies of value.

References ExposedVector< VectorElement >::data_.

◆ assign() [3/3]

void assign ( std::initializer_list< VectorElement > init )

inline

Assign from initializer list.

References ExposedVector< VectorElement >::data_.

◆ at() [1/2]

VectorElement& at ( size_t i )

inline

References ExposedVector< VectorElement >::data_.

◆ at() [2/2]

const VectorElement& at ( size_t i ) const

inline

References ExposedVector< VectorElement >::data_.

◆ back() [1/2]

const VectorElement& back ( ) const

inlinenoexcept

References ExposedVector< VectorElement >::data_.

◆ back() [2/2]

VectorElement& back ( )

inlinenoexcept

References ExposedVector< VectorElement >::data_.

◆ begin() [1/2]

const_iterator begin ( ) const

inlinenoexcept

References ExposedVector< VectorElement >::data_.

◆ begin() [2/2]

iterator begin ( )

inlinenoexcept

References ExposedVector< VectorElement >::data_.

Referenced by TOPPViewBase::addDataFile(), IDFilter::FilterPeptideEvidences(), IDConflictResolverAlgorithm::resolveBetweenFeatures_(), and ConfidenceScoring::scoreMap().

◆ capacity()

size_type capacity ( ) const

inlinenoexcept

Get current capacity.

References ExposedVector< VectorElement >::data_.

◆ cbegin()

const_iterator cbegin ( ) const

inlinenoexcept

References ExposedVector< VectorElement >::data_.

◆ cend()

const_iterator cend ( ) const

inlinenoexcept

References ExposedVector< VectorElement >::data_.

◆ clear()

void clear ( )

inlinenoexcept

Clear all elements.

References ExposedVector< VectorElement >::data_.

◆ crbegin()

const_reverse_iterator crbegin ( ) const

inlinenoexcept

Get const reverse iterator to beginning.

References ExposedVector< VectorElement >::data_.

◆ crend()

const_reverse_iterator crend ( ) const

inlinenoexcept

Get const reverse iterator to end.

References ExposedVector< VectorElement >::data_.

◆ emplace()

iterator emplace	(	const_iterator	pos,
		Args &&...	args
	)

inline

Emplace element at position.

References ExposedVector< VectorElement >::data_.

◆ emplace_back()

decltype(auto) emplace_back ( Args &&... args )

inline

References ExposedVector< VectorElement >::data_.

◆ empty()

bool empty ( ) const

inlinenoexcept

References ExposedVector< VectorElement >::data_.

Referenced by TOPPViewBase::addDataFile(), IDScoreSwitcherAlgorithm::determineScoreNameOrientationAndType(), FeatureFinderIdentificationAlgorithm::FeatureFilterPeptides::operator()(), IDConflictResolverAlgorithm::resolveBetweenFeatures_(), FeatureFinderAlgorithm::setSeeds(), and IDScoreSwitcherAlgorithm::switchScores().

◆ end() [1/2]

const_iterator end ( ) const

inlinenoexcept

References ExposedVector< VectorElement >::data_.

◆ end() [2/2]

iterator end ( )

inlinenoexcept

References ExposedVector< VectorElement >::data_.

Referenced by TOPPViewBase::addDataFile(), IDFilter::FilterPeptideEvidences(), IDConflictResolverAlgorithm::resolveBetweenFeatures_(), and ConfidenceScoring::scoreMap().

◆ erase() [1/2]

iterator erase	(	const_iterator	from,
		const_iterator	to
	)

inlinenoexcept

References ExposedVector< VectorElement >::data_.

◆ erase() [2/2]

iterator erase ( const_iterator where )

inlinenoexcept

References ExposedVector< VectorElement >::data_.

◆ front() [1/2]

const VectorElement& front ( ) const

inlinenoexcept

Get first element (const)

References ExposedVector< VectorElement >::data_.

◆ front() [2/2]

VectorElement& front ( )

inlinenoexcept

Get first element.

References ExposedVector< VectorElement >::data_.

Referenced by IDConflictResolverAlgorithm::resolveBetweenFeatures_().

◆ getData() [1/2]

VecMember& getData ( )

inline

read access to the underlying data

References ExposedVector< VectorElement >::data_.

◆ getData() [2/2]

const VecMember& getData ( ) const

inline

read-only access to the underlying data

References ExposedVector< VectorElement >::data_.

Referenced by IDFilter::filterHitsByRank(), IDFilter::filterHitsByScore(), IDFilter::getBestHit(), IDFilter::keepHitsMatchingProteins(), IDFilter::removeDecoyHits(), IDFilter::removeHitsMatchingProteins(), IDFilter::removeUnreferencedProteins(), and IDScoreSwitcherAlgorithm::switchToGeneralScoreType().

◆ insert() [1/5]

iterator insert	(	const_iterator	pos,
		const VectorElement &	value
	)

inline

Insert single element.

References ExposedVector< VectorElement >::data_.

◆ insert() [2/5]

iterator insert	(	const_iterator	pos,
		size_type	count,
		const VectorElement &	value
	)

inline

Insert n copies of value.

References ExposedVector< VectorElement >::data_.

◆ insert() [3/5]

iterator insert	(	const_iterator	pos,
		std::initializer_list< VectorElement >	init
	)

inline

Insert from initializer list.

References ExposedVector< VectorElement >::data_.

◆ insert() [4/5]

iterator insert	(	const_iterator	pos,
		VectorElement &&	value
	)

inline

Insert single element (move)

References ExposedVector< VectorElement >::data_.

◆ insert() [5/5]

iterator insert	(	const_iterator	where,
		T	from,
		T	to
	)

inline

References ExposedVector< VectorElement >::data_.

Referenced by IDConflictResolverAlgorithm::resolveBetweenFeatures_().

◆ max_size()

size_type max_size ( ) const

inlinenoexcept

Get maximum possible size.

References ExposedVector< VectorElement >::data_.

◆ operator!=()

bool operator!= ( const ExposedVector< VectorElement > & other ) const

inline

Inequality comparison.

References ExposedVector< VectorElement >::data_.

◆ operator<()

bool operator< ( const ExposedVector< VectorElement > & other ) const

inline

References ExposedVector< VectorElement >::data_.

◆ operator<=()

bool operator<= ( const ExposedVector< VectorElement > & other ) const

inline

References ExposedVector< VectorElement >::data_.

◆ operator=() [1/2]

ExposedVector& operator= ( const ExposedVector< VectorElement > & rhs )

default

Assignment.

◆ operator=() [2/2]

ExposedVector& operator= ( ExposedVector< VectorElement > && rhs )

defaultnoexcept

Move Assignment.

◆ operator==()

bool operator== ( const ExposedVector< VectorElement > & other ) const

inline

Equality comparison.

References ExposedVector< VectorElement >::data_.

◆ operator>()

bool operator> ( const ExposedVector< VectorElement > & other ) const

inline

References ExposedVector< VectorElement >::data_.

◆ operator>=()

bool operator>= ( const ExposedVector< VectorElement > & other ) const

inline

References ExposedVector< VectorElement >::data_.

◆ operator[]() [1/2]

const VectorElement& operator[] ( size_t i ) const

inlinenoexcept

References ExposedVector< VectorElement >::data_.

◆ operator[]() [2/2]

VectorElement& operator[] ( size_t i )

inlinenoexcept

References ExposedVector< VectorElement >::data_.

◆ pop_back()

void pop_back ( )

inlinenoexcept

References ExposedVector< VectorElement >::data_.

◆ push_back() [1/2]

void push_back ( const VectorElement & f )

inline

References ExposedVector< VectorElement >::data_.

Referenced by TOPPViewBase::addDataFile().

◆ push_back() [2/2]

void push_back ( VectorElement && f )

inline

References ExposedVector< VectorElement >::data_.

◆ rbegin() [1/2]

const_reverse_iterator rbegin ( ) const

inlinenoexcept

Get const reverse iterator to beginning.

References ExposedVector< VectorElement >::data_.

◆ rbegin() [2/2]

reverse_iterator rbegin ( )

inlinenoexcept

Get reverse iterator to beginning.

References ExposedVector< VectorElement >::data_.

◆ rend() [1/2]

const_reverse_iterator rend ( ) const

inlinenoexcept

Get const reverse iterator to end.

References ExposedVector< VectorElement >::data_.

◆ rend() [2/2]

reverse_iterator rend ( )

inlinenoexcept

Get reverse iterator to end.

References ExposedVector< VectorElement >::data_.

◆ reserve()

void reserve ( const size_t new_size )

inline

References ExposedVector< VectorElement >::data_.

◆ resize()

void resize ( const size_t new_size )

inline

References ExposedVector< VectorElement >::data_.

◆ shrink_to_fit()

void shrink_to_fit ( )

inline

Shrink capacity to fit size.

References ExposedVector< VectorElement >::data_.

◆ size()

size_t size ( ) const

inlinenoexcept

References ExposedVector< VectorElement >::data_.

Referenced by TOPPViewBase::addDataFile(), NuXLLinearRescore::apply(), IDMapper::mapPrecursorsToIdentifications(), IDConflictResolverAlgorithm::resolveBetweenFeatures_(), and ConfidenceScoring::scoreMap().

◆ swap()

void swap ( ExposedVector< VectorElement > & other )

inlinenoexcept

Swap contents with another ExposedVector.

References ExposedVector< VectorElement >::data_.

Referenced by TOPPViewBase::addDataFile().

Member Data Documentation

◆ data_

VecMember data_

protected

the container which holds all the data

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<class VectorElement> class OpenMS::ExposedVector< VectorElement >

Member Typedef Documentation

◆ const_iterator

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ iterator

◆ pointer

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_type

◆ VecMember

Constructor & Destructor Documentation

◆ ExposedVector() [1/6]

◆ ExposedVector() [2/6]

◆ ExposedVector() [3/6]

◆ ExposedVector() [4/6]

◆ ExposedVector() [5/6]

◆ ExposedVector() [6/6]

Member Function Documentation

◆ assign() [1/3]

◆ assign() [2/3]

◆ assign() [3/3]

◆ at() [1/2]

◆ at() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ capacity()

◆ cbegin()

◆ cend()

◆ clear()

◆ crbegin()

◆ crend()

◆ emplace()

◆ emplace_back()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ front() [1/2]

◆ front() [2/2]

◆ getData() [1/2]

◆ getData() [2/2]

◆ insert() [1/5]

◆ insert() [2/5]

◆ insert() [3/5]

◆ insert() [4/5]

◆ insert() [5/5]

◆ max_size()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pop_back()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ reserve()

◆ resize()

◆ shrink_to_fit()

◆ size()

◆ swap()

Member Data Documentation

template<class VectorElement>
class OpenMS::ExposedVector< VectorElement >