```#!/usr/bin/env python

#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

import json
import math
import numbers
import struct

from histogrammar.defs import *
from histogrammar.util import *

class Sum(Factory, Container):
"""Accumulate the (weighted) sum of a given quantity, calculated from the data.

Sum differs from :doc:`Count <histogrammar.primitives.count.Count>` in that it computes a quantity on the spot, rather than percolating a product of weight metadata from nested primitives. Also unlike weights, the sum can add both positive and negative quantities (weights are always non-negative).
"""

@staticmethod
def ed(entries, sum):
"""Create a Sum that is only capable of being added.

Parameters:
entries (float): the number of entries.
sum (float): the sum.
"""
if not isinstance(entries, numbers.Real) and entries not in ("nan", "inf", "-inf"):
raise TypeError("entries ({0}) must be a number".format(entries))
if not isinstance(sum, numbers.Real) and entries not in ("nan", "inf", "-inf"):
raise TypeError("sum ({0}) must be a number".format(sum))
if entries < 0.0:
raise ValueError("entries ({0}) cannot be negative".format(entries))
out = Sum(None)
out.entries = float(entries)
out.sum = float(sum)
return out.specialize()

@staticmethod
def ing(quantity):
"""Synonym for ``__init__``."""
return Sum(quantity)

def __init__(self, quantity):
"""Create a Sum that is capable of being filled and added.

Parameters:
quantity (function returning float): computes the quantity of interest from the data.

Other parameters:
entries (float): the number of entries, initially 0.0.
sum (float): the running sum, initially 0.0.
"""
self.quantity = serializable(quantity)
self.entries = 0.0
self.sum = 0.0
super(Sum, self).__init__()
self.specialize()

@inheritdoc(Container)
def zero(self): return Sum(self.quantity)

@inheritdoc(Container)
if isinstance(other, Sum):
out = Sum(self.quantity)
out.entries = self.entries + other.entries
out.sum = self.sum + other.sum
return out.specialize()
else:
raise ContainerException("cannot add {0} and {1}".format(self.name, other.name))

@inheritdoc(Container)
self.entries += other.entries
self.sum += other.sum
return self

@inheritdoc(Container)
def __mul__(self, factor):
if math.isnan(factor) or factor <= 0.0:
return self.zero()
else:
out = self.zero()
out.entries = factor * self.entries
out.sum = factor * self.sum
return out.specialize()

@inheritdoc(Container)
def __rmul__(self, factor):
return self.__mul__(factor)

@inheritdoc(Container)
def fill(self, datum, weight=1.0, method=None):
self._checkForCrossReferences()

if weight > 0.0:
q = self.quantity(datum)
if not isinstance(q, numbers.Real):
raise TypeError("function return value ({0}) must be boolean or number".format(q))

# no possibility of exception from here on out (for rollback)
self.entries += weight
self.sum += q * weight

def _cppGenerateCode(self, parser, generator, inputFieldNames, inputFieldTypes, derivedFieldTypes, derivedFieldExprs, storageStructs, initCode, initPrefix, initIndent, fillCode, fillPrefix, fillIndent, weightVars, weightVarStack, tmpVarTypes):
return self._c99GenerateCode(parser, generator, inputFieldNames, inputFieldTypes, derivedFieldTypes, derivedFieldExprs, storageStructs, initCode, initPrefix, initIndent, fillCode, fillPrefix, fillIndent, weightVars, weightVarStack, tmpVarTypes)

def _c99GenerateCode(self, parser, generator, inputFieldNames, inputFieldTypes, derivedFieldTypes, derivedFieldExprs, storageStructs, initCode, initPrefix, initIndent, fillCode, fillPrefix, fillIndent, weightVars, weightVarStack, tmpVarTypes):
initCode.append(" " * initIndent + self._c99ExpandPrefix(*initPrefix) + ".entries = 0.0;")
initCode.append(" " * initIndent + self._c99ExpandPrefix(*initPrefix) + ".sum = 0.0;")

normexpr = self._c99QuantityExpr(parser, generator, inputFieldNames, inputFieldTypes, derivedFieldTypes, derivedFieldExprs, None)
fillCode.append(" " * fillIndent + self._c99ExpandPrefix(*fillPrefix) + ".entries += " + weightVarStack[-1] + ";")
fillCode.append(" " * fillIndent + self._c99ExpandPrefix(*fillPrefix) + ".sum += " + normexpr + ";")

storageStructs[self._c99StructName()] = """
typedef struct {{
double entries;
double sum;
}} {0};
""".format(self._c99StructName())

def _clingUpdate(self, filler, *extractorPrefix):
obj = self._clingExpandPrefix(filler, *extractorPrefix)
self.entries += obj.entries
self.sum += obj.sum

def _c99StructName(self):
return "Sm"

def _cudaGenerateCode(self, parser, generator, inputFieldNames, inputFieldTypes, derivedFieldTypes, derivedFieldExprs, storageStructs, initCode, initPrefix, initIndent, fillCode, fillPrefix, fillIndent, combineCode, totalPrefix, itemPrefix, combineIndent, jsonCode, jsonPrefix, jsonIndent, weightVars, weightVarStack, tmpVarTypes, suppressName):
initCode.append(" " * initIndent + self._c99ExpandPrefix(*initPrefix) + ".entries = 0.0f;")
initCode.append(" " * initIndent + self._c99ExpandPrefix(*initPrefix) + ".sum = 0.0f;")

normexpr = self._cudaQuantityExpr(parser, generator, inputFieldNames, inputFieldTypes, derivedFieldTypes, derivedFieldExprs, None)
fillCode.append(" " * fillIndent + "atomicAdd(&" + self._c99ExpandPrefix(*fillPrefix) + ".entries, " + weightVarStack[-1] + ");")
fillCode.append(" " * fillIndent + "atomicAdd(&" + self._c99ExpandPrefix(*fillPrefix) + ".sum, " + normexpr + ");")

combineCode.append(" " * combineIndent + "atomicAdd(&" + self._c99ExpandPrefix(*totalPrefix) + ".entries, " + self._c99ExpandPrefix(*itemPrefix) + ".entries);")
combineCode.append(" " * combineIndent + "atomicAdd(&" + self._c99ExpandPrefix(*totalPrefix) + ".sum, " + self._c99ExpandPrefix(*itemPrefix) + ".sum);")

jsonCode.append(" " * jsonIndent + "fprintf(out, \"{\\\"entries\\\": \");")
jsonCode.append(" " * jsonIndent + "floatToJson(out, " + self._c99ExpandPrefix(*jsonPrefix) + ".entries);")
jsonCode.append(" " * jsonIndent + "fprintf(out, \", \\\"sum\\\": \");")
jsonCode.append(" " * jsonIndent + "floatToJson(out, " + self._c99ExpandPrefix(*jsonPrefix) + ".sum);")
if suppressName or self.quantity.name is None:
jsonCode.append(" " * jsonIndent + "fprintf(out, \"}\");")
else:
jsonCode.append(" " * jsonIndent + "fprintf(out, \", \\\"name\\\": " + json.dumps(json.dumps(self.quantity.name))[1:-1] + "}\");")

storageStructs[self._c99StructName()] = """
typedef struct {{
float entries;
float sum;
}} {0};
""".format(self._c99StructName())

def _cudaUnpackAndFill(self, data, bigendian, alignment):
format = "<ff"
entries, sum = struct.unpack(format, data[:struct.calcsize(format)])
self.entries += entries
self.sum += sum
return data[struct.calcsize(format):]

def _numpy(self, data, weights, shape):
q = self.quantity(data)
self._checkNPQuantity(q, shape)
self._checkNPWeights(weights, shape)
weights = self._makeNPWeights(weights, shape)

# no possibility of exception from here on out (for rollback)
self.entries += float(weights.sum())

import numpy
selection = numpy.isnan(q)
numpy.bitwise_not(selection, selection)
numpy.bitwise_and(selection, weights > 0.0, selection)
q = q[selection]
weights = weights[selection]
q *= weights

self.sum += float(q.sum())

def _sparksql(self, jvm, converter):
return converter.Sum(self.quantity.asSparkSQL())

@property
def children(self):
"""List of sub-aggregators, to make it possible to walk the tree."""
return []

@inheritdoc(Container)
"entries": floatToJson(self.entries),
"sum": floatToJson(self.sum),
}, name=(None if suppressName else self.quantity.name))

@staticmethod
@inheritdoc(Factory)
def fromJsonFragment(json, nameFromParent):
if isinstance(json, dict) and hasKeys(json.keys(), ["entries", "sum"], ["name"]):
if json["entries"] in ("nan", "inf", "-inf") or isinstance(json["entries"], numbers.Real):
entries = float(json["entries"])
else:
raise JsonFormatException(json["entries"], "Sum.entries")

if isinstance(json.get("name", None), basestring):
name = json["name"]
elif json.get("name", None) is None:
name = None
else:
raise JsonFormatException(json["name"], "Sum.name")

if json["sum"] in ("nan", "inf", "-inf") or isinstance(json["sum"], numbers.Real):
sum = float(json["sum"])
else:
raise JsonFormatException(json["sum"], "Sum.sum")

out = Sum.ed(entries, sum)
out.quantity.name = nameFromParent if name is None else name
return out.specialize()

else:
raise JsonFormatException(json, "Sum")

def __repr__(self):
return "<Sum sum={0}>".format(self.sum)

def __eq__(self, other):
return isinstance(other, Sum) and self.quantity == other.quantity and numeq(self.entries, other.entries) and numeq(self.sum, other.sum)

def __ne__(self, other): return not self == other

def __hash__(self):
return hash((self.quantity, self.entries, self.sum))

Factory.register(Sum)
```