Class AgentsSample

template <typename TSeq>

ClassList > AgentsSample

Sample of agents. More...

• #include <agentssample-bones.hpp>

Public Functions

Type	Name
	AgentsSample () = delete Default constructor.
	AgentsSample (const AgentsSample< TSeq > & a) = delete Copy constructor.
	AgentsSample (AgentsSample< TSeq > && a) = delete Move constructor.
	AgentsSample (Model< TSeq > & model_, size_t n, std::vector< size_t > states_={}, bool truncate=false)
	AgentsSample (Model< TSeq > * model, Entity< TSeq > & entity_, size_t n, std::vector< size_t > states_={}, bool truncate=false)
	AgentsSample (Model< TSeq > * model, Agent< TSeq > & agent_, size_t n, std::vector< size_t > states_={}, bool truncate=false) Sample from the agent's entities.
std::vector< Agent< TSeq > * >::iterator	begin ()
std::vector< Agent< TSeq > * >::iterator	end ()
Agent< TSeq > *	operator() (size_t n)
Agent< TSeq > *	operator[] (size_t n)
size_t	size () noexcept const
	~AgentsSample ()

Detailed Description

This class allows sampling agents from Entity<TSeq> and Model<TSeq>.

Template parameters:

• TSeq

Public Functions Documentation

function AgentsSample [1/6]

Default constructor.

AgentsSample::AgentsSample () = delete

---

function AgentsSample [2/6]

Copy constructor.

AgentsSample::AgentsSample (
    const AgentsSample < TSeq > & a
) = delete

---

function AgentsSample [3/6]

Move constructor.

AgentsSample::AgentsSample (
    AgentsSample < TSeq > && a
) = delete

---

function AgentsSample [4/6]

inline AgentsSample::AgentsSample (
    Model < TSeq > & model_,
    size_t n,
    std::vector< size_t > states_={},
    bool truncate=false
) 

---

function AgentsSample [5/6]

inline AgentsSample::AgentsSample (
    Model < TSeq > * model,
    Entity < TSeq > & entity_,
    size_t n,
    std::vector< size_t > states_={},
    bool truncate=false
) 

---

function AgentsSample [6/6]

Sample from the agent's entities.

inline AgentsSample::AgentsSample (
    Model < TSeq > * model,
    Agent < TSeq > & agent_,
    size_t n,
    std::vector< size_t > states_={},
    bool truncate=false
) 

For example, how many individuals the agent contacts in a given point in time.

Template parameters:

• TSeq

Parameters:

• agent_
• n Sample size
• truncate If the agent has fewer than n connections, then truncate = true will automatically reduce the number of possible samples. Otherwise, if false, then it returns an error.

---

function begin

inline std::vector< Agent < TSeq > * >::iterator AgentsSample::begin () 

---

function end

inline std::vector< Agent < TSeq > * >::iterator AgentsSample::end () 

---

function operator()

inline Agent < TSeq > * AgentsSample::operator() (
    size_t n
) 

---

function operator[]

inline Agent < TSeq > * AgentsSample::operator[] (
    size_t n
) 

---

function size

inline size_t AgentsSample::size () noexcept const

---

function ~AgentsSample

inline AgentsSample::~AgentsSample () 

---

---

The documentation for this class was generated from the following file epiworld-src/include/epiworld/agentssample-bones.hpp