Opened 12 years ago

Closed 10 years ago

Last modified 10 years ago

#5440 closed Bugs (fixed)

Documentation error for boost::inner_product from boost range library

Reported by: tom.vercauteren@… Owned by: Neil Groves
Milestone: To Be Determined Component: range
Version: Boost Release Branch Severity: Cosmetic
Keywords: Cc:

Description

The documentation of boost::inner product from boost range gives the following signature for the second version of boost::inner_product:

template<class SinglePassRange1,
         class SinglePassRange2,
         class Value,
         class BinaryOperation1,
         class BinaryOperation2>
    Value inner_product( const SinglePassRange1& rng1,
                         const SinglePassRange2& rng2,
                         Value                   init,
                         BinaryOperation1        op1 );

This does not conform to the actual signature found in boost/range/numeric.hpp and is thus in contradiction with the signature of std::inner_product. I believe the signature should be

template<class SinglePassRange1,
         class SinglePassRange2,
         class Value,
         class BinaryOperation1,
         class BinaryOperation2>
    Value inner_product( const SinglePassRange1& rng1,
                         const SinglePassRange2& rng2,
                         Value                   init,
                         BinaryOperation1        op1,
                         BinaryOperation2        op2 );

Change History (5)

comment:1 by Steven Watanabe, 12 years ago

Component: Documentationrange
Owner: changed from Matias Capeletto to Neil Groves

comment:2 by Neil Groves, 11 years ago

Status: newassigned

comment:3 by Nathan Ridge, 10 years ago

Resolution: fixed
Status: assignedclosed

(In [82327]) [range] fixed #5440 (typo in documentation for 'inner_product' algorithm)

comment:4 by Nathan Ridge, 10 years ago

Fixed in trunk. The fix will appear in 1.53 (I will merge to release branch after 1.53 beta release).

comment:5 by Nathan Ridge, 10 years ago

(In [82487]) [range] Merge documentation fixes and minor refactoring of docs (refs #5160; refs #5314; refs #5440; refs #5775; refs #6212; refs #7585; refs #7843; refs #7866).

Note: See TracTickets for help on using tickets.