Class astrea::trace::AccessArray¶

ClassList > astrea > trace > AccessArray

Represents a collection of access times indexed by sender and receiver IDs. This class provides methods to manipulate and query access times for different sender-receiver pairs.

#include <AccessArray.hpp>

Public Types¶

Type	Name
typedef gtl::btree_map< IdPair, RiseSetArray >::const_iterator	const_iterator Const iterator type for AccessArray .
typedef gtl::btree_map< IdPair, RiseSetArray >::iterator	iterator Iterator type for AccessArray .

Public Functions¶

Type	Name
	AccessArray () = default Default constructor for AccessArray . Initializes an emptyAccessArray .
const RiseSetArray &	at (const std::size_t & senderId, const std::size_t & receiverId) const Accesses the RiseSetArray for a givenIdPair .
iterator	begin () Returns an iterator to the beginning of the AccessArray .
const_iterator	begin () const Returns a const iterator to the beginning of the AccessArray .
const_iterator	cbegin () const Returns a const iterator to the beginning of the AccessArray .
const_iterator	cend () const Returns a const iterator to the end of the AccessArray .
bool	contains (const IdPair & idPair) const Checks if the AccessArray contains aRiseSetArray for the specifiedIdPair .
iterator	end () Returns an iterator to the end of the AccessArray .
const_iterator	end () const Returns a const iterator to the end of the AccessArray .
void	erase (const std::size_t & senderId, const std::size_t & receiverId) Erases the RiseSetArray for a given sender and receiver ID.
RiseSetArray	get_all_accesses_from_sender (const std::size_t & senderId) const Retrieves the RiseSetArray for all accesses from a specific sender.
RiseSetArray	get_all_accesses_to_receiver (const std::size_t & receiverId) const Retrieves the RiseSetArray for all accesses to a specific receiver.
AccessArray	operator& (const AccessArray & other) const Const intersection operator for AccessArray .
AccessArray &	operator&= (const AccessArray & other) Intersection operator for AccessArray .
bool	operator== (const AccessArray & other) const Equality operator for AccessArray .
RiseSetArray &	operator[] (const std::size_t & senderId, const std::size_t & receiverId) Accesses the RiseSetArray for a given sender and receiver ID.
AccessArray	operator\| (const AccessArray & other) const Const union operator for AccessArray .
AccessArray &	operator\|= (const AccessArray & other) Union operator for AccessArray .
std::size_t	size () const Returns the number of RiseSetArrays in the AccessArray .
	~AccessArray () = default Default destructor for AccessArray .

Public Types Documentation¶

typedef const_iterator¶

Const iterator type for AccessArray .

using astrea::trace::AccessArray::const_iterator =  gtl::btree_map<IdPair, RiseSetArray>::const_iterator;

typedef iterator¶

Iterator type for AccessArray .

using astrea::trace::AccessArray::iterator =  gtl::btree_map<IdPair, RiseSetArray>::iterator;

Public Functions Documentation¶

function AccessArray¶

Default constructor for AccessArray . Initializes an emptyAccessArray .

astrea::trace::AccessArray::AccessArray () = default

function at¶

Accesses the RiseSetArray for a givenIdPair .

const RiseSetArray & astrea::trace::AccessArray::at (
    const std::size_t & senderId,
    const std::size_t & receiverId
) const

Parameters:

senderId The ID of the sender.
receiverId The ID of the receiver.

Returns:

RiseSetArray& The RiseSetArray for the specified sender and receiver.

function begin [1/2]¶

Returns an iterator to the beginning of the AccessArray .

inline iterator astrea::trace::AccessArray::begin ()

Returns:

iterator An iterator to the beginning.

function begin [2/2]¶

Returns a const iterator to the beginning of the AccessArray .

inline const_iterator astrea::trace::AccessArray::begin () const

Returns:

const_iterator A const iterator to the beginning.

function cbegin¶

Returns a const iterator to the beginning of the AccessArray .

inline const_iterator astrea::trace::AccessArray::cbegin () const

Returns:

const_iterator A const iterator to the beginning.

function cend¶

Returns a const iterator to the end of the AccessArray .

inline const_iterator astrea::trace::AccessArray::cend () const

Returns:

const_iterator A const iterator to the end.

function contains¶

Checks if the AccessArray contains aRiseSetArray for the specifiedIdPair .

bool astrea::trace::AccessArray::contains (
    const IdPair & idPair
) const

Parameters:

idPair The IdPair to check.

Returns:

true if the AccessArray contains the IdPair, false otherwise.

function end [1/2]¶

Returns an iterator to the end of the AccessArray .

inline iterator astrea::trace::AccessArray::end ()

Returns:

iterator An iterator to the end.

function end [2/2]¶

Returns a const iterator to the end of the AccessArray .

inline const_iterator astrea::trace::AccessArray::end () const

Returns:

const_iterator A const iterator to the end.

function erase¶

Erases the RiseSetArray for a given sender and receiver ID.

void astrea::trace::AccessArray::erase (
    const std::size_t & senderId,
    const std::size_t & receiverId
)

Parameters:

senderId The ID of the sender.
receiverId The ID of the receiver.

function get_all_accesses_from_sender¶

Retrieves the RiseSetArray for all accesses from a specific sender.

RiseSetArray astrea::trace::AccessArray::get_all_accesses_from_sender (
    const std::size_t & senderId
) const

Parameters:

senderId The ID of the sender.

Returns:

RiseSetArray The RiseSetArray containing all accesses from the specified sender.

function get_all_accesses_to_receiver¶

Retrieves the RiseSetArray for all accesses to a specific receiver.

RiseSetArray astrea::trace::AccessArray::get_all_accesses_to_receiver (
    const std::size_t & receiverId
) const

Parameters:

receiverId The ID of the receiver.

Returns:

RiseSetArray The RiseSetArray containing all accesses to the specified receiver.

function operator&¶

Const intersection operator for AccessArray .

AccessArray astrea::trace::AccessArray::operator& (
    const AccessArray & other
) const

Parameters:

other The AccessArray to intersect with.

Returns:

AccessArray The resulting AccessArray after the intersection operation.

function operator&=¶

Intersection operator for AccessArray .

AccessArray & astrea::trace::AccessArray::operator&= (
    const AccessArray & other
)

Parameters:

other The AccessArray to intersect with.

function operator==¶

Equality operator for AccessArray .

bool astrea::trace::AccessArray::operator== (
    const AccessArray & other
) const

Parameters:

other The AccessArray to compare with.

Returns:

true if the AccessArrays are equal, false otherwise.

function operator[]¶

Accesses the RiseSetArray for a given sender and receiver ID.

RiseSetArray & astrea::trace::AccessArray::operator[] (
    const std::size_t & senderId,
    const std::size_t & receiverId
)

Parameters:

senderId The ID of the sender.
receiverId The ID of the receiver.

Returns:

RiseSetArray& The RiseSetArray for the specified sender and receiver.

function operator|¶

Const union operator for AccessArray .

AccessArray astrea::trace::AccessArray::operator| (
    const AccessArray & other
) const

Parameters:

other The AccessArray to union with.

Returns:

AccessArray The resulting AccessArray after the union operation.

function operator|=¶

Union operator for AccessArray .

AccessArray & astrea::trace::AccessArray::operator|= (
    const AccessArray & other
)

Parameters:

other The AccessArray to union with.

function size¶

Returns the number of RiseSetArrays in the AccessArray .

std::size_t astrea::trace::AccessArray::size () const

Returns:

std::size_t The number of RiseSetArrays.

function ~AccessArray¶

Default destructor for AccessArray .

astrea::trace::AccessArray::~AccessArray () = default

The documentation for this class was generated from the following file astrea/trace/trace/risesets/AccessArray.hpp