Rcpp::DottedPair Class Reference

#include <DottedPair.h>

Inheritance diagram for Rcpp::DottedPair:

Collaboration diagram for Rcpp::DottedPair:

List of all members.

Classes
class	Proxy
Public Member Functions
	DottedPair ()
	DottedPair (const DottedPair &other)
DottedPair &	operator= (const DottedPair &other)
template<typename T >
void	push_back (const T &object)
template<typename T >
void	push_front (const T &object)
template<typename T >
void	insert (const size_t &index, const T &object)
template<typename T >
void	replace (const int &index, const T &object)
R_len_t	length () const
R_len_t	size () const
void	remove (const size_t &index)
const Proxy	operator[] (int i) const
Proxy	operator[] (int i)
virtual	~DottedPair ()=0
Friends
class	Proxy
template<typename T >
DottedPair &	operator<< (DottedPair &os, const T &t)
template<typename T >
DottedPair &	operator>> (const T &t, DottedPair &s)

---

Detailed Description

Definition at line 36 of file DottedPair.h.

---

Constructor & Destructor Documentation

Rcpp::DottedPair::DottedPair

(

)

Definition at line 28 of file DottedPair.cpp.

Rcpp::DottedPair::DottedPair

(

const DottedPair &

other

)

[inline]

Definition at line 41 of file DottedPair.h.

References Rcpp::RObject::asSexp(), and Rcpp::RObject::setSEXP().

Here is the call graph for this function:

Rcpp::DottedPair::~DottedPair

(

)

[pure virtual]

Definition at line 27 of file DottedPair.cpp.

---

Member Function Documentation

template<typename T >

void Rcpp::DottedPair::insert	(	const size_t &	index,
		const T &	object
	)		[inline]

insert an object at the given position, pushing other objects to the tail of the list

Parameters:

index	index (0-based) where to insert
object	object to wrap

Definition at line 101 of file DottedPair.h.

References Rcpp::grow(), i, Rcpp::RObject::isNULL(), Rcpp::RObject::m_sexp, PROTECT(), push_front(), Rcpp::tail(), and x.

Here is the call graph for this function:

R_len_t Rcpp::DottedPair::length

(

)

const [inline]

Definition at line 143 of file DottedPair.h.

References Rcpp::RObject::m_sexp.

Referenced by Rcpp::DottedPair::Proxy::Proxy().

DottedPair & Rcpp::DottedPair::operator=

(

const DottedPair &

other

)

Definition at line 30 of file DottedPair.cpp.

References Rcpp::RObject::asSexp(), and Rcpp::RObject::setSEXP().

Here is the call graph for this function:

const DottedPair::Proxy Rcpp::DottedPair::operator[]

(

int

i

)

const

Definition at line 69 of file DottedPair.cpp.

References Proxy.

DottedPair::Proxy Rcpp::DottedPair::operator[]

(

int

i

)

Definition at line 72 of file DottedPair.cpp.

References Proxy.

template<typename T >

void Rcpp::DottedPair::push_back

(

const T &

object

)

[inline]

wraps an object and add it at the end of the pairlist (this require traversing the entire pairlist)

Parameters:

object

anything that can be wrapped by one of the wrap functions, named objects (instances of traits::named_object<> are treated specially

Definition at line 67 of file DottedPair.h.

References Rcpp::grow(), Rcpp::RObject::isNULL(), Rcpp::RObject::m_sexp, Rcpp::pairlist(), PROTECT(), Rcpp::RObject::setSEXP(), Rcpp::tail(), and x.

Here is the call graph for this function:

template<typename T >

void Rcpp::DottedPair::push_front

(

const T &

object

)

[inline]

wraps an object and add it in front of the pairlist.

Parameters:

object

anything that can be wrapped by one of the wrap functions, or an object of class Named

Definition at line 89 of file DottedPair.h.

References Rcpp::grow(), Rcpp::RObject::m_sexp, and Rcpp::RObject::setSEXP().

Referenced by insert().

Here is the call graph for this function:

void Rcpp::DottedPair::remove

(

const size_t &

index

)

Remove the element at the given position

Parameters:

index

position where the element is to be removed

Definition at line 35 of file DottedPair.cpp.

References i, Rcpp::RObject::m_sexp, Rcpp::RObject::setSEXP(), and x.

Here is the call graph for this function:

template<typename T >

void Rcpp::DottedPair::replace	(	const int &	index,
		const T &	object
	)		[inline]

replaces an element of the list

Parameters:

index	position
object	object that can be wrapped

Definition at line 129 of file DottedPair.h.

References i, Rcpp::RObject::m_sexp, Rcpp::pairlist(), PROTECT(), x, and y.

Here is the call graph for this function:

R_len_t Rcpp::DottedPair::size

(

)

const [inline]

Definition at line 144 of file DottedPair.h.

References Rcpp::RObject::m_sexp.

---

Friends And Related Function Documentation

template<typename T >

DottedPair& operator<<	(	DottedPair &	os,
		const T &	t
	)		[friend]

Definition at line 191 of file DottedPair.h.

template<typename T >

DottedPair& operator>>	(	const T &	t,
		DottedPair &	s
	)		[friend]

Definition at line 197 of file DottedPair.h.

friend class Proxy [friend]

Definition at line 186 of file DottedPair.h.

Referenced by operator[]().

---

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

• inst/include/Rcpp/DottedPair.h
• src/DottedPair.cpp