Near-complete rewrite based on 1/2-phase code model with workspace.

Author: obilaniu

src/gpuarray/reduction.h

@@ -21,39 +21,76 @@ extern "C" {
 #endif
 
 
+/* Data Structures */
+struct         GpuReduction;
+typedef struct GpuReduction GpuReduction;
+
+
 /**
  * Supported array reduction operations.
  */
 
 typedef enum _ga_reduce_op {
-	GA_REDUCE_SUM,             /*          +          */
-	GA_REDUCE_PROD,            /*          *          */
-	GA_REDUCE_PRODNZ,          /*          * (!=0)    */
-	GA_REDUCE_MIN,             /*        min()        */
-	GA_REDUCE_MAX,             /*        max()        */
-	GA_REDUCE_ARGMIN,          /*       argmin()      */
-	GA_REDUCE_ARGMAX,          /*       argmax()      */
-	GA_REDUCE_MINANDARGMIN,    /*   min(), argmin()   */
-	GA_REDUCE_MAXANDARGMAX,    /*   max(), argmax()   */
-	GA_REDUCE_AND,             /*          &          */
-	GA_REDUCE_OR,              /*          |          */
-	GA_REDUCE_XOR,             /*          ^          */
-	GA_REDUCE_ALL,             /*       &&/all()      */
-	GA_REDUCE_ANY,             /*       ||/any()      */
+	                           /*    dst   ,  dstArg  */
+	GA_REDUCE_SUM,             /*     +               */
+	GA_REDUCE_PROD,            /*     *               */
+	GA_REDUCE_PRODNZ,          /*     * (!=0)         */
+	GA_REDUCE_MIN,             /*   min()             */
+	GA_REDUCE_MAX,             /*   max()             */
+	GA_REDUCE_ARGMIN,          /*            argmin() */
+	GA_REDUCE_ARGMAX,          /*            argmax() */
+	GA_REDUCE_MINANDARGMIN,    /*   min()  , argmin() */
+	GA_REDUCE_MAXANDARGMAX,    /*   max()  , argmax() */
+	GA_REDUCE_AND,             /*     &               */
+	GA_REDUCE_OR,              /*     |               */
+	GA_REDUCE_XOR,             /*     ^               */
+	GA_REDUCE_ALL,             /*  &&/all()           */
+	GA_REDUCE_ANY,             /*  ||/any()           */
 } ga_reduce_op;
 
 
+/* External Functions */
 
 /**
- * @brief Compute a reduction over a list of axes to reduce.
+ * @brief Create a new GPU reduction operator over a list of axes to reduce.
+ *
+ * @param [out] gr           The reduction operator.
+ * @param [in]  gpuCtx       The GPU context.
+ * @param [in]  op           The reduction operation to perform.
+ * @param [in]  ndf          The minimum number of destination dimensions to support.
+ * @param [in]  ndr          The minimum number of reduction   dimensions to support.
+ * @param [in]  srcTypeCode  The data type of the source operand.
+ * @param [in]  flags        Reduction operator creation flags. Currently must be
+ *                           set to 0.
+ *
+ * @return GA_NO_ERROR if the operator was created successfully, or a non-zero
+ *         error code otherwise.
+ */
+
+GPUARRAY_PUBLIC int   GpuReduction_new   (GpuReduction**   grOut,
+                                          gpucontext*      gpuCtx,
+                                          ga_reduce_op     op,
+                                          unsigned         ndf,
+                                          unsigned         ndr,
+                                          int              srcTypeCode,
+                                          int              flags);
+
+/**
+ * @brief Deallocate an operator allocated by GpuReduction_new().
+ */
+
+GPUARRAY_PUBLIC void  GpuReduction_free  (GpuReduction*    gr);
+
+/**
+ * @brief Invoke an operator allocated by GpuReduction_new() on a source tensor.
  *
  * Returns one (in the case of min-and-argmin/max-and-argmax, two) destination
  * tensors. The destination tensor(s)' axes are a strict subset of the axes of the
  * source tensor. The axes to be reduced are specified by the caller, and the
  * reduction is performed over these axes, which are then removed in the
  * destination.
- *
- * @param [in]  op         The reduction operation to perform.
+ * 
+ * @param [in]  gr         The reduction operator.
  * @param [out] dst        The destination tensor. Has the same type as the source.
  * @param [out] dstArg     For argument of minima/maxima operations. Has type int64.
  * @param [in]  src        The source tensor.
@@ -76,19 +113,20 @@ typedef enum _ga_reduce_op {
  *                         
  *                         where (i3,i4,i1) are the coordinates of the maximum-
  *                         valued element within subtensor [i0,:,i2,:,:] of src.
- * @return GA_NO_ERROR if the operation was successful, or a non-zero error
- *         code otherwise.
+ * @param [in]  flags      Reduction operator invocation flags. Currently must be
+ *                         set to 0.
+ *
+ * @return GA_NO_ERROR if the operator was invoked successfully, or a non-zero
+ *         error code otherwise.
  */
 
-GPUARRAY_PUBLIC int GpuArray_reduction   (ga_reduce_op    op,
-                                          GpuArray*       dst,
-                                          GpuArray*       dstArg,
-                                          const GpuArray* src,
-                                          unsigned        reduxLen,
-                                          const unsigned* reduxList);
-
-
-
+GPUARRAY_PUBLIC int   GpuReduction_call  (GpuReduction*    gr,
+                                          GpuArray*        dst,
+                                          GpuArray*        dstArg,
+                                          const GpuArray*  src,
+                                          unsigned         reduxLen,
+                                          const int*       reduxList,
+                                          int              flags);
 
 
 #ifdef __cplusplus