Rcpp Version 1.1.2
Loading...
Searching...
No Matches
Rcpp::sugar::Head< RTYPE, NA, T > Class Template Reference

#include <head.h>

Inheritance diagram for Rcpp::sugar::Head< RTYPE, NA, T >:
Collaboration diagram for Rcpp::sugar::Head< RTYPE, NA, T >:

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, VECTOR >
typedef traits::storage_type< RTYPE >::type stored_type
typedef traits::storage_type< RTYPE >::type elem_type
typedef iter_base< iter_traitsiterator
typedef iter_base< const_iter_traitsconst_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, VECTOR >
VECTOR & get_ref ()
const VECTOR & 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_TYPEobject
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 n, and object.

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 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 Head(), and 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.

Referenced by Head().


The documentation for this class was generated from the following file:
  • inst/include/Rcpp/sugar/functions/head.h