Class astrea::trace::FoldsOfCoverage

ClassList > astrea > trace > FoldsOfCoverage

The FoldsOfCoverage class represents the folds of coverage (simultaneous accesses) for each receiver ID over time.More...

• #include <FoldsOfCoverage.hpp>

Public Types

Type	Name
typedef gtl::btree_map< std::size_t, std::vector< double > >::const_iterator	const_iterator Constant iterator type for the FoldsOfCoverage .
typedef gtl::btree_map< std::size_t, std::vector< double > >::iterator	iterator Iterator type for the FoldsOfCoverage .

Public Functions

Type	Name
	FoldsOfCoverage () = default Default constructor for FoldsOfCoverage .
	FoldsOfCoverage (const AccessArray & access, const Time & resolution, const Time & end) Constructs a FoldsOfCoverage object from anAccessArray and time parameters.
iterator	begin () Returns an iterator to the beginning of the FoldsOfCoverage .
const_iterator	begin () const Returns a constant iterator to the beginning of the FoldsOfCoverage .
const_iterator	cbegin () const Returns a constant iterator to the beginning of the FoldsOfCoverage .
const_iterator	cend () const Returns a constant iterator to the end of the FoldsOfCoverage .
iterator	end () Returns an iterator to the end of the FoldsOfCoverage .
const_iterator	end () const Returns a constant iterator to the end of the FoldsOfCoverage .
const Stats< double > &	get_stats (const std::size_t & id) const Returns the statistics for a given ID.

Detailed Description

It calculates the number of accesses (folds) for each receiver ID at each time point based on the provided AccessArray and time parameters. It also computes statistics for the folds of coverage for each receiver ID.

Public Types Documentation

typedef const_iterator

Constant iterator type for the FoldsOfCoverage .

using astrea::trace::FoldsOfCoverage::const_iterator =  gtl::btree_map<std::size_t, std::vector<double> >::const_iterator;

---

typedef iterator

Iterator type for the FoldsOfCoverage .

using astrea::trace::FoldsOfCoverage::iterator =  gtl::btree_map<std::size_t, std::vector<double> >::iterator;

---

Public Functions Documentation

function FoldsOfCoverage [1/2]

Default constructor for FoldsOfCoverage .

astrea::trace::FoldsOfCoverage::FoldsOfCoverage () = default

---

function FoldsOfCoverage [2/2]

Constructs a FoldsOfCoverage object from anAccessArray and time parameters.

astrea::trace::FoldsOfCoverage::FoldsOfCoverage (
    const AccessArray & access,
    const Time & resolution,
    const Time & end
) 

Parameters:

• access The AccessArray containing the rise sets for each sender-receiver pair.
• resolution The time resolution for calculating folds of coverage.
• end The end time for calculating folds of coverage.

---

function begin [1/2]

Returns an iterator to the beginning of the FoldsOfCoverage .

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

Returns:

iterator An iterator to the beginning of the FoldsOfCoverage.

---

function begin [2/2]

Returns a constant iterator to the beginning of the FoldsOfCoverage .

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

Returns:

const_iterator A constant iterator to the beginning of the FoldsOfCoverage.

---

function cbegin

Returns a constant iterator to the beginning of the FoldsOfCoverage .

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

Returns:

const_iterator A constant iterator to the beginning of the FoldsOfCoverage.

---

function cend

Returns a constant iterator to the end of the FoldsOfCoverage .

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

Returns:

const_iterator A constant iterator to the end of the FoldsOfCoverage.

---

function end [1/2]

Returns an iterator to the end of the FoldsOfCoverage .

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

Returns:

iterator An iterator to the end of the FoldsOfCoverage.

---

function end [2/2]

Returns a constant iterator to the end of the FoldsOfCoverage .

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

Returns:

const_iterator A constant iterator to the end of the FoldsOfCoverage.

---

function get_stats

Returns the statistics for a given ID.

inline const Stats < double > & astrea::trace::FoldsOfCoverage::get_stats (
    const std::size_t & id
) const

Parameters:

• id The ID to get the statistics for.

Returns:

Stats<std::size_t> The statistics for the given ID.

---

---

The documentation for this class was generated from the following file astrea/trace/trace/analysis/stats/FoldsOfCoverage.hpp