Ticket #7915: fix_doc_typo.patch
File fix_doc_typo.patch, 7.3 KB (added by , 10 years ago) |
---|
-
libs/accumulators/doc/accumulators.qbk
123 123 primitives which fit within the framework. 124 124 * Users push data into the _accumulator_set_ object one sample at a time. 125 125 * The _accumulator_set_ computes the requested quantities in the most efficient method 126 possible, resolving dependencies between requested calculations, possibly cach eing126 possible, resolving dependencies between requested calculations, possibly caching 127 127 intermediate results. 128 128 129 129 The Accumulators Framework defines the utilities needed for defining primitive … … 155 155 a sample type and a list of features. The accumulator set uses this 156 156 information to generate an ordered set of accumulators depending on 157 157 the feature dependency graph. An accumulator set accepts samples one 158 datum at a time, prop ogating them to each accumulator in order. At any158 datum at a time, propagating them to each accumulator in order. At any 159 159 point, results can be extracted from the accumulator set.]] 160 160 [[Extractor] [A function or function object that can be used to extract a result 161 161 from an _accumulator_set_.]] … … 602 602 accumulator_set< double, features< tag::sum, droppable<tag::mean> > > acc; 603 603 604 604 `mean` depends on `sum` and `count`. Since `mean` is droppable, so too is `count`. 605 However, we have explic titly requested that `sum` be not droppable, so it isn't. Had605 However, we have explicitly requested that `sum` be not droppable, so it isn't. Had 606 606 we left `tag::sum` out of the above declaration, the `sum` accumulator would have 607 607 been implicitly droppable. 608 608 … … 735 735 Here, `impl` is a binary [@../../libs/mpl/doc/refmanual/metafunction-class.html 736 736 MPL Metafunction Class], which is a kind of _mpl_lambda_expression_. The nested 737 737 `apply<>` template is part of the metafunction class protocol and tells MPL how 738 to tobuild the accumulator type given the sample and weight types.738 to build the accumulator type given the sample and weight types. 739 739 740 740 All features must also provide a nested `is_weight_accumulator` typedef. It must 741 741 be either `mpl::true_` or `mpl::false_`. _depends_on_ provides a default of … … 940 940 struct average; 941 941 }}} 942 942 943 If you have some user-defined type `MyDouble` for which you would like to customi mze the behavior943 If you have some user-defined type `MyDouble` for which you would like to customize the behavior 944 944 of `numeric::average()`, you would specialize `numeric::functional::average<>` by 945 945 first defining a tag type, as shown below: 946 946 … … 1004 1004 1005 1005 In the following table, `F` is the type of a feature and `S` is some scalar type. 1006 1006 1007 [table Featu e Requirements1007 [table Feature Requirements 1008 1008 [[[*Expression]] [[*Return type]] [[*Assertion / Note / 1009 1009 Pre- / Post-condition]]] 1010 1010 [[`F::dependencies`] [['unspecified]] [An MPL sequence of other features on 1011 which which`F` depends.]]1011 which `F` depends.]] 1012 1012 [[`F::is_weight_accumulator`] [`mpl::true_` or 1013 1013 `mpl::false_`] [`mpl::true_` if the accumulator for 1014 1014 this feature should be made external … … 1027 1027 1028 1028 [section The Statistical Accumulators Library] 1029 1029 1030 The Statistical Accumulators Library defines accumulators for incremental statisti al1030 The Statistical Accumulators Library defines accumulators for incremental statistical 1031 1031 computations. It is built on top of [link accumulators.user_s_guide.the_accumulators_framework 1032 1032 The Accumulator Framework]. 1033 1033 … … 1865 1865 > 1866 1866 ``]] 1867 1867 [[Depends On] [`count` \n 1868 In add tion, `tag::peaks_over_threshold_prob<>` depends on `tail<_left_or_right_>`]]1868 In addition, `tag::peaks_over_threshold_prob<>` depends on `tail<_left_or_right_>`]] 1869 1869 [[Variants] [`peaks_over_threshold_prob<_left_or_right_>`]] 1870 1870 [[Initialization Parameters] [ `tag::peaks_over_threshold::threshold_value` \n 1871 1871 `tag::peaks_over_threshold_prob::threshold_probability` \n … … 1990 1990 [section:pot_tail_mean pot_tail_mean] 1991 1991 1992 1992 Estimation of the (coherent) tail mean based on the peaks over threshold method (for both left and right tails). 1993 For i nplementation details, see [classref boost::accumulators::impl::pot_tail_mean_impl [^pot_tail_mean_impl]].1993 For implementation details, see [classref boost::accumulators::impl::pot_tail_mean_impl [^pot_tail_mean_impl]]. 1994 1994 1995 1995 Both `tag::pot_tail_mean<_left_or_right_>` and `tag::pot_tail_mean_prob<_left_or_right_>` satisfy the 1996 1996 `tag::tail_mean` feature and can be extracted using the `tail_mean()` extractor. … … 2173 2173 [section:skewness skewness] 2174 2174 2175 2175 The skewness of a sample distribution is defined as the ratio of the 3rd central moment and the [^3/2]-th power 2176 of the 2nd central moment (the variance) of the samples s3. For implementation details, see2176 of the 2nd central moment (the variance) of the samples 3. For implementation details, see 2177 2177 [classref boost::accumulators::impl::skewness_impl [^skewness_impl]]. 2178 2178 2179 2179 [variablelist … … 2341 2341 [section:coherent_tail_mean coherent_tail_mean] 2342 2342 2343 2343 Estimation of the coherent tail mean based on order statistics (for both left and right tails). 2344 The left coherent tail mean feature is `tag::coherent_tail_mean<left>`, and the right c hoherent2344 The left coherent tail mean feature is `tag::coherent_tail_mean<left>`, and the right coherent 2345 2345 tail mean feature is `tag::coherent_tail_mean<right>`. They both share the `tag::tail_mean` feature 2346 2346 and can be extracted with the `tail_mean()` extractor. For more implementation details, see 2347 2347 [classref boost::accumulators::impl::coherent_tail_mean_impl [^coherent_tail_mean_impl]] … … 3362 3362 histogram_type histogram_upper = weighted_p_square_cumulative_distribution(acc_upper); 3363 3363 histogram_type histogram_lower = weighted_p_square_cumulative_distribution(acc_lower); 3364 3364 3365 // Note that appl aying importance sampling results in a region of the distribution3365 // Note that applying importance sampling results in a region of the distribution 3366 3366 // to be estimated more accurately and another region to be estimated less accurately 3367 3367 // than without importance sampling, i.e., with unweighted samples 3368 3368 … … 3536 3536 [section:weighted_skewness weighted_skewness] 3537 3537 3538 3538 The skewness of a sample distribution is defined as the ratio of the 3rd central moment and the [^3/2]-th power 3539 of the 2nd central moment (the variance) of the samples s3. The skewness estimator for weighted samples3539 of the 2nd central moment (the variance) of the samples 3. The skewness estimator for weighted samples 3540 3540 is formally identical to the estimator for unweighted samples, except that the weighted counterparts of 3541 3541 all measures it depends on are to be taken. 3542 3542