namespace boost { namespace gil {
-// Structures for pixel-wise numeric operations
-// Currently defined structures:
-// pixel_plus_t (+), pixel_minus_t (-)
-// pixel_multiplies_scalar_t (*), pixel_divides_scalar_t (/)
-// pixel_halves_t (/=2), pixel_zeros_t (=0)
-// pixel_assigns_t (=)
+// Function objects and utilities for pixel-wise numeric operations.
+//
+// List of currently defined functors:
+// pixel_plus_t (+)
+// pixel_minus_t (-)
+// pixel_multiplies_scalar_t (*)
+// pixel_divides_scalar_t (/)
+// pixel_halves_t (/=2),
+// pixel_zeros_t (=0)
+// pixel_assigns_t (=)
/// \ingroup PixelNumericOperations
-/// \brief construct for adding two pixels
-template <typename PixelRef1, // models pixel concept
- typename PixelRef2, // models pixel concept
- typename PixelR> // models pixel value concept
-struct pixel_plus_t {
- PixelR operator() (const PixelRef1& p1,
- const PixelRef2& p2) const {
- PixelR result;
- static_transform(p1,p2,result,
- channel_plus_t<typename channel_type<PixelRef1>::type,
- typename channel_type<PixelRef2>::type,
- typename channel_type<PixelR>::type>());
+/// \brief Performs channel-wise addition of two pixels.
+/// \tparam PixelRef1 - models PixelConcept
+/// \tparam PixelRef2 - models PixelConcept
+/// \tparam PixelResult - models PixelValueConcept
+template <typename PixelRef1, typename PixelRef2, typename PixelResult>
+struct pixel_plus_t
+{
+ auto operator()(PixelRef1 const& p1, PixelRef2 const& p2) const -> PixelResult
+ {
+ PixelResult result;
+ static_transform(p1, p2, result,
+ channel_plus_t
+ <
+ typename channel_type<PixelRef1>::type,
+ typename channel_type<PixelRef2>::type,
+ typename channel_type<PixelResult>::type
+ >());
return result;
}
};
/// \ingroup PixelNumericOperations
-/// \brief construct for subtracting two pixels
-template <typename PixelRef1, // models pixel concept
- typename PixelRef2, // models pixel concept
- typename PixelR> // models pixel value concept
-struct pixel_minus_t {
- PixelR operator() (const PixelRef1& p1,
- const PixelRef2& p2) const {
- PixelR result;
- static_transform(p1,p2,result,
- channel_minus_t<typename channel_type<PixelRef1>::type,
- typename channel_type<PixelRef2>::type,
- typename channel_type<PixelR>::type>());
+/// \brief Performs channel-wise subtraction of two pixels.
+/// \tparam PixelRef1 - models PixelConcept
+/// \tparam PixelRef2 - models PixelConcept
+/// \tparam PixelResult - models PixelValueConcept
+template <typename PixelRef1, typename PixelRef2, typename PixelResult>
+struct pixel_minus_t
+{
+ auto operator()(PixelRef1 const& p1, PixelRef2 const& p2) const -> PixelResult
+ {
+ PixelResult result;
+ static_transform(p1, p2, result,
+ channel_minus_t
+ <
+ typename channel_type<PixelRef1>::type,
+ typename channel_type<PixelRef2>::type,
+ typename channel_type<PixelResult>::type
+ >());
return result;
}
};
/// \ingroup PixelNumericOperations
-/// \brief construct for multiplying scalar to a pixel
-template <typename PixelRef, // models pixel concept
- typename Scalar, // models a scalar type
- typename PixelR> // models pixel value concept
-struct pixel_multiplies_scalar_t {
- PixelR operator () (const PixelRef& p,
- const Scalar& s) const {
- PixelR result;
- static_transform(p,result,
- std::bind(channel_multiplies_scalar_t<typename channel_type<PixelRef>::type,
- Scalar,
- typename channel_type<PixelR>::type>(),
- std::placeholders::_1, s));
+/// \brief Performs channel-wise multiplication of pixel elements by scalar.
+/// \tparam PixelRef - models PixelConcept
+/// \tparam Scalar - models a scalar type
+/// \tparam PixelResult - models PixelValueConcept
+template <typename PixelRef, typename Scalar, typename PixelResult>
+struct pixel_multiplies_scalar_t
+{
+ auto operator()(PixelRef const& p, Scalar const& s) const -> PixelResult
+ {
+ PixelResult result;
+ static_transform(p, result,
+ std::bind(
+ channel_multiplies_scalar_t<typename channel_type<PixelRef>::type,
+ Scalar,
+ typename channel_type<PixelResult>::type>(),
+ std::placeholders::_1, s));
return result;
}
};
/// \ingroup PixelNumericOperations
-/// \brief construct for dividing two pixels
-template <typename PixelRef1, // models pixel concept
- typename PixelRef2, // models pixel concept
- typename PixelR> // models pixel value concept
-struct pixel_multiply_t {
- PixelR operator() (const PixelRef1& p1,
- const PixelRef2& p2) const {
- PixelR result;
- static_transform(p1,p2,result,
- channel_multiplies_t<typename channel_type<PixelRef1>::type,
- typename channel_type<PixelRef2>::type,
- typename channel_type<PixelR>::type>());
+/// \brief Performs channel-wise multiplication of two pixels.
+/// \tparam PixelRef1 - models PixelConcept
+/// \tparam PixelRef1 - models PixelConcept
+/// \tparam PixelResult - models PixelValueConcept
+template <typename PixelRef1, typename PixelRef2, typename PixelResult>
+struct pixel_multiply_t
+{
+ auto operator()(PixelRef1 const& p1, PixelRef2 const& p2) const -> PixelResult
+ {
+ PixelResult result;
+ static_transform(p1, p2, result,
+ channel_multiplies_t
+ <
+ typename channel_type<PixelRef1>::type,
+ typename channel_type<PixelRef2>::type,
+ typename channel_type<PixelResult>::type
+ >());
return result;
}
};
/// \ingroup PixelNumericOperations
-/// \brief construct for dividing a pixel by a scalar
-template <typename PixelRef, // models pixel concept
- typename Scalar, // models a scalar type
- typename PixelR> // models pixel value concept
-struct pixel_divides_scalar_t {
- PixelR operator () (const PixelRef& p,
- const Scalar& s) const {
- PixelR result;
- static_transform(p,result,
- std::bind(channel_divides_scalar_t<typename channel_type<PixelRef>::type,
- Scalar,
- typename channel_type<PixelR>::type>(),
- std::placeholders::_1, s));
+/// \brief Performs channel-wise division of pixel elements by scalar.
+/// \tparam PixelRef - models PixelConcept
+/// \tparam Scalar - models a scalar type
+/// \tparam PixelResult - models PixelValueConcept
+template <typename PixelRef, typename Scalar, typename PixelResult>
+struct pixel_divides_scalar_t
+{
+ auto operator()(PixelRef const& p, Scalar const& s) const -> PixelResult
+ {
+ PixelResult result;
+ static_transform(p, result,
+ std::bind(channel_divides_scalar_t<typename channel_type<PixelRef>::type,
+ Scalar,
+ typename channel_type<PixelResult>::type>(),
+ std::placeholders::_1, s));
return result;
}
};
/// \ingroup PixelNumericOperations
-/// \brief construct for dividing two pixels
-template <typename PixelRef1, // models pixel concept
- typename PixelRef2, // models pixel concept
- typename PixelR> // models pixel value concept
-struct pixel_divide_t {
- PixelR operator() (const PixelRef1& p1,
- const PixelRef2& p2) const {
- PixelR result;
- static_transform(p1,p2,result,
- channel_divides_t<typename channel_type<PixelRef1>::type,
- typename channel_type<PixelRef2>::type,
- typename channel_type<PixelR>::type>());
+/// \brief Performs channel-wise division of two pixels.
+/// \tparam PixelRef1 - models PixelConcept
+/// \tparam PixelRef1 - models PixelConcept
+/// \tparam PixelResult - models PixelValueConcept
+template <typename PixelRef1, typename PixelRef2, typename PixelResult>
+struct pixel_divide_t
+{
+ auto operator()(PixelRef1 const& p1, PixelRef2 const& p2) const -> PixelResult
+ {
+ PixelResult result;
+ static_transform(p1, p2, result,
+ channel_divides_t
+ <
+ typename channel_type<PixelRef1>::type,
+ typename channel_type<PixelRef2>::type,
+ typename channel_type<PixelResult>::type
+ >());
return result;
}
};
/// \ingroup PixelNumericOperations
-/// \brief construct for dividing a pixel by 2
-template <typename PixelRef> // models pixel concept
-struct pixel_halves_t {
- PixelRef& operator () (PixelRef& p) const {
- static_for_each(p,channel_halves_t<typename channel_type<PixelRef>::type>());
+/// \brief Performs channel-wise division by 2
+/// \tparam PixelRef - models PixelConcept
+template <typename PixelRef>
+struct pixel_halves_t
+{
+ auto operator()(PixelRef& p) const -> PixelRef&
+ {
+ static_for_each(p, channel_halves_t<typename channel_type<PixelRef>::type>());
return p;
}
};
/// \ingroup PixelNumericOperations
-/// \brief construct for setting a pixel to zero (for whatever zero means)
-template <typename PixelRef> // models pixel concept
-struct pixel_zeros_t {
- PixelRef& operator () (PixelRef& p) const {
- static_for_each(p,channel_zeros_t<typename channel_type<PixelRef>::type>());
+/// \brief Sets pixel elements to zero (for whatever zero means)
+/// \tparam PixelRef - models PixelConcept
+template <typename PixelRef>
+struct pixel_zeros_t
+{
+ auto operator()(PixelRef& p) const -> PixelRef&
+ {
+ static_for_each(p, channel_zeros_t<typename channel_type<PixelRef>::type>());
return p;
}
};
-// Hailin: This is how you can do it:
+/// \brief Sets pixel elements to zero (for whatever zero means)
+/// \tparam Pixel - models PixelConcept
template <typename Pixel>
-void zero_channels(Pixel& p) {
- static_for_each(p,channel_zeros_t<typename channel_type<Pixel>::type>());
+void zero_channels(Pixel& p)
+{
+ static_for_each(p, channel_zeros_t<typename channel_type<Pixel>::type>());
}
-
/// \ingroup PixelNumericOperations
-///definition and a generic implementation for casting and assigning a pixel to another
-///user should specialize it for better performance
-template <typename PixelRef, // models pixel concept
- typename PixelRefR> // models pixel concept
-struct pixel_assigns_t {
- PixelRefR operator () (const PixelRef& src,
- PixelRefR& dst) const {
- static_for_each(src,dst,channel_assigns_t<typename channel_type<PixelRef>::type,
- typename channel_type<PixelRefR>::type>());
+/// \brief Casts and assigns a pixel to another
+///
+/// A generic implementation for casting and assigning a pixel to another.
+/// User should specialize it for better performance.
+///
+/// \tparam PixelRef - models PixelConcept
+/// \tparam PixelResult - models PixelValueConcept
+template <typename PixelRef, typename PixelResult>
+struct pixel_assigns_t
+{
+ auto operator()(PixelRef const& src, PixelResult& dst) const -> PixelResult
+ {
+ static_for_each(src, dst,
+ channel_assigns_t
+ <
+ typename channel_type<PixelRef>::type,
+ typename channel_type<PixelResult>::type
+ >());
return dst;
}
};
projects / platform / upstream / boost.git / blobdiff