TMB Documentation  v1.9.11
Public Member Functions | Public Attributes | List of all members
data_indicator< VT, Type > Struct Template Reference

Utilities for OSA residuals. More...

#include <tmb_core.hpp>

Public Member Functions

 data_indicator ()
 Default CTOR.
 
 data_indicator (VT obs, bool init_one=false)
 Construct from observation vector. More...
 
void fill (vector< Type > p, SEXP ord_)
 Fill with parameter vector.
 
vector< int > order ()
 Get order in which the one step conditionals will be requested by oneStepPredict.
 
bool osa_active ()
 Are we inside a oneStepPredict calculation?
 
data_indicator segment (int pos, int n)
 Extract segment of indicator vector or array. More...
 

Public Attributes

VT cdf_lower
 Logarithm of lower CDF
 
VT cdf_upper
 Logarithm of upper CDF
 
vector< int > ord
 Subset argument (zero-based) passed from oneStepPredict. See data_indicator::order().
 
bool osa_flag
 Flag to tell if OSA calculation is active. See data_indicator::osa_active().
 

Detailed Description

template<class VT, class Type = typename VT::Scalar>
struct data_indicator< VT, Type >

Utilities for OSA residuals.

Template Parameters
VTCan be vector<Type> or array<Type>
Warning
When extracting subsets of a data_indicator note that in general the subset is not applied to cdf_lower and cdf_upper.

Definition at line 441 of file tmb_core.hpp.

Constructor & Destructor Documentation

§ data_indicator()

template<class VT, class Type = typename VT::Scalar>
data_indicator< VT, Type >::data_indicator ( VT  obs,
bool  init_one = false 
)
inline

Construct from observation vector.

Parameters
obsObservation vector or array
init_oneIf true the data_indicator will be filled with ones signifying that all observations should be enabled.

Definition at line 456 of file tmb_core.hpp.

Member Function Documentation

§ segment()

template<class VT, class Type = typename VT::Scalar>
data_indicator data_indicator< VT, Type >::segment ( int  pos,
int  n 
)
inline

Extract segment of indicator vector or array.

Note
For this method the segment is applied to cdf_lower and cdf_upper.

Definition at line 478 of file tmb_core.hpp.


The documentation for this struct was generated from the following file:
License: GPL v2