1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
|
//------------------------------------------------------------------------------
// GrB_Vector_reduce: reduce a vector to a scalar
//------------------------------------------------------------------------------
// SuiteSparse:GraphBLAS, Timothy A. Davis, (c) 2017-2025, All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
//------------------------------------------------------------------------------
#include "reduce/GB_reduce.h"
#include "binaryop/GB_binop.h"
//------------------------------------------------------------------------------
// GrB_Vector_reduce_TYPE: reduce a vector to a scalar
//------------------------------------------------------------------------------
// Reduce entries in a vector to a scalar, c = accum (c, reduce_to_scalar(u))
// All entries in the vector are "summed" to a single scalar t using the reduce
// monoid, which must be associative (otherwise the results are undefined).
// The result is either assigned to the output scalar c (if accum is NULL), or
// it accumulated in the result c via c = accum(c,t). If u has no entries, the
// result t is the identity value of the monoid. Unlike most other GraphBLAS
// operations, this operation uses an accum operator but no mask.
#define GB_REDUCE_TO_CSCALAR(prefix,type,T) \
GrB_Info GB_EVAL3 (prefix, _Vector_reduce_, T) /* c = accum (c, reduce (u)) */ \
( \
type *c, /* result scalar */ \
const GrB_BinaryOp accum, /* optional accum for c=accum(c,t) */ \
const GrB_Monoid monoid, /* monoid to do the reduction */ \
const GrB_Vector u, /* vector to reduce */ \
const GrB_Descriptor desc \
) \
{ \
GB_RETURN_IF_NULL (u) ; \
GB_WHERE_1 (u, "GrB_Vector_reduce_" GB_STR(T) \
" (&c, accum, monoid, u, desc)") ; \
GB_BURBLE_START ("GrB_reduce") ; \
ASSERT (GB_VECTOR_OK (u)) ; \
info = GB_reduce_to_scalar (c, GB_EVAL3 (prefix, _, T), accum, monoid, \
(GrB_Matrix) u, Werk) ; \
GB_BURBLE_END ; \
return (info) ; \
}
GB_REDUCE_TO_CSCALAR (GrB, bool , BOOL )
GB_REDUCE_TO_CSCALAR (GrB, int8_t , INT8 )
GB_REDUCE_TO_CSCALAR (GrB, int16_t , INT16 )
GB_REDUCE_TO_CSCALAR (GrB, int32_t , INT32 )
GB_REDUCE_TO_CSCALAR (GrB, int64_t , INT64 )
GB_REDUCE_TO_CSCALAR (GrB, uint8_t , UINT8 )
GB_REDUCE_TO_CSCALAR (GrB, uint16_t , UINT16 )
GB_REDUCE_TO_CSCALAR (GrB, uint32_t , UINT32 )
GB_REDUCE_TO_CSCALAR (GrB, uint64_t , UINT64 )
GB_REDUCE_TO_CSCALAR (GrB, float , FP32 )
GB_REDUCE_TO_CSCALAR (GrB, double , FP64 )
GB_REDUCE_TO_CSCALAR (GxB, GxB_FC32_t, FC32 )
GB_REDUCE_TO_CSCALAR (GxB, GxB_FC64_t, FC64 )
GrB_Info GrB_Vector_reduce_UDT // c = accum (c, reduce_to_scalar (u))
(
void *c, // result scalar
const GrB_BinaryOp accum, // optional accum for c=accum(c,t)
const GrB_Monoid monoid, // monoid to do the reduction
const GrB_Vector u, // vector to reduce
const GrB_Descriptor desc
)
{
GB_RETURN_IF_NULL (u) ;
GB_RETURN_IF_NULL_OR_FAULTY (monoid) ;
GB_WHERE_1 (u, "GrB_Vector_reduce_UDT (&c, accum, monoid, u, desc)") ;
GB_BURBLE_START ("GrB_reduce") ;
ASSERT (GB_VECTOR_OK (u)) ;
info = GB_reduce_to_scalar (c, monoid->op->ztype, accum, monoid,
(GrB_Matrix) u, Werk) ;
GB_BURBLE_END ;
return (info) ;
}
//------------------------------------------------------------------------------
// GrB_Vector_reduce_Monoid_Scalar: reduce a vector to a GrB_Scalar
//------------------------------------------------------------------------------
GrB_Info GrB_Vector_reduce_Monoid_Scalar
(
GrB_Scalar S, // result scalar
const GrB_BinaryOp accum, // optional accum for c=accum(c,t)
const GrB_Monoid monoid, // monoid to do the reduction
const GrB_Vector u, // vector to reduce
const GrB_Descriptor desc
)
{
GB_RETURN_IF_NULL (S) ;
GB_WHERE2 (S, u,
"GrB_Vector_reduce_Monoid_Scalar (s, accum, monoid, u, desc)") ;
GB_BURBLE_START ("GrB_reduce") ;
info = GB_Scalar_reduce (S, accum, monoid, (GrB_Matrix) u, Werk) ;
GB_BURBLE_END ;
return (info) ;
}
//------------------------------------------------------------------------------
// GrB_Vector_reduce_BinaryOp_Scalar: reduce vector to GrB_Scalar via binary op
//------------------------------------------------------------------------------
// Only binary ops that correspond to a known monoid are supported.
// This method is not recommended.
GrB_Info GrB_Vector_reduce_BinaryOp_Scalar
(
GrB_Scalar S, // result scalar
const GrB_BinaryOp accum, // optional accum for c=accum(c,t)
const GrB_BinaryOp op, // binary op to do the reduction
const GrB_Vector u, // vector to reduce
const GrB_Descriptor desc
)
{
GB_RETURN_IF_NULL (S) ;
GB_RETURN_IF_NULL_OR_FAULTY (op) ;
GB_WHERE2 (S, u, "GrB_Vector_reduce_BinaryOp_Scalar : DEPRECATED!") ;
GB_BURBLE_START ("GrB_reduce with binary op : DEPRECATED!") ;
// convert the binary op to its corresponding monoid
if (op->ztype != op->xtype || op->ztype != op->ytype)
{
return (GrB_DOMAIN_MISMATCH) ;
}
GrB_Monoid monoid = GB_binop_to_monoid (op) ;
if (monoid == NULL)
{
return (GrB_NOT_IMPLEMENTED) ;
}
// S = reduce (A) via the monoid
info = GB_Scalar_reduce (S, accum, monoid, (GrB_Matrix) u, Werk) ;
GB_BURBLE_END ;
return (info) ;
}
|