Sequences are containers that provide indexed based storage of items. More...

#include <Sequence.h>

Inheritance diagram for Sequence< T >:

Public Member Functions
virtual int	insert (const T &item)
	Adds the given item to the Sequence, if possible. More...

virtual bool	insert (Size position, const T &item)
	Inserts the given item at the given position. More...

virtual void	fill (T value)
	Fill the Sequence with the given value. More...

virtual int	remove (T value)
	Remove all items with the given value. More...

virtual bool	removeAt (Size position)
	Removes the item at the given position. More...

virtual void	clear ()
	Removes all items from the Sequence. More...

virtual const T *	get (Size position) const =0
	Returns the item at the given position. More...

virtual const T &	at (Size position) const =0
	Returns a reference to the item at the given position. More...

virtual bool	contains (const T value) const
	Check if the given item is stored in this Sequence. More...

virtual int	compareTo (const Sequence< T > &s) const
	Compare this Sequence to another Sequence. More...

virtual bool	equals (const Sequence< T > &s) const
	Test if this Sequence is equal to an other Sequence. More...

const T &	operator[] (int i) const
	Returns the item at the given position in the Sequence. More...

const T &	operator[] (Size i) const
	Returns the item at the given position in the Sequence. More...

T &	operator[] (int i)
	Returns the item at the given position in the Sequence. More...

T &	operator[] (Size i)
	Returns the item at the given position in the Sequence. More...

Public Member Functions inherited from Container
	Container ()
	Constructor. More...

virtual	~Container ()
	Destructor. More...

virtual Size	size () const =0
	Returns the maximum size of this Container. More...

virtual Size	count () const =0
	Returns the number of items inside the Container. More...

virtual bool	isEmpty () const
	Check if the Container is empty. More...

virtual bool	reserve (Size size)
	Ensure that at least the given size is available. More...

virtual bool	shrink (Size size)
	Shrink the container size by the given amount of items. More...

virtual Size	squeeze ()
	Try to minimize the memory required in the Container. More...

virtual bool	resize (Size size)
	Change the size of the Container. More...

Public Member Functions inherited from Comparable< Sequence< T > >
virtual	~Comparable ()
	Class destructor. More...

Detailed Description

template<class T>
class Sequence< T >

Sequences are containers that provide indexed based storage of items.

Definition at line 37 of file Sequence.h.

Member Function Documentation

◆ at()

template<class T >

virtual const T& Sequence< T >::at ( Size position ) const

pure virtual

Returns a reference to the item at the given position.

Parameters

position Valid index inside this array.

Returns: Reference to the item at the given position

Note: Position must be a valid index.

Implemented in List< T >, List< String * >, List< MpiHost::Packet * >, List< TestInstance * >, List< FileSystemRequest * >, List< InterruptHook * >, List< String >, List< Dirent * >, List< Process * >, List< HashTable::Bucket >, List< uint >, List< K >, List< Device * >, List< ATADrive * >, Vector< T >, Vector< Handler * >, Vector< Size >, Vector< List< InterruptHook * > * >, Vector< LinnGroup * >, Vector< List< HashTable::Bucket > >, Vector< List< Process * > * >, Vector< Argument * >, Array< T, N >, Array< ProcessID, MaximumChannels >, and String.

Referenced by Sequence< ATADrive * >::compareTo(), Sequence< ATADrive * >::contains(), and Sequence< ATADrive * >::operator[]().

◆ clear()

template<class T >

virtual void Sequence< T >::clear ( )

inlinevirtual

Removes all items from the Sequence.

Implements Container.

Reimplemented in List< T >, List< String * >, List< MpiHost::Packet * >, List< TestInstance * >, List< FileSystemRequest * >, List< InterruptHook * >, List< String >, List< Dirent * >, List< Process * >, List< HashTable::Bucket >, List< uint >, List< K >, List< Device * >, List< ATADrive * >, Vector< T >, Vector< Handler * >, Vector< Size >, Vector< List< InterruptHook * > * >, Vector< LinnGroup * >, Vector< List< HashTable::Bucket > >, Vector< List< Process * > * >, and Vector< Argument * >.

Definition at line 108 of file Sequence.h.

◆ compareTo()

template<class T >

virtual int Sequence< T >::compareTo ( const Sequence< T > & s ) const

inlinevirtual

Compare this Sequence to another Sequence.

Implements Comparable< Sequence< T > >.

Definition at line 153 of file Sequence.h.

Referenced by Sequence< ATADrive * >::equals().

◆ contains()

template<class T >

virtual bool Sequence< T >::contains ( const T value ) const

inlinevirtual

Check if the given item is stored in this Sequence.

Reimplemented in List< uint >, List< TestInstance * >, List< T >, List< String >, List< String * >, List< Process * >, List< MpiHost::Packet * >, List< K >, List< InterruptHook * >, List< HashTable::Bucket >, List< FileSystemRequest * >, List< Dirent * >, List< Device * >, String, and List< ATADrive * >.

Definition at line 139 of file Sequence.h.

◆ equals()

template<class T >

virtual bool Sequence< T >::equals ( const Sequence< T > & s ) const

inlinevirtual

Test if this Sequence is equal to an other Sequence.

Parameters

s	Sequence instance.

Returns: True if equal, false otherwise.

Implements Comparable< Sequence< T > >.

Definition at line 184 of file Sequence.h.

◆ fill()

template<class T >

virtual void Sequence< T >::fill ( T value )

inlinevirtual

Fill the Sequence with the given value.

Parameters

value New value to fill the Sequence.

Definition at line 73 of file Sequence.h.

Referenced by API::API(), Kernel::Kernel(), LinnFileSystem::LinnFileSystem(), MpiProxy::MpiProxy(), and ProcessManager::ProcessManager().

◆ get()

template<class T >

virtual const T* Sequence< T >::get ( Size position ) const

pure virtual

Returns the item at the given position.

Parameters

position The position of the item to get.

Returns: Pointer to the item at the given position or ZERO if no item available.

Implemented in List< T >, List< String * >, List< MpiHost::Packet * >, List< TestInstance * >, List< FileSystemRequest * >, List< InterruptHook * >, List< String >, List< Dirent * >, List< Process * >, List< HashTable::Bucket >, List< uint >, List< K >, List< Device * >, List< ATADrive * >, Vector< T >, Vector< Handler * >, Vector< Size >, Vector< List< InterruptHook * > * >, Vector< LinnGroup * >, Vector< List< HashTable::Bucket > >, Vector< List< Process * > * >, Vector< Argument * >, Array< T, N >, Array< ProcessID, MaximumChannels >, and String.

◆ insert() [1/2]

template<class T >

virtual int Sequence< T >::insert ( const T & item )

inlinevirtual

Adds the given item to the Sequence, if possible.

Parameters

item	The item to add to the Sequence.

Returns: Position of the item in the Sequence or -1 on failure.

Reimplemented in Vector< T >, Vector< Size >, Vector< List< Process * > * >, Vector< List< InterruptHook * > * >, Vector< List< HashTable::Bucket > >, Vector< LinnGroup * >, Vector< Handler * >, and Vector< Argument * >.

Definition at line 48 of file Sequence.h.

Referenced by Sequence< ATADrive * >::fill().

◆ insert() [2/2]

template<class T >

virtual bool Sequence< T >::insert	(	Size	position,
		const T &	item
	)

inlinevirtual

Inserts the given item at the given position.

If an item exists at the given position, it will be replaced by the given item.

Parameters

position	The position to insert the item.
item	The item to insert

Returns: bool Whether inserting the item at the given position succeeded.

Reimplemented in Vector< T >, Array< T, N >, Vector< Size >, Array< ProcessID, MaximumChannels >, Vector< List< Process * > * >, Vector< List< InterruptHook * > * >, Vector< List< HashTable::Bucket > >, Vector< LinnGroup * >, Vector< Handler * >, and Vector< Argument * >.

Definition at line 63 of file Sequence.h.

◆ operator[]() [1/4]

template<class T >

T& Sequence< T >::operator[] ( int i )

inline

Returns the item at the given position in the Sequence.

Parameters

i	The index of the item to return.

Returns: the Item at position i.

Definition at line 220 of file Sequence.h.

◆ operator[]() [2/4]

template<class T >

const T& Sequence< T >::operator[] ( int i ) const

inline

Returns the item at the given position in the Sequence.

Parameters

i	The index of the item to return.

Returns: the Item at position i.

Definition at line 196 of file Sequence.h.

◆ operator[]() [3/4]

template<class T >

T& Sequence< T >::operator[] ( Size i )

inline

Returns the item at the given position in the Sequence.

Parameters

i	The index of the item to return.

Returns: the Item at position i.

Definition at line 232 of file Sequence.h.

◆ operator[]() [4/4]

template<class T >

const T& Sequence< T >::operator[] ( Size i ) const

inline

Returns the item at the given position in the Sequence.

Parameters

i	The index of the item to return.

Returns: the Item at position i.

Definition at line 208 of file Sequence.h.

◆ remove()

template<class T >

virtual int Sequence< T >::remove ( T value )

inlinevirtual

Remove all items with the given value.

Parameters

value Value to remove.

Returns: Number of items removed.

Reimplemented in List< uint >, List< TestInstance * >, List< T >, List< String >, List< String * >, List< Process * >, List< MpiHost::Packet * >, List< K >, List< InterruptHook * >, List< HashTable::Bucket >, List< FileSystemRequest * >, List< Dirent * >, List< Device * >, and List< ATADrive * >.

Definition at line 88 of file Sequence.h.

◆ removeAt()

template<class T >

virtual bool Sequence< T >::removeAt ( Size position )

inlinevirtual

Removes the item at the given position.

Parameters

position The position of the item to remove.

Returns: bool Whether removing the item succeeded.

Reimplemented in Vector< T >, Vector< Handler * >, Vector< Size >, Vector< List< InterruptHook * > * >, Vector< LinnGroup * >, Vector< List< HashTable::Bucket > >, Vector< List< Process * > * >, and Vector< Argument * >.

Definition at line 100 of file Sequence.h.

Referenced by Sequence< ATADrive * >::clear().

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

lib/libstd/Sequence.h

Public Member Functions

Detailed Description

template<class T> class Sequence< T >

Member Function Documentation

◆ at()

◆ clear()

◆ compareTo()

◆ contains()

◆ equals()

◆ fill()

◆ get()

◆ insert() [1/2]

◆ insert() [2/2]

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ remove()

◆ removeAt()

template<class T>
class Sequence< T >