All Classes Namespaces Files Functions Variables Typedefs Enumerator Friends Macros Groups
binomial_logit_log.hpp
Go to the documentation of this file.
#ifndef STAN_MATH_PRIM_SCAL_PROB_BINOMIAL_LOGIT_LOG_HPP
#define STAN_MATH_PRIM_SCAL_PROB_BINOMIAL_LOGIT_LOG_HPP
#include <boost/random/binomial_distribution.hpp>
#include <boost/random/variate_generator.hpp>
#include <stan/math/prim/scal/meta/OperandsAndPartials.hpp>
#include <stan/math/prim/scal/err/check_consistent_sizes.hpp>
#include <stan/math/prim/scal/err/check_bounded.hpp>
#include <stan/math/prim/scal/err/check_finite.hpp>
#include <stan/math/prim/scal/err/check_greater_or_equal.hpp>
#include <stan/math/prim/scal/err/check_less_or_equal.hpp>
#include <stan/math/prim/scal/err/check_nonnegative.hpp>
#include <stan/math/prim/scal/fun/constants.hpp>
#include <stan/math/prim/scal/fun/inv_logit.hpp>
#include <stan/math/prim/scal/fun/log1m.hpp>
#include <stan/math/prim/scal/fun/log_inv_logit.hpp>
#include <stan/math/prim/scal/fun/multiply_log.hpp>
#include <stan/math/prim/scal/fun/value_of.hpp>
#include <stan/math/prim/scal/fun/binomial_coefficient_log.hpp>
#include <stan/math/prim/scal/fun/lbeta.hpp>
#include <stan/math/prim/scal/meta/VectorBuilder.hpp>
#include <stan/math/prim/scal/meta/include_summand.hpp>
#include <stan/math/prim/scal/fun/inc_beta.hpp>
namespace stan {
namespace math {
// BinomialLogit(n|N, alpha) [N >= 0; 0 <= n <= N]
// BinomialLogit(n|N, alpha) = Binomial(n|N, inv_logit(alpha))
template <bool propto,
typename T_n,
typename T_N,
typename T_prob>
typename return_type<T_prob>::type
binomial_logit_log(const T_n& n,
const T_N& N,
const T_prob& alpha) {
typedef typename stan::partials_return_type<T_n, T_N, T_prob>::type
T_partials_return;
static const char* function("stan::math::binomial_logit_log");
using stan::math::check_finite;
using stan::math::check_bounded;
using stan::math::check_nonnegative;
using stan::math::value_of;
using stan::math::check_consistent_sizes;
using stan::math::include_summand;
// check if any vectors are zero length
if (!(stan::length(n)
&& stan::length(N)
&& stan::length(alpha)))
return 0.0;
T_partials_return logp = 0;
check_bounded(function, "Successes variable", n, 0, N);
check_nonnegative(function, "Population size parameter", N);
check_finite(function, "Probability parameter", alpha);
check_consistent_sizes(function,
"Successes variable", n,
"Population size parameter", N,
"Probability parameter", alpha);
// check if no variables are involved and prop-to
if (!include_summand<propto, T_prob>::value)
return 0.0;
// set up template expressions wrapping scalars into vector views
VectorView<const T_n> n_vec(n);
VectorView<const T_N> N_vec(N);
VectorView<const T_prob> alpha_vec(alpha);
size_t size = max_size(n, N, alpha);
OperandsAndPartials<T_prob> operands_and_partials(alpha);
using stan::math::binomial_coefficient_log;
using stan::math::log_inv_logit;
using stan::math::inv_logit;
if (include_summand<propto>::value) {
for (size_t i = 0; i < size; ++i)
logp += binomial_coefficient_log(N_vec[i], n_vec[i]);
}
VectorBuilder<true, T_partials_return, T_prob>
log_inv_logit_alpha(length(alpha));
for (size_t i = 0; i < length(alpha); ++i)
log_inv_logit_alpha[i] = log_inv_logit(value_of(alpha_vec[i]));
VectorBuilder<true, T_partials_return, T_prob>
log_inv_logit_neg_alpha(length(alpha));
for (size_t i = 0; i < length(alpha); ++i)
log_inv_logit_neg_alpha[i] = log_inv_logit(-value_of(alpha_vec[i]));
for (size_t i = 0; i < size; ++i)
logp += n_vec[i] * log_inv_logit_alpha[i]
+ (N_vec[i] - n_vec[i]) * log_inv_logit_neg_alpha[i];
if (length(alpha) == 1) {
T_partials_return temp1 = 0;
T_partials_return temp2 = 0;
for (size_t i = 0; i < size; ++i) {
temp1 += n_vec[i];
temp2 += N_vec[i] - n_vec[i];
}
if (!is_constant_struct<T_prob>::value) {
operands_and_partials.d_x1[0]
+= temp1 * inv_logit(-value_of(alpha_vec[0]))
- temp2 * inv_logit(value_of(alpha_vec[0]));
}
} else {
if (!is_constant_struct<T_prob>::value) {
for (size_t i = 0; i < size; ++i)
operands_and_partials.d_x1[i]
+= n_vec[i] * inv_logit(-value_of(alpha_vec[i]))
- (N_vec[i] - n_vec[i]) * inv_logit(value_of(alpha_vec[i]));
}
}
return operands_and_partials.to_var(logp, alpha);
}
template <typename T_n,
typename T_N,
typename T_prob>
inline
typename return_type<T_prob>::type
binomial_logit_log(const T_n& n,
const T_N& N,
const T_prob& alpha) {
return binomial_logit_log<false>(n, N, alpha);
}
}
}
#endif
stan::math::binomial_coefficient_log
fvar< T > binomial_coefficient_log(const fvar< T > &x1, const fvar< T > &x2)
Definition: binomial_coefficient_log.hpp:16
stan::math::value_of
T value_of(const fvar< T > &v)
Return the value of the specified variable.
Definition: value_of.hpp:16
stan::math::inv_logit
fvar< T > inv_logit(const fvar< T > &x)
Definition: inv_logit.hpp:15
stan::length
size_t length(const std::vector< T > &x)
Definition: length.hpp:10
stan::math::check_bounded
bool check_bounded(const char *function, const char *name, const T_y &y, const T_low &low, const T_high &high)
Return true if the value is between the low and high values, inclusively.
Definition: check_bounded.hpp:95
binomial_coefficient_log.hpp
stan::math::OperandsAndPartials::to_var
T_return_type to_var(T_partials_return logp, const T1 &x1=0, const T2 &x2=0, const T3 &x3=0, const T4 &x4=0, const T5 &x5=0, const T6 &x6=0)
Definition: OperandsAndPartials.hpp:322
stan::math::include_summand
Template metaprogram to calculate whether a summand needs to be included in a proportional (log) prob...
Definition: include_summand.hpp:36
stan::return_type::type
boost::math::tools::promote_args< typename scalar_type< T1 >::type, typename scalar_type< T2 >::type, typename scalar_type< T3 >::type, typename scalar_type< T4 >::type, typename scalar_type< T5 >::type, typename scalar_type< T6 >::type >::type type
Definition: return_type.hpp:27
include_summand.hpp
multiply_log.hpp
stan::math::OperandsAndPartials::d_x1
VectorView< T_partials_return, is_vector< T1 >::value, is_constant_struct< T1 >::value > d_x1
Definition: OperandsAndPartials.hpp:253
check_nonnegative.hpp
stan::is_constant_struct
Metaprogram to determine if a type has a base scalar type that can be assigned to type double...
Definition: is_constant_struct.hpp:16
log_inv_logit.hpp
check_less_or_equal.hpp
stan::math::OperandsAndPartials
A variable implementation that stores operands and derivatives with respect to the variable...
Definition: OperandsAndPartials.hpp:238
OperandsAndPartials.hpp
stan::max_size
size_t max_size(const T1 &x1, const T2 &x2)
Definition: max_size.hpp:9
VectorBuilder.hpp
log1m.hpp
check_bounded.hpp
stan::math::check_finite
bool check_finite(const char *function, const char *name, const T_y &y)
Return true if y is finite.
Definition: check_finite.hpp:62
stan::VectorBuilder
Definition: VectorBuilder.hpp:61
constants.hpp
stan::math::size
int size(const std::vector< T > &x)
Return the size of the specified standard vector.
Definition: size.hpp:17
stan::math::check_consistent_sizes
bool check_consistent_sizes(const char *function, const char *name1, const T1 &x1, const char *name2, const T2 &x2)
Return true if the dimension of x1 is consistent with x2.
Definition: check_consistent_sizes.hpp:31
check_finite.hpp
lbeta.hpp
inc_beta.hpp
stan::math::check_nonnegative
bool check_nonnegative(const char *function, const char *name, const T_y &y)
Return true if y is non-negative.
Definition: check_nonnegative.hpp:66
check_greater_or_equal.hpp
value_of.hpp
inv_logit.hpp
stan::VectorView
VectorView is a template metaprogram that takes its argument and allows it to be used like a vector...
Definition: VectorView.hpp:41
stan::math::log_inv_logit
fvar< T > log_inv_logit(const fvar< T > &x)
Definition: log_inv_logit.hpp:15
stan::partials_return_type::type
boost::math::tools::promote_args< typename partials_type< typename scalar_type< T1 >::type >::type, typename partials_type< typename scalar_type< T2 >::type >::type, typename partials_type< typename scalar_type< T3 >::type >::type, typename partials_type< typename scalar_type< T4 >::type >::type, typename partials_type< typename scalar_type< T5 >::type >::type, typename partials_type< typename scalar_type< T6 >::type >::type >::type type
Definition: partials_return_type.hpp:26
stan::math::binomial_logit_log
return_type< T_prob >::type binomial_logit_log(const T_n &n, const T_N &N, const T_prob &alpha)
Definition: binomial_logit_log.hpp:37
check_consistent_sizes.hpp

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