github.com/RhysU/ar
Autoregressive process modeling tools in header-only C++
Public Types | Public Member Functions | Public Attributes | List of all members
ar::empirical_variance_iterator< EstimationMethod, Result, Integer1, Integer2 > Class Template Reference

An immutable RandomAccessIterator over a method's empirical variance sequence. More...

#include <ar.hpp>

Public Types

typedef std::random_access_iterator_tag iterator_category
 
typedef Result value_type
 
typedef std::ptrdiff_t difference_type
 

Public Member Functions

 empirical_variance_iterator ()
 Construct a past-end iterator.
 
 empirical_variance_iterator (Integer1 N)
 Construct an iterator over sequence order 0, 1, ..., N (inclusive).
 
 empirical_variance_iterator (Integer1 N, Integer2 i)
 Construct an iterator over sequence order i, i+1, ..., N (inclusive).
 
empirical_variance_iterator & operator++ ()
 
empirical_variance_iterator operator++ (int)
 
empirical_variance_iterator operator+ (const difference_type &k)
 
empirical_variance_iterator & operator+= (const difference_type &k)
 
empirical_variance_iterator & operator-- ()
 
empirical_variance_iterator operator-- (int)
 
empirical_variance_iterator operator- (const difference_type &k)
 
empirical_variance_iterator & operator-= (const difference_type &k)
 
difference_type operator- (const empirical_variance_iterator &other) const
 
bool operator== (const empirical_variance_iterator &other) const
 
bool operator!= (const empirical_variance_iterator &other) const
 
bool operator< (const empirical_variance_iterator &other) const
 
bool operator<= (const empirical_variance_iterator &other) const
 
bool operator> (const empirical_variance_iterator &other) const
 
bool operator>= (const empirical_variance_iterator &other) const
 
const value_type operator* () const
 
const value_type operator[] (const difference_type &k) const
 

Public Attributes

const typedef Result * pointer
 
const typedef Result & reference
 

Detailed Description

template<class EstimationMethod, typename Result, typename Integer1 = std::size_t, typename Integer2 = Integer1>
class ar::empirical_variance_iterator< EstimationMethod, Result, Integer1, Integer2 >

An immutable RandomAccessIterator over a method's empirical variance sequence.

Facilitates using algorithms like std::copy, std::accumulate, and std::partial_sum when comparing a hierarchy of models during model order selection.

The (N+1)-length sequence of orders 0, 1, ..., N is iterated given sample size N. Default constructed instances represent past-end iterators.

Definition at line 1688 of file ar.hpp.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17