Rcpp Version 1.0.9
Public Types | Public Member Functions | Private Attributes | List of all members
Rcpp::sugar::Head< RTYPE, NA, T > Class Template Reference

#include <head.h>

Inheritance diagram for Rcpp::sugar::Head< RTYPE, NA, T >:
Inheritance graph
[legend]
Collaboration diagram for Rcpp::sugar::Head< RTYPE, NA, T >:
Collaboration graph
[legend]

Public Types

typedef Rcpp::VectorBase< RTYPE, NA, T > VEC_TYPE
 
typedef Rcpp::traits::storage_type< RTYPE >::type STORAGE
 
- Public Types inherited from Rcpp::VectorBase< RTYPE, NA, Head< RTYPE, NA, T > >
typedef traits::storage_type< RTYPE >::type stored_type
 
typedef traits::storage_type< RTYPE >::type elem_type
 
typedef iter_base< iter_traits > iterator
 
typedef iter_base< const_iter_traits > const_iterator
 

Public Member Functions

 Head (const VEC_TYPE &object_, R_xlen_t n_)
 
STORAGE operator[] (R_xlen_t i) const
 
R_xlen_t size () const
 
- Public Member Functions inherited from Rcpp::VectorBase< RTYPE, NA, Head< RTYPE, NA, T > >
Head< RTYPE, NA, T > & get_ref ()
 
const Head< RTYPE, NA, T > & get_ref () const
 
stored_type operator[] (R_xlen_t i) const
 
R_xlen_t size () const
 
const_iterator begin () const
 
const_iterator end () const
 
const_iterator cbegin () const
 
const_iterator cend () const
 

Private Attributes

const VEC_TYPE & object
 
int n
 

Detailed Description

template<int RTYPE, bool NA, typename T>
class Rcpp::sugar::Head< RTYPE, NA, T >

Definition at line 29 of file head.h.

Member Typedef Documentation

◆ STORAGE

template<int RTYPE, bool NA, typename T >
typedef Rcpp::traits::storage_type<RTYPE>::type Rcpp::sugar::Head< RTYPE, NA, T >::STORAGE

Definition at line 32 of file head.h.

◆ VEC_TYPE

template<int RTYPE, bool NA, typename T >
typedef Rcpp::VectorBase<RTYPE,NA,T> Rcpp::sugar::Head< RTYPE, NA, T >::VEC_TYPE

Definition at line 31 of file head.h.

Constructor & Destructor Documentation

◆ Head()

template<int RTYPE, bool NA, typename T >
Rcpp::sugar::Head< RTYPE, NA, T >::Head ( const VEC_TYPE &  object_,
R_xlen_t  n_ 
)
inline

Definition at line 34 of file head.h.

References Rcpp::sugar::Head< RTYPE, NA, T >::n.

Member Function Documentation

◆ operator[]()

template<int RTYPE, bool NA, typename T >
STORAGE Rcpp::sugar::Head< RTYPE, NA, T >::operator[] ( R_xlen_t  i) const
inline

Definition at line 40 of file head.h.

◆ size()

template<int RTYPE, bool NA, typename T >
R_xlen_t Rcpp::sugar::Head< RTYPE, NA, T >::size ( ) const
inline

Definition at line 43 of file head.h.

References Rcpp::sugar::Head< RTYPE, NA, T >::n.

Member Data Documentation

◆ n

template<int RTYPE, bool NA, typename T >
int Rcpp::sugar::Head< RTYPE, NA, T >::n
private

Definition at line 47 of file head.h.

Referenced by Rcpp::sugar::Head< RTYPE, NA, T >::Head(), and Rcpp::sugar::Head< RTYPE, NA, T >::size().

◆ object

template<int RTYPE, bool NA, typename T >
const VEC_TYPE& Rcpp::sugar::Head< RTYPE, NA, T >::object
private

Definition at line 46 of file head.h.

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