VariableVector Class Reference

An Rcpp interface class that defines the VariableVector class. More...

#include <rcpp_interface_base.hpp>

Public Member Functions
	VariableVector ()
	The constructor.
	VariableVector (const VariableVector &other)
	The constructor.
	VariableVector (size_t size)
	The constructor.
	VariableVector (Rcpp::NumericVector x, size_t size)
	The constructor for initializing a variable vector.
	VariableVector (const fims::Vector< double > &v)
	The constructor for initializing a variable vector.
virtual	~VariableVector ()
	Destroy the Variable Vector object.
virtual uint32_t	get_id ()
	Gets the ID of the VariableVector object.
Variable &	operator[] (size_t pos)
	The accessor where the first index starts is zero.
SEXP	at (R_xlen_t pos)
	The accessor where the first index starts at one. This function is for calling accessing from R.
Variable &	get (size_t pos)
	An internal accessor for calling a position of a VariableVector from R.
void	set (size_t pos, const Variable &p)
	An internal setter for setting a position of a VariableVector from R.
size_t	size ()
	Returns the size of a VariableVector.
void	resize (size_t size)
	Resizes a VariableVector to the desired length.
void	set_values (Rcpp::NumericVector values)
	Sets the initial values for all Variables within a VariableVector.
void	set_estimation_types (Rcpp::CharacterVector estimation_types)
	Sets the estimation type for all Variables within a VariableVector.
void	fill (double value)
	Sets the value of all Variables in the VariableVector to the provided value.
void	show ()
	The printing methods for a VariableVector.

Public Attributes
std::shared_ptr< std::vector< Variable > >	storage_m
	Variable storage.
uint32_t	id_m
	The local ID of the Variable object.

Static Public Attributes
static uint32_t	id_g = 0
	The static ID of the Variable object.

Detailed Description

An Rcpp interface class that defines the VariableVector class.

An Rcpp interface class that defines the interface between R and C++ for a variable vector type.

Constructor & Destructor Documentation

VariableVector() [1/2]

VariableVector::VariableVector ( Rcpp::NumericVector  x, size_t  size  )

inline

The constructor for initializing a variable vector.

Parameters

x	A numeric vector.
size	The number of elements to copy over.

VariableVector() [2/2]

VariableVector::VariableVector ( const fims::Vector< double > &  v )

inline

The constructor for initializing a variable vector.

Parameters

v	A vector of doubles.

Member Function Documentation

at()

SEXP VariableVector::at ( R_xlen_t  pos )

inline

The accessor where the first index starts at one. This function is for calling accessing from R.

Parameters

pos	The position of the VariableVector that you want returned.

fill()

void VariableVector::fill ( double  value )

inline

Sets the value of all Variables in the VariableVector to the provided value.

Parameters

value

A double specifying the value to set all Variables to within the VariableVector.

get()

Variable & VariableVector::get ( size_t  pos )

inline

An internal accessor for calling a position of a VariableVector from R.

Parameters

pos	An integer specifying the position of the VariableVector you want returned. The first position is one and the last position is the same as the size of the VariableVector.

operator[]()

Variable & VariableVector::operator[] ( size_t  pos )

inline

The accessor where the first index starts is zero.

Parameters

pos	The position of the VariableVector that you want returned.

resize()

void VariableVector::resize ( size_t  size )

inline

Resizes a VariableVector to the desired length.

Parameters

size	An integer specifying the desired length for the VariableVector to be resized to.

set()

void VariableVector::set ( size_t  pos, const Variable &  p  )

inline

An internal setter for setting a position of a VariableVector from R.

Parameters

pos	An integer specifying the position of the VariableVector you want to set. The first position is one and the last position is the same as the size of the VariableVector.
p	A numeric value specifying the value to set position pos to in the VariableVector.

---

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

• inst/include/interface/rcpp/rcpp_objects/rcpp_interface_base.hpp
• src/rcpp_interface_base.cpp