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

Structure to hold a matrix variable declaration. More...

#include <matrix_var_decl.hpp>

Inheritance diagram for stan::lang::matrix_var_decl:
stan::lang::base_var_decl

Public Member Functions

 matrix_var_decl ()
 Construct a matrix variable declaration with default values. More...
 
 matrix_var_decl (const range &range, const expression &M, const expression &N, const std::string &name, const std::vector< expression > &dims, const expression &def)
 Construct a matrix variable declaration with the specified range constraints, number of rows, number of columns, name, number of array dimensions, and definition. More...
 
- Public Member Functions inherited from stan::lang::base_var_decl
 base_var_decl ()
 Construct a default base variable declaration. More...
 
 base_var_decl (const base_expr_type &base_type)
 Construct a base variable declaration of the specified type. More...
 
 base_var_decl (const std::string &name, const std::vector< expression > &dims, const base_expr_type &base_type)
 Construct a base variable declaration with the specified name, dimensions, and base type. More...
 
 base_var_decl (const std::string &name, const std::vector< expression > &dims, const base_expr_type &base_type, const expression &def)
 Construct a base variable declaration with the specified name, dimensions, base type, and definition. More...
 

Public Attributes

range range_
 Optional lower and upper bound constraints. More...
 
expression M_
 Number of rows. More...
 
expression N_
 Number of columns. More...
 
- Public Attributes inherited from stan::lang::base_var_decl
std::string name_
 Name of the variable. More...
 
std::vector< expressiondims_
 Dimension sizes for variable. More...
 
base_expr_type base_type_
 Base type for variable. More...
 
expression def_
 Definition for variable (nil if undefined). More...
 

Detailed Description

Structure to hold a matrix variable declaration.

Definition at line 16 of file matrix_var_decl.hpp.

Constructor & Destructor Documentation

§ matrix_var_decl() [1/2]

stan::lang::matrix_var_decl::matrix_var_decl ( )

Construct a matrix variable declaration with default values.

Definition at line 11 of file matrix_var_decl_def.hpp.

§ matrix_var_decl() [2/2]

stan::lang::matrix_var_decl::matrix_var_decl ( const range range,
const expression M,
const expression N,
const std::string &  name,
const std::vector< expression > &  dims,
const expression def 
)

Construct a matrix variable declaration with the specified range constraints, number of rows, number of columns, name, number of array dimensions, and definition.

Parameters
rangelower and upper bounds on values
Mnumber of rows
Nnumber of columns
namevariable name
dimsarray dimension sizes
defdefition of variable

Definition at line 13 of file matrix_var_decl_def.hpp.

Member Data Documentation

§ M_

expression stan::lang::matrix_var_decl::M_

Number of rows.

Definition at line 25 of file matrix_var_decl.hpp.

§ N_

expression stan::lang::matrix_var_decl::N_

Number of columns.

Definition at line 30 of file matrix_var_decl.hpp.

§ range_

range stan::lang::matrix_var_decl::range_

Optional lower and upper bound constraints.

Definition at line 20 of file matrix_var_decl.hpp.


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

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