List with Efficient Lookup. More...

#include <fastlist.h>

Collaboration diagram for GMAD::FastList< T >:

Public Types
using	FastListIterator = typename std::list< T >::iterator
	for ease of reading

using	FastListConstIterator = typename std::list< T >::const_iterator

using	FastMapIterator = typename std::multimap< std::string, FastListIterator >::iterator

using	FastMapConstIterator = typename std::multimap< std::string, FastListIterator >::const_iterator

using	FastMapIteratorPair = std::pair< FastMapIterator, FastMapIterator >

using	FastMapConstIteratorPair = std::pair< FastMapConstIterator, FastMapConstIterator >

Public Member Functions
void	insert_before (const std::string &name, const T &val)

void	push_back (const T &el, bool unique=false, const std::string &objectName="element")

bool	empty () const
	Whether the list is empty.

int	size () const
	size of list

void	clear ()
	empty lists

std::vector< T >	getVector () const
	Get a vector version of this list.

std::map< std::string, T >	getMap () const
	Get a map of name to object of this list.

FastMapIteratorPair	equal_range (std::string name)

FastMapConstIteratorPair	equal_range (std::string name) const

void	print (int ident=0) const
	print method


template<typename FastListInputIterator >
FastListIterator	insert (FastListInputIterator position, const T &val)
	template definitions need to be in header

template<typename FastListInputIterator >
void	insert (FastListConstIterator position, FastListInputIterator first, const FastListInputIterator last)
	template definitions need to be in header


void	erase ()
	erase elements

FastListConstIterator	erase (const FastListConstIterator position)
	erase elements

FastListConstIterator	erase (const FastListConstIterator first, const FastListConstIterator last)
	erase elements


FastListIterator	begin ()

FastListIterator	end ()


FastListConstIterator	begin () const

FastListConstIterator	end () const


FastListConstIterator	find (std::string name, unsigned int count=1) const

FastListIterator	find (std::string name, unsigned int count=1)

Private Attributes
std::list< T >	itsList

std::multimap< std::string, FastListIterator >	itsMap
	multimap for name lookup

Detailed Description

template<typename T>
class GMAD::FastList< T >

List with Efficient Lookup.

This class keeps a list of elements It has efficient lookup on an element's name (log n) by having a multimap between name and list position

Used for beamline

Author: Jochem Snuverink

Definition at line 41 of file fastlist.h.

Member Typedef Documentation

◆ FastListConstIterator

template<typename T >

using GMAD::FastList< T >::FastListConstIterator = typename std::list<T>::const_iterator

Definition at line 46 of file fastlist.h.

◆ FastListIterator

template<typename T >

using GMAD::FastList< T >::FastListIterator = typename std::list<T>::iterator

for ease of reading

Definition at line 45 of file fastlist.h.

◆ FastMapConstIterator

template<typename T >

using GMAD::FastList< T >::FastMapConstIterator = typename std::multimap<std::string, FastListIterator>::const_iterator

Definition at line 48 of file fastlist.h.

◆ FastMapConstIteratorPair

template<typename T >

using GMAD::FastList< T >::FastMapConstIteratorPair = std::pair<FastMapConstIterator,FastMapConstIterator>

Definition at line 50 of file fastlist.h.

◆ FastMapIterator

template<typename T >

using GMAD::FastList< T >::FastMapIterator = typename std::multimap<std::string, FastListIterator>::iterator

Definition at line 47 of file fastlist.h.

◆ FastMapIteratorPair

template<typename T >

using GMAD::FastList< T >::FastMapIteratorPair = std::pair<FastMapIterator,FastMapIterator>

Definition at line 49 of file fastlist.h.

Member Function Documentation

◆ begin() [1/2]

template<typename T >

FastList< T >::FastListIterator GMAD::FastList< T >::begin ( )

non-const begin/end iterator:

Definition at line 217 of file fastlist.h.

Referenced by BDSDetectorConstruction::BuildBeamline(), GMAD::Parser::expand_line(), and GMAD::FastList< T >::getVector().

Here is the caller graph for this function:

◆ begin() [2/2]

template<typename T >

FastList< T >::FastListConstIterator GMAD::FastList< T >::begin ( ) const

const begin/end iterator:

Definition at line 227 of file fastlist.h.

◆ clear()

template<typename T >

void GMAD::FastList< T >::clear ( )

empty lists

Definition at line 171 of file fastlist.h.

Referenced by GMAD::Parser::expand_line().

Here is the caller graph for this function:

◆ empty()

template<typename T >

bool GMAD::FastList< T >::empty ( ) const

inline

Whether the list is empty.

Definition at line 67 of file fastlist.h.

References GMAD::FastList< T >::itsList.

Referenced by BDSDetectorConstruction::BuildBeamline(), and BDSDetectorConstruction::BuildPhysicsBias().

Here is the caller graph for this function:

◆ end() [1/2]

template<typename T >

FastList< T >::FastListIterator GMAD::FastList< T >::end ( )

non-const begin/end iterator:

Definition at line 222 of file fastlist.h.

Referenced by BDSDetectorConstruction::BuildBeamline(), GMAD::Parser::expand_line(), GMAD::Parser::FindAndExtend(), and GMAD::FastList< T >::getVector().

Here is the caller graph for this function:

◆ end() [2/2]

template<typename T >

FastList< T >::FastListConstIterator GMAD::FastList< T >::end ( ) const

const begin/end iterator:

Definition at line 232 of file fastlist.h.

◆ equal_range() [1/2]

template<typename T >

FastList< T >::FastMapIteratorPair GMAD::FastList< T >::equal_range ( std::string name )

lookup method, returns pair of iterators of list pointing (similar to std::multimap::equal_range)

Definition at line 237 of file fastlist.h.

◆ equal_range() [2/2]

template<typename T >

FastList< T >::FastMapConstIteratorPair GMAD::FastList< T >::equal_range ( std::string name ) const

Definition at line 242 of file fastlist.h.

◆ erase() [1/2]

template<typename T >

void GMAD::FastList< T >::erase ( )

erase elements

Definition at line 177 of file fastlist.h.

Referenced by GMAD::Parser::expand_line(), and GMAD::FastList< T >::find().

Here is the caller graph for this function:

◆ erase() [2/2]

template<typename T >

FastList< T >::FastListConstIterator GMAD::FastList< T >::erase	(	const FastListConstIterator	first,
		const FastListConstIterator	last
	)

erase elements

Definition at line 207 of file fastlist.h.

◆ find() [1/2]

template<typename T >

FastList< T >::FastListIterator GMAD::FastList< T >::find	(	std::string	name,
		unsigned int	count = `1`
	)

lookup method, returns iterator of list pointing to element with name second argument is instance number, default first instance both const and non-const version

Definition at line 275 of file fastlist.h.

References GMAD::FastList< T >::erase().

Here is the call graph for this function:

◆ find() [2/2]

template<typename T >

FastList< T >::FastListConstIterator GMAD::FastList< T >::find	(	std::string	name,
		unsigned int	count = `1`
	)		const

lookup method, returns iterator of list pointing to element with name second argument is instance number, default first instance both const and non-const version

Definition at line 256 of file fastlist.h.

Referenced by BDSDetectorConstruction::BuildCrossSectionBias(), GMAD::Parser::expand_line(), GMAD::Parser::FindAndExtend(), and GMAD::Parser::get_sequence().

Here is the caller graph for this function:

◆ getMap()

template<typename T >

std::map< std::string, T > GMAD::FastList< T >::getMap ( ) const

Get a map of name to object of this list.

Definition at line 247 of file fastlist.h.

◆ getVector()

template<typename T >

std::vector< T > GMAD::FastList< T >::getVector ( ) const

inline

Get a vector version of this list.

Definition at line 88 of file fastlist.h.

References GMAD::FastList< T >::begin(), and GMAD::FastList< T >::end().

Here is the call graph for this function:

◆ insert() [1/2]

template<typename T >

template<typename FastListInputIterator >

void GMAD::FastList< T >::insert	(	FastListConstIterator	position,
		FastListInputIterator	first,
		const FastListInputIterator	last
	)

template definitions need to be in header

insert options (classic list inserts): inputiterator templated to account for reverse iterators

Definition at line 127 of file fastlist.h.

References GMAD::FastList< T >::insert().

Here is the call graph for this function:

◆ insert() [2/2]

template<typename T >

template<typename FastListInputIterator >

FastList< T >::FastListIterator GMAD::FastList< T >::insert	(	FastListInputIterator	position,
		const T &	val
	)

template definitions need to be in header

insert options (classic list inserts): inputiterator templated to account for reverse iterators

Definition at line 117 of file fastlist.h.

Referenced by GMAD::Parser::expand_line(), and GMAD::FastList< T >::insert().

Here is the caller graph for this function:

◆ insert_before()

template<typename T >

void GMAD::FastList< T >::insert_before	(	const std::string &	name,
		const T &	val
	)

insert element before all elements with given name exits if no element with name

Definition at line 135 of file fastlist.h.

◆ print()

template<typename T >

void GMAD::FastList< T >::print ( int ident = 0 ) const

print method

Definition at line 298 of file fastlist.h.

◆ push_back()

template<typename T >

void GMAD::FastList< T >::push_back	(	const T &	el,
		bool	unique = `false`,
		const std::string &	objectName = `"element"`
	)

insert element at end of list option to check for unique element name (exits in case name is not unique), false by default

Definition at line 154 of file fastlist.h.

Referenced by GMAD::Parser::expand_line().

Here is the caller graph for this function:

◆ size()

template<typename T >

int GMAD::FastList< T >::size ( ) const

size of list

Definition at line 166 of file fastlist.h.

Referenced by BDSDetectorConstruction::BuildBeamline(), and GMAD::Parser::expand_line().

Here is the caller graph for this function:

Field Documentation

◆ itsList

template<typename T >

std::list<T> GMAD::FastList< T >::itsList

private

the element list a list is chosen since insertion is fast and iterators are not invalidated

Definition at line 109 of file fastlist.h.

Referenced by GMAD::FastList< T >::empty().

◆ itsMap

template<typename T >

std::multimap<std::string, FastListIterator> GMAD::FastList< T >::itsMap

private

multimap for name lookup

Definition at line 111 of file fastlist.h.

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

/__w/bdsim/bdsim/include/BDSDetectorConstruction.hh
/__w/bdsim/bdsim/parser/fastlist.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FastListConstIterator

◆ FastListIterator

◆ FastMapConstIterator

◆ FastMapConstIteratorPair

◆ FastMapIterator

◆ FastMapIteratorPair

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ equal_range() [1/2]

◆ equal_range() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ find() [1/2]

◆ find() [2/2]

◆ getMap()

◆ getVector()

◆ insert() [1/2]

◆ insert() [2/2]

◆ insert_before()

◆ print()

◆ push_back()

◆ size()

Field Documentation

◆ itsList

◆ itsMap