SST::SparseVectorMap< keyT, classT * > Class Template Reference

Class that stores data in a vector, but can access the data similar to a map. More...

#include <sparseVectorMap.h>

Public Types
using	iterator = typename std::vector<classT*>::iterator
using	const_iterator = typename std::vector<classT*>::const_iterator
using	iterator
using	const_iterator

Public Member Functions
	SparseVectorMap ()
	Default constructor for SparseVectorMap.
	SparseVectorMap (std::vector< classT * > &new_data, bool sorted=false)
	Constructor that allows you to pass an already filled in array with data.
classT *	insert (classT *val)
	Insert new value into SparseVectorMap.
iterator	begin ()
	Returns the begin iterator to the underlying vector.
iterator	end ()
	Returns the end iterator to the underlying vector.
const_iterator	begin () const
	Returns the const begin iterator to the underlying vector.
const_iterator	end () const
	Returns the const end iterator to the underlying vector.
bool	contains (keyT id) const
	Checks if the provided id is found in the SparseVectorMap.
classT *	operator[] (keyT id)
	Operator returns a reference to data with the specified id.
const classT *	operator[] (keyT id) const
	Operator returns a const reference to data with the specified id.
void	clear ()
	Clears the contents of the SparseVectorMap.
size_t	size ()
	Returns the number of items in the SparseVectorMap.
template<typename filterT>
void	filter (filterT &filt)
	Function to filter the contents of the SparseVectorMap.
	SparseVectorMap ()
	Default constructor for SparseVectorMap.
	SparseVectorMap (std::vector< classT > &new_data, bool sorted=false)
	Constructor that allows you to pass an already filled in array with data.
classT &	insert (const classT &val)
	Insert new value into SparseVectorMap.
iterator	begin ()
	Returns the begin iterator to the underlying vector.
const_iterator	begin () const
	Returns the const begin iterator to the underlying vector.
iterator	end ()
	Returns the end iterator to the underlying vector.
const_iterator	end () const
	Returns the const end iterator to the underlying vector.
bool	contains (keyT id) const
	Checks if the provided id is found in the SparseVectorMap.
classT &	operator[] (keyT id)
	Operator returns a reference to data with the specified id.
const classT &	operator[] (keyT id) const
	Operator returns a const reference to data with the specified id.
void	clear ()
	Clears the contents of the SparseVectorMap.
size_t	size ()
	Returns the number of items in the SparseVectorMap.

Friends
class	SST::Core::Serialization::serialize_impl< SparseVectorMap< keyT, classT * > >
class	ConfigGraph
class	SST::Core::Serialization::serialize_impl< SparseVectorMap< keyT, classT > >
class	ConfigGraph

Detailed Description

template<typename keyT, typename classT>
class SST::SparseVectorMap< keyT, classT * >

Class that stores data in a vector, but can access the data similar to a map.

The data structure is O(log n) on reads, but is O(n) to insert. The primary use case is when data is inserted in order, but accessed randomly. You can also create the SparseVectorMap with a vector already loaded with the data. If the data is not already sorted, it will call std::sort on the data, which likely has an average complexity of O(n log n). This data structure should not be used for large lists where inserts do not happen in sorted order.

NOTE: Since the data is stored in the vector, reference returned from the various accessor functions will not be valid longterm. If an insert causes the vector to be resized, all references returned before that reallocation may (likely will) be invalid. References are only guaranteed to be valid until the next write to the data structure.

Constructor & Destructor Documentation

SparseVectorMap() [1/2]

template<typename keyT, typename classT>

SST::SparseVectorMap< keyT, classT * >::SparseVectorMap ( std::vector< classT * > & new_data, bool sorted = false )

inline

Constructor that allows you to pass an already filled in array with data.

The data in the passed in vector will be swapped into the data vector of the sparsevectormap and the passed in vector will be empty.

Parameters

new_data	Vector of data to swap into the sparsevectormap data
sorted	Specifies whether the vector is already sorted in ascending order. if not, it will be sorted after swapping the data in.

SparseVectorMap() [2/2]

SST::SparseVectorMap< keyT, classT >::SparseVectorMap ( std::vector< classT > & new_data, bool sorted = false )

inline

Constructor that allows you to pass an already filled in array with data.

The data in the passed in vector will be swapped into the data vector of the sparsevectormap and the passed in vector will be empty.

Parameters

new_data	Vector of data to swap into the sparsevectormap data
sorted	Specifies whether the vector is already sorted in ascending order. if not, it will be sorted after swapping the data in.

Member Function Documentation

begin() [1/4]

iterator SST::SparseVectorMap< keyT, classT >::begin ( )

inline

Returns the begin iterator to the underlying vector.

Returns

begin iterator to data vector

begin() [2/4]

template<typename keyT, typename classT>

iterator SST::SparseVectorMap< keyT, classT * >::begin ( )

inline

Returns the begin iterator to the underlying vector.

Returns

begin iterator to data vector

begin() [3/4]

const_iterator SST::SparseVectorMap< keyT, classT >::begin ( ) const

inline

Returns the const begin iterator to the underlying vector.

Returns

const begin iterator to data vector

begin() [4/4]

template<typename keyT, typename classT>

const_iterator SST::SparseVectorMap< keyT, classT * >::begin ( ) const

inline

Returns the const begin iterator to the underlying vector.

Returns

const begin iterator to data vector

contains() [1/2]

bool SST::SparseVectorMap< keyT, classT >::contains ( keyT id ) const

inline

Checks if the provided id is found in the SparseVectorMap.

Parameters

id	id to check for

Returns

true if id is found, false otherwise

contains() [2/2]

template<typename keyT, typename classT>

bool SST::SparseVectorMap< keyT, classT * >::contains ( keyT id ) const

inline

Checks if the provided id is found in the SparseVectorMap.

Parameters

id	id to check for

Returns

true if id is found, false otherwise

end() [1/4]

iterator SST::SparseVectorMap< keyT, classT >::end ( )

inline

Returns the end iterator to the underlying vector.

Returns

end iterator to data vector

end() [2/4]

template<typename keyT, typename classT>

iterator SST::SparseVectorMap< keyT, classT * >::end ( )

inline

Returns the end iterator to the underlying vector.

Returns

end iterator to data vector

end() [3/4]

const_iterator SST::SparseVectorMap< keyT, classT >::end ( ) const

inline

Returns the const end iterator to the underlying vector.

Returns

const end iterator to data vector

end() [4/4]

template<typename keyT, typename classT>

const_iterator SST::SparseVectorMap< keyT, classT * >::end ( ) const

inline

Returns the const end iterator to the underlying vector.

Returns

const end iterator to data vector

filter()

template<typename keyT, typename classT>

template<typename filterT>

void SST::SparseVectorMap< keyT, classT * >::filter ( filterT & filt )

inline

Function to filter the contents of the SparseVectorMap.

Takes an object with an overloaded operator() function that takes as argument the current item. The funtion returns the object that should take the place of this object (value returned by key() function must be same for both objects), or returns nullptr if the object should be deleted. When an item is deleted, the size of the map reduces by 1.

Parameters

filt	Filter object to use for filtering contents of map

Exceptions

bad_filtered_key_error

filter returned an object that didn't return the same value on a call to key() as the original object in the map.

insert() [1/2]

template<typename keyT, typename classT>

classT * SST::SparseVectorMap< keyT, classT * >::insert ( classT * val )

inline

Insert new value into SparseVectorMap.

The inserted class must have a key() function with return type keyT.

Parameters

val	value to add to SparseVectorMap

Returns

reference to the inserted item, or to the existing item if it was already present in the map.

insert() [2/2]

classT & SST::SparseVectorMap< keyT, classT >::insert ( const classT & val )

inline

Insert new value into SparseVectorMap.

The inserted class must have a key() function with return type keyT.

Parameters

val	value to add to SparseVectorMap

Returns

reference to the inserted item, or to the existing item if it was already present in the map.

operator[]() [1/4]

classT & SST::SparseVectorMap< keyT, classT >::operator[] ( keyT id )

inline

Operator returns a reference to data with the specified id.

Value can be modified. This will only return references to existing values, you must use insert() for new values.

Parameters

id	id of the value to return (value returned by key())

Returns

reference to the requested item.

operator[]() [2/4]

template<typename keyT, typename classT>

classT * SST::SparseVectorMap< keyT, classT * >::operator[] ( keyT id )

inline

Operator returns a reference to data with the specified id.

Value can be modified. This will only return references to existing values, you must use insert() for new values.

Parameters

id	id of the value to return (value returned by key())

Returns

reference to the requested item.

operator[]() [3/4]

const classT & SST::SparseVectorMap< keyT, classT >::operator[] ( keyT id ) const

inline

Operator returns a const reference to data with the specified id.

Value cannot be modified. This will only return references to existing values, you must use insert() for new values.

Parameters

id	id of the value to return (value returned by key())

Returns

const reference to the requested item.

operator[]() [4/4]

template<typename keyT, typename classT>

const classT * SST::SparseVectorMap< keyT, classT * >::operator[] ( keyT id ) const

inline

Operator returns a const reference to data with the specified id.

Value cannot be modified. This will only return references to existing values, you must use insert() for new values.

Parameters

id	id of the value to return (value returned by key())

Returns

const reference to the requested item.

size() [1/2]

size_t SST::SparseVectorMap< keyT, classT >::size ( )

inline

Returns the number of items in the SparseVectorMap.

Returns

number of items

size() [2/2]

template<typename keyT, typename classT>

size_t SST::SparseVectorMap< keyT, classT * >::size ( )

inline

Returns the number of items in the SparseVectorMap.

Returns

number of items

---

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

• src/sst/core/sparseVectorMap.h