stan Namespace Reference

Namespaces
	callbacks
	io
	json
	lang
	math
	mcmc
	model
	optimization
	services
	test
	variational

Classes
struct	contains_fvar
struct	contains_nonconstant_struct
struct	contains_std_vector
struct	contains_vector
struct	error_index
struct	is_constant
struct	is_constant_struct
struct	is_constant_struct< Eigen::Block< T > >
struct	is_constant_struct< Eigen::Matrix< T, R, C > >
struct	is_constant_struct< std::vector< T > >
struct	is_fvar
struct	is_fvar< stan::math::fvar< T > >
struct	is_std_vector
struct	is_std_vector< std::vector< T > >
struct	is_var
struct	is_var< stan::math::var >
struct	is_var_or_arithmetic
struct	is_vector
struct	is_vector< const T >
struct	is_vector< Eigen::Block< T > >
struct	is_vector< Eigen::Matrix< T, 1, Eigen::Dynamic > >
struct	is_vector< Eigen::Matrix< T, Eigen::Dynamic, 1 > >
struct	is_vector< std::vector< T > >
struct	is_vector_like
struct	is_vector_like< const T >
struct	is_vector_like< Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > >
struct	is_vector_like< T * >
struct	partials_return_type
struct	partials_type
struct	partials_type< stan::math::fvar< T > >
struct	partials_type< stan::math::var >
struct	return_type
class	scalar_seq_view
class	scalar_seq_view< T, T >
struct	scalar_type
struct	scalar_type< const Eigen::Matrix< T, R, C > & >
struct	scalar_type< const Eigen::Matrix< T, R, C > >
struct	scalar_type< const std::vector< T > & >
struct	scalar_type< const std::vector< T > >
struct	scalar_type< Eigen::Block< T > >
struct	scalar_type< Eigen::Matrix< T, R, C > & >
struct	scalar_type< Eigen::Matrix< T, R, C > >
struct	scalar_type< std::vector< T > & >
struct	scalar_type< std::vector< T > >
struct	scalar_type< T * >
struct	scalar_type_pre
struct	size_of_helper
struct	size_of_helper< T, true >
class	StdVectorBuilder
class	vector_seq_view
class	vector_seq_view< Eigen::Matrix< S, 1, Eigen::Dynamic > >
class	vector_seq_view< Eigen::Matrix< S, Eigen::Dynamic, 1 > >
class	vector_seq_view< std::vector< Eigen::Matrix< S, 1, Eigen::Dynamic > > >
class	vector_seq_view< std::vector< Eigen::Matrix< S, Eigen::Dynamic, 1 > > >
class	VectorBuilder
class	VectorBuilderHelper
class	VectorBuilderHelper< T1, true, false >
class	VectorBuilderHelper< T1, true, true >

Functions
template<typename T >
T	get (const std::vector< T > &x, size_t n)
template<typename T >
size_t	length (const std::vector< T > &x)
template<typename T , int R, int C>
T	get (const Eigen::Matrix< T, R, C > &m, size_t n)
template<typename T , int R, int C>
size_t	length (const Eigen::Matrix< T, R, C > &m)
template<typename T , int R, int C>
size_t	length_mvt (const Eigen::Matrix< T, R, C > &)
template<typename T , int R, int C>
size_t	length_mvt (const std::vector< Eigen::Matrix< T, R, C > > &x)
template<typename T >
T	get (const T &x, size_t n)
template<typename T >
size_t	length (const T &)
template<typename T >
size_t	length_mvt (const T &)
template<typename T1 , typename T2 >
size_t	max_size (const T1 &x1, const T2 &x2)
template<typename T1 , typename T2 , typename T3 >
size_t	max_size (const T1 &x1, const T2 &x2, const T3 &x3)
template<typename T1 , typename T2 , typename T3 , typename T4 >
size_t	max_size (const T1 &x1, const T2 &x2, const T3 &x3, const T4 &x4)
template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
size_t	max_size (const T1 &x1, const T2 &x2, const T3 &x3, const T4 &x4, const T5 &x5)
template<typename T1 , typename T2 >
size_t	max_size_mvt (const T1 &x1, const T2 &x2)
template<typename T1 , typename T2 , typename T3 >
size_t	max_size_mvt (const T1 &x1, const T2 &x2, const T3 &x3)
template<typename T1 , typename T2 , typename T3 , typename T4 >
size_t	max_size_mvt (const T1 &x1, const T2 &x2, const T3 &x3, const T4 &x4)
template<typename T >
size_t	size_of (const T &x)

Variables
const std::string	MAJOR_VERSION = STAN_STRING(STAN_MAJOR)
const std::string	MINOR_VERSION = STAN_STRING(STAN_MINOR)
const std::string	PATCH_VERSION = STAN_STRING(STAN_PATCH)

Detailed Description

StanTypedefs.h: Typedefs of various types templated over stan::math::var, centralized here for convenience. They don't get put in the header files associated with the types themselves because there's an annoying chain of declarations needed for the typedef'ing, and it's much easier to maintain if it's in a single place.

Function Documentation

template<typename T , int R, int C>

T stan::get ( const Eigen::Matrix< T, R, C > &  m, size_t  n  )

inline

Definition at line 9 of file get.hpp.

References m, and getGoodRuns4SAM::n.

                                                      {
  return m(static_cast<int>(n));
}

template<typename T >

T stan::get ( const std::vector< T > &  x, size_t  n  )

inline

Definition at line 10 of file get.hpp.

References getGoodRuns4SAM::n.

Referenced by stan::math::internal::bounded< T_y, T_low, T_high, true >::check(), stan::math::domain_error_vec(), and stan::math::invalid_argument_vec().

                                              {
  return x[n];
}

template<typename T >

T stan::get ( const T &  x, size_t  n  )

inline

Definition at line 10 of file get.hpp.

References submit_syst::x.

                                   {
  return x;
}

template<typename T , int R, int C>

size_t stan::length

(

const Eigen::Matrix< T, R, C > &

m

)

Definition at line 9 of file length.hpp.

                                             {
  return m.size();
}

template<typename T >

size_t stan::length

(

const T &

)

Definition at line 9 of file length.hpp.

                          {
  return 1U;
}

template<typename T >

size_t stan::length

(

const std::vector< T > &

x

)

Definition at line 10 of file length.hpp.

Referenced by stan::math::bernoulli_cdf(), stan::math::bernoulli_lccdf(), stan::math::bernoulli_lcdf(), stan::math::bernoulli_lpmf(), stan::math::bernoulli_rng(), stan::math::beta_binomial_cdf(), stan::math::beta_binomial_lccdf(), stan::math::beta_binomial_lcdf(), stan::math::beta_binomial_lpmf(), stan::math::beta_cdf(), stan::math::beta_lpdf(), stan::math::binomial_cdf(), stan::math::binomial_lccdf(), stan::math::binomial_lcdf(), stan::math::binomial_logit_lpmf(), stan::math::binomial_lpmf(), stan::math::cauchy_cdf(), stan::math::cauchy_lpdf(), stan::math::internal::bounded< T_y, T_low, T_high, true >::check(), stan::math::chi_square_cdf(), stan::math::chi_square_lccdf(), stan::math::chi_square_lcdf(), stan::math::chi_square_lpdf(), stan::math::chi_square_rng(), stan::math::dot_product(), stan::math::double_exponential_lpdf(), stan::math::gevv_vvv_vari::eval_gevv(), stan::math::exp_mod_normal_cdf(), stan::math::exponential_lpdf(), stan::math::exponential_rng(), stan::math::frechet_cdf(), stan::math::frechet_lpdf(), stan::math::gamma_cdf(), stan::math::gamma_lccdf(), stan::math::gamma_lcdf(), stan::math::gamma_lpdf(), stan::math::gumbel_cdf(), stan::math::gumbel_lpdf(), stan::math::inv_chi_square_cdf(), stan::math::inv_chi_square_lccdf(), stan::math::inv_chi_square_lcdf(), stan::math::inv_chi_square_lpdf(), stan::math::inv_chi_square_rng(), stan::math::inv_gamma_cdf(), stan::math::inv_gamma_lccdf(), stan::math::inv_gamma_lcdf(), stan::math::inv_gamma_lpdf(), stan::math::log_mix(), stan::math::logistic_cdf(), stan::math::logistic_lccdf(), stan::math::logistic_lcdf(), stan::math::logistic_lpdf(), stan::math::lognormal_cdf(), stan::math::lognormal_lccdf(), stan::math::lognormal_lcdf(), stan::math::lognormal_lpdf(), max_size(), stan::math::neg_binomial_2_cdf(), stan::math::neg_binomial_2_lcdf(), stan::math::neg_binomial_2_log_glm_lpmf(), stan::math::neg_binomial_2_log_lpmf(), stan::math::neg_binomial_2_lpmf(), stan::math::neg_binomial_cdf(), stan::math::neg_binomial_lccdf(), stan::math::neg_binomial_lcdf(), stan::math::neg_binomial_lpmf(), stan::math::normal_cdf(), stan::math::normal_id_glm_lpdf(), stan::math::normal_lpdf(), stan::math::internal::ops_partials_edge< Dx, std::vector< std::vector< fvar< Dx > > > >::ops_partials_edge(), stan::math::internal::ops_partials_edge< double, std::vector< std::vector< var > > >::ops_partials_edge(), stan::math::pareto_cdf(), stan::math::pareto_lccdf(), stan::math::pareto_lcdf(), stan::math::pareto_lpdf(), stan::math::pareto_type_2_cdf(), stan::math::pareto_type_2_lpdf(), stan::math::poisson_cdf(), stan::math::poisson_lccdf(), stan::math::poisson_lcdf(), stan::math::poisson_log_glm_lpmf(), stan::math::poisson_log_lpmf(), stan::math::poisson_log_rng(), stan::math::poisson_rng(), stan::math::rayleigh_cdf(), stan::math::rayleigh_lccdf(), stan::math::rayleigh_lcdf(), stan::math::rayleigh_lpdf(), stan::math::rayleigh_rng(), stan::math::scaled_inv_chi_square_cdf(), stan::math::scaled_inv_chi_square_lccdf(), stan::math::scaled_inv_chi_square_lcdf(), stan::math::scaled_inv_chi_square_lpdf(), stan::math::size_zero(), stan::math::skew_normal_cdf(), stan::math::skew_normal_lpdf(), stan::math::std_normal_lpdf(), stan::math::student_t_cdf(), stan::math::student_t_lccdf(), stan::math::student_t_lcdf(), stan::math::student_t_lpdf(), stan::math::uniform_cdf(), stan::math::von_mises_lpdf(), stan::math::weibull_cdf(), and stan::math::weibull_lpdf().

                                     {
  return x.size();
}

template<typename T , int R, int C>

size_t stan::length_mvt

(

const Eigen::Matrix< T, R, C > &

)

Definition at line 12 of file length_mvt.hpp.

Referenced by max_size_mvt(), stan::math::multi_normal_cholesky_lpdf(), stan::math::multi_normal_cholesky_rng(), stan::math::multi_normal_lpdf(), stan::math::multi_normal_prec_lpdf(), stan::math::multi_normal_rng(), stan::math::multi_student_t_lpdf(), and stan::math::multi_student_t_rng().

                                                 {
  return 1U;
}

template<typename T , int R, int C>

size_t stan::length_mvt

(

const std::vector< Eigen::Matrix< T, R, C > > &

x

)

Definition at line 17 of file length_mvt.hpp.

References submit_syst::x.

                                                             {
  return x.size();
}

template<typename T >

size_t stan::length_mvt

(

const T &

)

length_mvt provides the length of a multivariate argument.

This is the default template function. For any scalar type, this will throw an std::invalid_argument exception since a scalar is not a multivariate structure.

Template Parameters

T	type to take length of. The default template function should only match scalars.

Exceptions

std::invalid_argument

since the type is a scalar.

Definition at line 21 of file length_mvt.hpp.

References stan::math::invalid_argument().

                              {
  throw std::invalid_argument("length_mvt passed to an unrecognized type.");
  return 1U;
}

template<typename T1 , typename T2 >

size_t stan::max_size	(	const T1 &	x1,
		const T2 &	x2
	)

Definition at line 9 of file max_size.hpp.

References length(), and fillBadChanDBTables::result.

Referenced by stan::math::bernoulli_cdf(), stan::math::bernoulli_lccdf(), stan::math::bernoulli_lcdf(), stan::math::bernoulli_logit_lpmf(), stan::math::bernoulli_lpmf(), stan::math::beta_binomial_cdf(), stan::math::beta_binomial_lccdf(), stan::math::beta_binomial_lcdf(), stan::math::beta_binomial_lpmf(), stan::math::beta_cdf(), stan::math::beta_lccdf(), stan::math::beta_lcdf(), stan::math::beta_lpdf(), stan::math::beta_rng(), stan::math::binomial_cdf(), stan::math::binomial_lccdf(), stan::math::binomial_lcdf(), stan::math::binomial_logit_lpmf(), stan::math::binomial_lpmf(), stan::math::binomial_rng(), stan::math::cauchy_cdf(), stan::math::cauchy_lccdf(), stan::math::cauchy_lcdf(), stan::math::cauchy_lpdf(), stan::math::cauchy_rng(), stan::math::internal::bounded< T_y, T_low, T_high, y_is_vec >::check(), stan::math::check_consistent_sizes(), stan::math::chi_square_cdf(), stan::math::chi_square_lccdf(), stan::math::chi_square_lcdf(), stan::math::chi_square_lpdf(), stan::math::double_exponential_cdf(), stan::math::double_exponential_lccdf(), stan::math::double_exponential_lcdf(), stan::math::double_exponential_lpdf(), stan::math::double_exponential_rng(), stan::math::exp_mod_normal_cdf(), stan::math::exp_mod_normal_lccdf(), stan::math::exp_mod_normal_lcdf(), stan::math::exp_mod_normal_lpdf(), stan::math::exp_mod_normal_rng(), stan::math::exponential_cdf(), stan::math::exponential_lccdf(), stan::math::exponential_lcdf(), stan::math::exponential_lpdf(), stan::math::frechet_cdf(), stan::math::frechet_lccdf(), stan::math::frechet_lcdf(), stan::math::frechet_lpdf(), stan::math::frechet_rng(), stan::math::gamma_cdf(), stan::math::gamma_lccdf(), stan::math::gamma_lcdf(), stan::math::gamma_lpdf(), stan::math::gamma_rng(), stan::math::gumbel_cdf(), stan::math::gumbel_lccdf(), stan::math::gumbel_lcdf(), stan::math::gumbel_lpdf(), stan::math::gumbel_rng(), stan::math::hypergeometric_lpmf(), stan::math::inv_chi_square_cdf(), stan::math::inv_chi_square_lccdf(), stan::math::inv_chi_square_lcdf(), stan::math::inv_chi_square_lpdf(), stan::math::inv_gamma_cdf(), stan::math::inv_gamma_lccdf(), stan::math::inv_gamma_lcdf(), stan::math::inv_gamma_lpdf(), stan::math::inv_gamma_rng(), stan::math::logistic_cdf(), stan::math::logistic_lccdf(), stan::math::logistic_lcdf(), stan::math::logistic_lpdf(), stan::math::logistic_rng(), stan::math::lognormal_cdf(), stan::math::lognormal_lccdf(), stan::math::lognormal_lcdf(), stan::math::lognormal_lpdf(), stan::math::lognormal_rng(), stan::math::neg_binomial_2_cdf(), stan::math::neg_binomial_2_lccdf(), stan::math::neg_binomial_2_lcdf(), stan::math::neg_binomial_2_log_lpmf(), stan::math::neg_binomial_2_log_rng(), stan::math::neg_binomial_2_lpmf(), stan::math::neg_binomial_2_rng(), stan::math::neg_binomial_cdf(), stan::math::neg_binomial_lccdf(), stan::math::neg_binomial_lcdf(), stan::math::neg_binomial_lpmf(), stan::math::neg_binomial_rng(), stan::math::normal_cdf(), stan::math::normal_lccdf(), stan::math::normal_lcdf(), stan::math::normal_lpdf(), stan::math::normal_rng(), stan::math::normal_sufficient_lpdf(), stan::math::pareto_cdf(), stan::math::pareto_lccdf(), stan::math::pareto_lcdf(), stan::math::pareto_lpdf(), stan::math::pareto_rng(), stan::math::pareto_type_2_cdf(), stan::math::pareto_type_2_lccdf(), stan::math::pareto_type_2_lcdf(), stan::math::pareto_type_2_lpdf(), stan::math::pareto_type_2_rng(), stan::math::poisson_cdf(), stan::math::poisson_lccdf(), stan::math::poisson_lcdf(), stan::math::poisson_log_lpmf(), stan::math::poisson_lpmf(), stan::math::rayleigh_cdf(), stan::math::rayleigh_lccdf(), stan::math::rayleigh_lcdf(), stan::math::rayleigh_lpdf(), stan::math::scaled_inv_chi_square_cdf(), stan::math::scaled_inv_chi_square_lccdf(), stan::math::scaled_inv_chi_square_lcdf(), stan::math::scaled_inv_chi_square_lpdf(), stan::math::scaled_inv_chi_square_rng(), stan::math::skew_normal_cdf(), stan::math::skew_normal_lccdf(), stan::math::skew_normal_lcdf(), stan::math::skew_normal_lpdf(), stan::math::skew_normal_rng(), stan::math::student_t_cdf(), stan::math::student_t_lccdf(), stan::math::student_t_lcdf(), stan::math::student_t_lpdf(), stan::math::student_t_rng(), stan::math::uniform_cdf(), stan::math::uniform_lccdf(), stan::math::uniform_lcdf(), stan::math::uniform_lpdf(), stan::math::uniform_rng(), stan::math::von_mises_lpdf(), stan::math::von_mises_rng(), stan::math::weibull_cdf(), stan::math::weibull_lccdf(), stan::math::weibull_lcdf(), stan::math::weibull_lpdf(), stan::math::weibull_rng(), and stan::math::wiener_lpdf().

                                            {
  size_t result = length(x1);
  result = result > length(x2) ? result : length(x2);
  return result;
}

template<typename T1 , typename T2 , typename T3 >

size_t stan::max_size	(	const T1 &	x1,
		const T2 &	x2,
		const T3 &	x3
	)

Definition at line 16 of file max_size.hpp.

References length(), and fillBadChanDBTables::result.

                                                          {
  size_t result = length(x1);
  result = result > length(x2) ? result : length(x2);
  result = result > length(x3) ? result : length(x3);
  return result;
}

template<typename T1 , typename T2 , typename T3 , typename T4 >

size_t stan::max_size	(	const T1 &	x1,
		const T2 &	x2,
		const T3 &	x3,
		const T4 &	x4
	)

Definition at line 24 of file max_size.hpp.

References length(), and fillBadChanDBTables::result.

                                                                        {
  size_t result = length(x1);
  result = result > length(x2) ? result : length(x2);
  result = result > length(x3) ? result : length(x3);
  result = result > length(x4) ? result : length(x4);
  return result;
}

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >

size_t stan::max_size	(	const T1 &	x1,
		const T2 &	x2,
		const T3 &	x3,
		const T4 &	x4,
		const T5 &	x5
	)

Definition at line 33 of file max_size.hpp.

References length(), and fillBadChanDBTables::result.

                              {
  size_t result = length(x1);
  result = result > length(x2) ? result : length(x2);
  result = result > length(x3) ? result : length(x3);
  result = result > length(x4) ? result : length(x4);
  result = result > length(x5) ? result : length(x5);
  return result;
}

template<typename T1 , typename T2 >

size_t stan::max_size_mvt	(	const T1 &	x1,
		const T2 &	x2
	)

Definition at line 10 of file max_size_mvt.hpp.

References length_mvt(), and fillBadChanDBTables::result.

Referenced by stan::math::multi_normal_cholesky_lpdf(), stan::math::multi_normal_lpdf(), stan::math::multi_normal_prec_lpdf(), and stan::math::multi_student_t_lpdf().

                                                {
  size_t result = length_mvt(x1);
  result = result > length_mvt(x2) ? result : length_mvt(x2);
  return result;
}

template<typename T1 , typename T2 , typename T3 >

size_t stan::max_size_mvt	(	const T1 &	x1,
		const T2 &	x2,
		const T3 &	x3
	)

Definition at line 17 of file max_size_mvt.hpp.

References length_mvt(), and fillBadChanDBTables::result.

                                                              {
  size_t result = length_mvt(x1);
  result = result > length_mvt(x2) ? result : length_mvt(x2);
  result = result > length_mvt(x3) ? result : length_mvt(x3);
  return result;
}

template<typename T1 , typename T2 , typename T3 , typename T4 >

size_t stan::max_size_mvt	(	const T1 &	x1,
		const T2 &	x2,
		const T3 &	x3,
		const T4 &	x4
	)

Definition at line 25 of file max_size_mvt.hpp.

References length_mvt(), and fillBadChanDBTables::result.

                                                                            {
  size_t result = length_mvt(x1);
  result = result > length_mvt(x2) ? result : length_mvt(x2);
  result = result > length_mvt(x3) ? result : length_mvt(x3);
  result = result > length_mvt(x4) ? result : length_mvt(x4);
  return result;
}

template<typename T >

size_t stan::size_of

(

const T &

x

)

Definition at line 20 of file size_of.hpp.

References stan::size_of_helper< T, is_vec >::size_of().

Referenced by stan::math::check_consistent_size(), and stan::math::check_consistent_sizes().

                           {
  return size_of_helper<T, is_vector<T>::value>::size_of(x);
}

Variable Documentation

const std::string stan::MAJOR_VERSION = STAN_STRING(STAN_MAJOR)

Major version number for Stan package.

Definition at line 21 of file version.hpp.

Referenced by stan::lang::generate_version_comment(), print_version(), and TEST().

const std::string stan::MINOR_VERSION = STAN_STRING(STAN_MINOR)

Minor version number for Stan package.

Definition at line 24 of file version.hpp.

Referenced by stan::lang::generate_version_comment(), print_version(), and TEST().

const std::string stan::PATCH_VERSION = STAN_STRING(STAN_PATCH)

Patch version for Stan package.

Definition at line 27 of file version.hpp.

Referenced by stan::lang::generate_version_comment(), print_version(), and TEST().