Stan  2.14.0
probability, sampling & optimization
Public Types | Public Member Functions | Public Attributes | List of all members
stan::lang::idx Struct Reference

AST variant structure for indexes, holding any of a unary, multi, omni, lower-bound, upper-bound, or lower- and upper-bound index. More...

#include <idx.hpp>

Public Types

typedef boost::variant< boost::recursive_wrapper< uni_idx >, boost::recursive_wrapper< multi_idx >, boost::recursive_wrapper< omni_idx >, boost::recursive_wrapper< lb_idx >, boost::recursive_wrapper< ub_idx >, boost::recursive_wrapper< lub_idx > > idx_t
 Variant type for the six index types. More...
 

Public Member Functions

 idx ()
 Construct a default index. More...
 
 idx (const uni_idx &i)
 Construct a unary index with specified index. More...
 
 idx (const multi_idx &i)
 Construct a multiple index with specified index. More...
 
 idx (const omni_idx &i)
 Construct a universal index with specified index. More...
 
 idx (const lb_idx &i)
 Construct a lower-bound index with specified index. More...
 
 idx (const ub_idx &i)
 Construct an upper-bound index with specified index. More...
 
 idx (const lub_idx &i)
 Construct a lower- and upper-bound index with specified index. More...
 

Public Attributes

idx_t idx_
 The index variant object. More...
 

Detailed Description

AST variant structure for indexes, holding any of a unary, multi, omni, lower-bound, upper-bound, or lower- and upper-bound index.

Definition at line 20 of file idx.hpp.

Member Typedef Documentation

§ idx_t

typedef boost::variant<boost::recursive_wrapper<uni_idx>, boost::recursive_wrapper<multi_idx>, boost::recursive_wrapper<omni_idx>, boost::recursive_wrapper<lb_idx>, boost::recursive_wrapper<ub_idx>, boost::recursive_wrapper<lub_idx> > stan::lang::idx::idx_t

Variant type for the six index types.

Definition at line 30 of file idx.hpp.

Constructor & Destructor Documentation

§ idx() [1/7]

stan::lang::idx::idx ( )

Construct a default index.

Definition at line 9 of file idx_def.hpp.

§ idx() [2/7]

stan::lang::idx::idx ( const uni_idx i)

Construct a unary index with specified index.

Parameters
iindex

Definition at line 11 of file idx_def.hpp.

§ idx() [3/7]

stan::lang::idx::idx ( const multi_idx i)

Construct a multiple index with specified index.

Parameters
iindex

Definition at line 13 of file idx_def.hpp.

§ idx() [4/7]

stan::lang::idx::idx ( const omni_idx i)

Construct a universal index with specified index.

Parameters
iindex

Definition at line 15 of file idx_def.hpp.

§ idx() [5/7]

stan::lang::idx::idx ( const lb_idx i)

Construct a lower-bound index with specified index.

Parameters
iindex

Definition at line 17 of file idx_def.hpp.

§ idx() [6/7]

stan::lang::idx::idx ( const ub_idx i)

Construct an upper-bound index with specified index.

Parameters
iindex

Definition at line 19 of file idx_def.hpp.

§ idx() [7/7]

stan::lang::idx::idx ( const lub_idx i)

Construct a lower- and upper-bound index with specified index.

Parameters
iindex

Definition at line 21 of file idx_def.hpp.

Member Data Documentation

§ idx_

idx_t stan::lang::idx::idx_

The index variant object.

Definition at line 82 of file idx.hpp.


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

     [ Stan Home Page ] © 2011–2016, Stan Development Team.