statuniquecount.h

// Copyright 2009-2024 NTESS. Under the terms
// of Contract DE-NA0003525 with NTESS, the U.S.
// Government retains certain rights in this software.
//
// Copyright (c) 2009-2024, NTESS
// All rights reserved.
//
// This file is part of the SST software package. For license
// information, see the LICENSE file in the top level directory of the
// distribution.

#ifndef SST_CORE_STATAPI_STATUNIQUECOUNT_H
#define SST_CORE_STATAPI_STATUNIQUECOUNT_H

#include "sst/core/sst_types.h"
#include "sst/core/statapi/statbase.h"
#include "sst/core/warnmacros.h"

namespace SST {
class BaseComponent;
namespace Statistics {

/**
    \class UniqueCountStatistic

    Creates a Statistic which counts unique values provided to it.

    @tparam T A template for holding the main data type of this statistic
*/

template <typename T>
class UniqueCountStatistic : public Statistic<T>
{
public:
    SST_ELI_DECLARE_STATISTIC_TEMPLATE(
        UniqueCountStatistic,
        "sst",
        "UniqueCountStatistic",
        SST_ELI_ELEMENT_VERSION(1, 0, 0),
        "Track unique occurrences of statistic",
        "SST::Statistic<T>")

    UniqueCountStatistic(
        BaseComponent* comp, const std::string& statName, const std::string& statSubId, Params& statParams) :
        Statistic<T>(comp, statName, statSubId, statParams)
    {
        // Set the Name of this Statistic
        this->setStatisticTypeName("UniqueCount");
    }

    ~UniqueCountStatistic() {};

    UniqueCountStatistic() : Statistic<T>() {}

    void serialize_order(SST::Core::Serialization::serializer& ser) override
    {
        SST::Statistics::Statistic<T>::serialize_order(ser);
        ser& uniqueSet;
        // uniqueCountField will be reset by statistics output object
    }

protected:
    /**
    Present a new value to the Statistic to be included in the unique set
        @param data New data item to be included in the unique set
    */
    void addData_impl(T data) override { uniqueSet.insert(data); }

private:
    void clearStatisticData() override { uniqueSet.clear(); }

    void registerOutputFields(StatisticFieldsOutput* statOutput) override
    {
        uniqueCountField = statOutput->registerField<uint64_t>("UniqueItems");
    }

    void outputStatisticFields(StatisticFieldsOutput* statOutput, bool UNUSED(EndOfSimFlag)) override
    {
        statOutput->outputField(uniqueCountField, (uint64_t)uniqueSet.size());
    }

private:
    std::set<T>                    uniqueSet;
    StatisticOutput::fieldHandle_t uniqueCountField;
};

} // namespace Statistics
} // namespace SST

#endif // SST_CORE_STATAPI_STATUNIQUECOUNT_H