Skip to content

Commit 3289fe0

Browse files
authored
refactor: Unified operation names for pixel and channel operations (#655)
Renamed - gil::pixel_multiply_t to gil::pixel_multiplies_t - gil::pixel_divide_t to gil::pixel_divides_t Closes #368
1 parent 9d526ed commit 3289fe0

File tree

3 files changed

+17
-9
lines changed

3 files changed

+17
-9
lines changed

include/boost/gil/pixel_numeric_operations.hpp

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,10 @@ namespace boost { namespace gil {
2020
// List of currently defined functors:
2121
// pixel_plus_t (+)
2222
// pixel_minus_t (-)
23-
// pixel_multiplies_scalar_t (*)
24-
// pixel_divides_scalar_t (/)
23+
// pixel_multiplies_scalar_t (*s)
24+
// pixel_multiplies_t (*)
25+
// pixel_divides_scalar_t (/s)
26+
// pixel_divides_t (/)
2527
// pixel_halves_t (/=2),
2628
// pixel_zeros_t (=0)
2729
// pixel_assigns_t (=)
@@ -97,7 +99,7 @@ struct pixel_multiplies_scalar_t
9799
/// \tparam PixelRef1 - models PixelConcept
98100
/// \tparam PixelResult - models PixelValueConcept
99101
template <typename PixelRef1, typename PixelRef2, typename PixelResult>
100-
struct pixel_multiply_t
102+
struct pixel_multiplies_t
101103
{
102104
auto operator()(PixelRef1 const& p1, PixelRef2 const& p2) const -> PixelResult
103105
{
@@ -113,6 +115,9 @@ struct pixel_multiply_t
113115
}
114116
};
115117

118+
template <typename PixelRef1, typename PixelRef2, typename PixelResult>
119+
using pixel_multiply_t [[deprecated]] = pixel_multiplies_t<PixelRef1, PixelRef2, PixelResult>;
120+
116121
/// \ingroup PixelNumericOperations
117122
/// \brief Performs channel-wise division of pixel elements by scalar.
118123
/// \tparam PixelRef - models PixelConcept
@@ -139,7 +144,7 @@ struct pixel_divides_scalar_t
139144
/// \tparam PixelRef2 - models PixelConcept
140145
/// \tparam PixelResult - models PixelValueConcept
141146
template <typename PixelRef1, typename PixelRef2, typename PixelResult>
142-
struct pixel_divide_t
147+
struct pixel_divides_t
143148
{
144149
auto operator()(PixelRef1 const& p1, PixelRef2 const& p2) const -> PixelResult
145150
{
@@ -155,6 +160,9 @@ struct pixel_divide_t
155160
}
156161
};
157162

163+
template <typename PixelRef1, typename PixelRef2, typename PixelResult>
164+
using pixel_divide_t [[deprecated]] = pixel_divides_t<PixelRef1, PixelRef2, PixelResult>;
165+
158166
/// \ingroup PixelNumericOperations
159167
/// \brief Performs channel-wise division by 2
160168
/// \tparam PixelRef - models PixelConcept

test/core/pixel/pixel_numeric_operations.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ struct test_pixel_multiply_integer_same_types
136136
{
137137
using pixel_t = Pixel;
138138
using channel_t = typename gil::channel_type<pixel_t>::type;
139-
gil::pixel_multiply_t<pixel_t, pixel_t, pixel_t> f;
139+
gil::pixel_multiplies_t<pixel_t, pixel_t, pixel_t> f;
140140

141141
pixel_t p0;
142142
gil::static_fill(p0, static_cast<channel_t>(0));
@@ -190,7 +190,7 @@ struct test_pixel_divide_integer_same_types
190190
{
191191
using pixel_t = Pixel;
192192
using channel_t = typename gil::channel_type<pixel_t>::type;
193-
gil::pixel_divide_t<pixel_t, pixel_t, pixel_t> f;
193+
gil::pixel_divides_t<pixel_t, pixel_t, pixel_t> f;
194194

195195
pixel_t p0;
196196
gil::static_fill(p0, static_cast<channel_t>(0));

test/core/pixel/pixel_numeric_operations_float.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ void test_multiply()
4949
gil::rgb32f_pixel_t a(1.f, 2.f, 3.f);
5050
gil::bgr32f_pixel_t b(2.f, 2.f, 2.f);
5151

52-
gil::pixel_multiply_t<
52+
gil::pixel_multiplies_t<
5353
gil::rgb32f_pixel_t, gil::bgr32f_pixel_t, gil::rgb32f_pixel_t>
5454
op;
5555
gil::rgb32f_pixel_t c = op(a, b);
@@ -67,7 +67,7 @@ void test_divide()
6767
gil::rgb8_pixel_t a(10, 20, 30);
6868
gil::bgr8_pixel_t b(2, 2, 2);
6969

70-
gil::pixel_divide_t<gil::rgb8_pixel_t, gil::bgr8_pixel_t, gil::rgb32f_pixel_t> op;
70+
gil::pixel_divides_t<gil::rgb8_pixel_t, gil::bgr8_pixel_t, gil::rgb32f_pixel_t> op;
7171
gil::rgb32f_pixel_t c = op(a, b);
7272

7373
BOOST_TEST_EQ(get_color(c, gil::red_t()), 5);
@@ -80,7 +80,7 @@ void test_divide()
8080
gil::rgb32f_pixel_t a(1.f, 2.f, 3.f);
8181
gil::bgr32f_pixel_t b(2.f, 2.f, 2.f);
8282

83-
gil::pixel_divide_t<gil::rgb32f_pixel_t, gil::bgr32f_pixel_t, gil::rgb32f_pixel_t> op;
83+
gil::pixel_divides_t<gil::rgb32f_pixel_t, gil::bgr32f_pixel_t, gil::rgb32f_pixel_t> op;
8484
gil::rgb32f_pixel_t c = op(a, b);
8585

8686
float epsilon = 1e-6f;

0 commit comments

Comments
 (0)