[Boost-commit] svn:boost r39077 - sandbox/math_toolkit/boost/math/tools

From: john_at_[hidden]
Date: 2007-08-30 13:21:50

Author: johnmaddock
Date: 2007-08-30 13:21:49 EDT (Thu, 30 Aug 2007)
New Revision: 39077
URL: http://svn.boost.org/trac/boost/changeset/39077

Log:
Added explanatory notes.
Text files modified: 
   sandbox/math_toolkit/boost/math/tools/traits.hpp |    14 ++++++++++++++                          
   1 files changed, 14 insertions(+), 0 deletions(-)

Modified: sandbox/math_toolkit/boost/math/tools/traits.hpp
==============================================================================
--- sandbox/math_toolkit/boost/math/tools/traits.hpp	(original)
+++ sandbox/math_toolkit/boost/math/tools/traits.hpp	2007-08-30 13:21:49 EDT (Thu, 30 Aug 2007)
@@ -4,6 +4,20 @@
 //  Boost Software License, Version 1.0. (See accompanying file
 //  LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
+/*
+This header defines two traits classes, both in namespace boost::math::tools.
+
+is_distribution<D>::value is true iff D has overloaded "cdf" and
+"quantile" functions, plus member typedefs value_type and policy_type.  
+It's not much of a definitive test frankly,
+but if it looks like a distribution and quacks like a distribution
+then it must be a distribution.
+
+is_scaled_distribution<D>::value is true iff D is a distribution
+as defined above, and has member functions "scale" and "location".
+
+*/
+
 #ifndef BOOST_STATS_IS_DISTRIBUTION_HPP
 #define BOOST_STATS_IS_DISTRIBUTION_HPP