stan::prob::include_summand< propto, T1, T2, T3, T4, T5, T6 > Struct Template Reference

Template metaprogram to calculate whether a summand needs to be included in a proportional (log) probability calculation. More...

#include <traits.hpp>

Public Types
enum	{ value }
	true if a term with the specified propto value and subterm types should be included in a proportionality calculation. More...

Detailed Description

template<bool propto, typename T1 = double, typename T2 = double, typename T3 = double, typename T4 = double, typename T5 = double, typename T6 = double>
struct stan::prob::include_summand< propto, T1, T2, T3, T4, T5, T6 >

Template metaprogram to calculate whether a summand needs to be included in a proportional (log) probability calculation.

For usage, the first boolean parameter should be set to true if calculating a term up to proportionality. Other type parameters should be included for all of the types of variables in a term.

The value enum will be true if the propto parameter is false or if any of the other template arguments are not constants as defined by stan::is_constant<T>.

Template Parameters

propto	true if calculating up to a proportionality constant.
T1	First

Definition at line 33 of file traits.hpp.

Member Enumeration Documentation

anonymous enum

template<bool propto, typename T1 = double, typename T2 = double, typename T3 = double, typename T4 = double, typename T5 = double, typename T6 = double>

anonymous enum

true if a term with the specified propto value and subterm types should be included in a proportionality calculation.

Enumerator
value

Definition at line 40 of file traits.hpp.

---

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

• src/stan/prob/traits.hpp