boost::probabilities::ValidatorConcept< T > Struct Template Reference

Validator Concept checking class. More...

#include <probabilities.hpp>

List of all members.

Public Member Functions
void	constraints ()
	Constraint checking function.
Public Attributes
T::value_type	v
	Type of value to validate.

---

Detailed Description

template<typename T>
struct boost::probabilities::ValidatorConcept< T >

Validator Concept checking class.

The Validator Concept applies to classes that can validate the internal representation of likelihoods and probabilities. The likelihood and probabilty classes enforce this concept on the Validator template argument.

• Required types. Types modeling the Validator Concept must provide a nested value_type. This corresponds to the type used to represent the quantities to be validated. Normally, this is the same as the value_type of the likelihood or probability class; however, it is sufficient that those types are convertible to this value_type.

• Required functions. Types modeling the Validator Concept must provide the following functions:

   static void is_valid(value_type,linear_domain);
   static void is_valid(value_type,log_domain);
  

These function must decide whether or not the value_type argument is valid within the corresponding domain. If not, they must signal that case by throwing an exception, typically out_of_range. The following types model the Validator Concept.

• validator_archetype. This class is the archtypical model for the Validator Concept. Its primary use is to verify that the ValidatorConcept class fully covers the concept.

• null_validator. This validator generates no code and accepts any value as valid. Its primary use is to avoid the run-time costs of validation.

• range_validator. This validator verifies that values lie strictly within the intervals appropriate for likelihoods and probabilities, and , respectively. An out_of_range exception is thrown if the value lies outside the interval.

• truncating_validator. This validator verifies that values lie within the appropriate intervals. Value that are outside the strct intervals defined above but within epsilon of a boundary are truncated to the appropriate boundary. This handles floating point round-off errors that generate values slightly outside the strict interval appropriate for the domain. An out_of_range exception is thrown if the value lies outside the enlarged interval.

---

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

• probabilities.hpp

---