Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

Float64Average Class Reference

#include <coherence/util/aggregator/Float64Average.hpp>

Inherits AbstractFloat64Aggregator.

List of all members.


Detailed Description

Calculates an average for values of any numberic type extracted from a set of entries in a Map.

All the extracted Number objects will be treated as float64_t values. If the set of entries is empty, a NULL result is returned.

Author:
djl 2008.05.09
 

Public Types

typedef spec::Handle Handle
 Float64Average Handle definition.
typedef spec::View View
 Float64Average View definition.
typedef spec::Holder Holder
 Float64Average Holder definition.

Protected Member Functions

 Float64Average ()
 Default constructor (necessary for the PortableObject interface).
 Float64Average (ValueExtractor::View vExtractor)
 Construct a Float64Average aggregator.
virtual void init (bool fFinal)
 Initialize the aggregation result.

Parameters:
 fFinal true is passed if the aggregation process that is being initialized must produce a final aggregation result; this will only be false if a parallel approach is being used and the initial (partial) aggregation process is being initialized
virtual void process (Object::View v, bool fFinal)
 Incorporate one aggregatable value into the result.

If the fFinal parameter is true, the given object is a partial result (returned by an individual parallel aggregator) that should be incorporated into the final result; otherwise, the object is a value extracted from an coherence::util::InvocableMap::Entry.

Parameters:
 vO the value to incorporate into the aggregated result
 fFinal true to indicate that the given object is a partial result returned by a parallel aggregator
virtual Object::Holder finalizeResult (bool fFinal)
 Obtain the result of the aggregation.

If the fFinal parameter is true, the returned object must be the final result of the aggregation; otherwise, the returned object will be treated as a partial result that should be incorporated into the final result.

Parameters:
 fFinal true to indicate that the final result of the aggregation process should be returned; this will only be false if a parallel approach is being used
Returns:
the result of the aggregation process

Constructor & Destructor Documentation

Float64Average ( ValueExtractor::View  vExtractor  )  [protected]

Construct a Float64Average aggregator.

Parameters:
 vExtractor the extractor that provides a value in the form of any object that is a Number


The documentation for this class was generated from the following file:
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.