Rcpp Version 1.0.9
Public Member Functions | Friends | List of all members
Rcpp::DottedPairImpl< CLASS > Class Template Reference

#include <DottedPairImpl.h>

Public Member Functions

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_xlen_t length () const
 
R_xlen_t size () const
 
void remove (const size_t &index)
 

Friends

template<typename T >
DottedPairImpl & operator<< (DottedPairImpl &os, const T &t)
 
template<typename T >
DottedPairImpl & operator>> (const T &t, DottedPairImpl &s)
 

Detailed Description

template<typename CLASS>
class Rcpp::DottedPairImpl< CLASS >

Definition at line 24 of file DottedPairImpl.h.

Member Function Documentation

◆ insert()

template<typename CLASS >
template<typename T >
void Rcpp::DottedPairImpl< CLASS >::insert ( const size_t &  index,
const T &  object 
)

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

Parameters
indexindex (0-based) where to insert
objectobject to wrap

Definition at line 49 of file DottedPairImpl.h.

References Rcpp::grow(), Rcpp::push_front(), and Rcpp::tail().

Here is the call graph for this function:

◆ length()

template<typename CLASS >
R_xlen_t Rcpp::DottedPairImpl< CLASS >::length ( ) const
inline

Definition at line 66 of file DottedPairImpl.h.

◆ push_back()

template<typename CLASS >
template<typename T >
void Rcpp::DottedPairImpl< CLASS >::push_back ( const T &  object)

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

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

Definition at line 32 of file DottedPairImpl.h.

References Rcpp::grow(), and Rcpp::tail().

Here is the call graph for this function:

◆ push_front()

template<typename CLASS >
template<typename T >
void Rcpp::DottedPairImpl< CLASS >::push_front ( const T &  object)

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

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

Definition at line 25 of file DottedPairImpl.h.

References Rcpp::grow().

Here is the call graph for this function:

◆ remove()

template<typename CLASS >
void Rcpp::DottedPairImpl< CLASS >::remove ( const size_t &  index)

Remove the element at the given position

Parameters
indexposition where the element is to be removed

Definition at line 101 of file DottedPairImpl.h.

◆ replace()

template<typename CLASS >
template<typename T >
void Rcpp::DottedPairImpl< CLASS >::replace ( const int &  index,
const T &  object 
)

replaces an element of the list

Parameters
indexposition
objectobject that can be wrapped

Definition at line 80 of file DottedPairImpl.h.

References Rcpp::pairlist().

Here is the call graph for this function:

◆ size()

template<typename CLASS >
R_xlen_t Rcpp::DottedPairImpl< CLASS >::size ( ) const
inline

Definition at line 70 of file DottedPairImpl.h.

Friends And Related Function Documentation

◆ operator<<

template<typename CLASS >
template<typename T >
DottedPairImpl& operator<< ( DottedPairImpl< CLASS > &  os,
const T &  t 
)
friend

Definition at line 82 of file DottedPairImpl.h.

◆ operator>>

template<typename CLASS >
template<typename T >
DottedPairImpl& operator>> ( const T &  t,
DottedPairImpl< CLASS > &  s 
)
friend

Definition at line 88 of file DottedPairImpl.h.

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