Updated to use min/max

Author: cliffburdick

docs_input/api/math/extrema/max.rst

@@ -3,10 +3,12 @@
 max
 ===
 
-Reduces the input by the maximum values across the specified axes. 
+Reduces the input by the maximum values across the specified axes or performs
+an element-wise maximum on each element in the input operators.
 
 .. doxygenfunction:: max(const InType &in, const int (&dims)[D])
 .. doxygenfunction:: max(const InType &in)
+.. doxygenfunction:: max(Op t, Op t2)
 
 Examples
 ~~~~~~~~
@@ -22,3 +24,9 @@ Examples
    :start-after: example-begin max-test-2
    :end-before: example-end max-test-2
    :dedent:
+
+.. literalinclude:: ../../../../test/00_operators/OperatorTests.cu
+   :language: cpp
+   :start-after: example-begin max-el-test-1
+   :end-before: example-end max-el-test-1
+   :dedent:   

docs_input/api/math/extrema/maximum.rst

@@ -3,10 +3,12 @@
 min
 ===
 
-Reduces the input by the minimum values across the specified axes.
+Reduces the input by the minimum values across the specified axes or performs
+an element-wise minimum on each element in the input operators.
 
 .. doxygenfunction:: min(const InType &in, const int (&dims)[D])
 .. doxygenfunction:: min(const InType &in)
+.. doxygenfunction:: max(Op t, Op t2)
 
 Examples
 ~~~~~~~~
@@ -22,3 +24,9 @@ Examples
    :start-after: example-begin min-test-2
    :end-before: example-end min-test-2
    :dedent:
+
+.. literalinclude:: ../../../../test/00_operators/OperatorTests.cu
+   :language: cpp
+   :start-after: example-begin min-el-test-1
+   :end-before: example-end min-el-test-1
+   :dedent:      

docs_input/api/math/extrema/min.rst

@@ -384,9 +384,9 @@ namespace matx
   DEFINE_BINARY_OP(operator&, detail::AndOp);
   DEFINE_BINARY_OP(operator^, detail::XorOp);
   DEFINE_BINARY_OP(pow, detail::PowOp);
-  DEFINE_BINARY_OP(maximum, detail::MaximumOp);
+  DEFINE_BINARY_OP(max, detail::MaximumOp);
   DEFINE_BINARY_OP(atan2, detail::Atan2Op);
-  DEFINE_BINARY_OP(minimum, detail::MinimumOp);
+  DEFINE_BINARY_OP(min, detail::MinimumOp);
   DEFINE_BINARY_OP(operator<, detail::LTOp);
   DEFINE_BINARY_OP(operator>, detail::GTOp);
   DEFINE_BINARY_OP(operator<=, detail::LTEOp);

docs_input/api/math/extrema/minimum.rst

@@ -138,6 +138,17 @@ __MATX_INLINE__ auto max(const InType &in, const int (&dims)[D])
   return detail::MaxOp<decltype(permop), InType::Rank() - D>(permop);
 }
 
+template <typename InType, int D>
+[[deprecated("Use max() instead of rmax() for reductions")]]
+__MATX_INLINE__ auto rmax(const InType &in, const int (&dims)[D])
+{
+  static_assert(D < InType::Rank(), "reduction dimensions must be <= Rank of input");
+  auto perm = detail::getPermuteDims<InType::Rank()>(dims);
+  auto permop = permute(in, perm);
+
+  return detail::MaxOp<decltype(permop), InType::Rank() - D>(permop);
+}
+
 /**
  * Compute max reduction of an operator
  *
@@ -156,4 +167,11 @@ __MATX_INLINE__ auto max(const InType &in)
   return detail::MaxOp<decltype(in), 0>(in);
 }
 
+template <typename InType>
+[[deprecated("Use max() instead of rmax() for reductions")]]
+__MATX_INLINE__ auto rmax(const InType &in)
+{
+  return detail::MaxOp<decltype(in), 0>(in);
+}
+
 }

include/matx/operators/binary_operators.h

@@ -138,6 +138,17 @@ __MATX_INLINE__ auto min(const InType &in, const int (&dims)[D])
   return detail::MinOp<decltype(permop), InType::Rank() - D>(permop);
 }
 
+template <typename InType, int D>
+[[deprecated("Use min() instead of rmin() for reductions")]]
+__MATX_INLINE__ auto rmin(const InType &in, const int (&dims)[D])
+{
+  static_assert(D < InType::Rank(), "reduction dimensions must be <= Rank of input");
+  auto perm = detail::getPermuteDims<InType::Rank()>(dims);
+  auto permop = permute(in, perm);
+
+  return detail::MinOp<decltype(permop), InType::Rank() - D>(permop);
+}
+
 /**
  * Compute min reduction of an operator
  *
@@ -156,4 +167,11 @@ __MATX_INLINE__ auto min(const InType &in)
   return detail::MinOp<decltype(in), 0>(in);
 }
 
+template <typename InType>
+[[deprecated("Use min() instead of rmin() for reductions")]]
+__MATX_INLINE__ auto rmin(const InType &in)
+{
+  return detail::MinOp<decltype(in), 0>(in);
+}
+
 }

include/matx/operators/max.h

@@ -1760,15 +1760,15 @@ TYPED_TEST(OperatorTestsNumericNonComplexAllExecs, OperatorFuncs)
   tiv0() = c;
   TestType d = c + 1;
 
-  // example-begin maximum-test-1
-  (tov0 = maximum(tiv0, d)).run(exec);
-  // example-end maximum-test-1
+  // example-begin max-el-test-1
+  (tov0 = max(tiv0, d)).run(exec);
+  // example-end max-el-test-1
   cudaStreamSynchronize(0);
   EXPECT_TRUE(MatXUtils::MatXTypeCompare(tov0(), std::max(c, d)));
 
-  // example-begin minimum-test-1
-  (tov0 = minimum(tiv0, d)).run(exec);
-  // example-end minimum-test-1
+  // example-begin min-el-test-1
+  (tov0 = min(tiv0, d)).run(exec);
+  // example-end min-el-test-1
   cudaStreamSynchronize(0);
   EXPECT_TRUE(MatXUtils::MatXTypeCompare(tov0(), std::min(c, d)));