ComputationResult.h

Go to the documentation of this file.

 
#pragma once
 
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#include <Api/Configuration/DimensionVector.h>
#include <Api/Output/KernelCompilationData.h>
#include <Api/Output/KernelProfilingData.h>
#include <KttPlatform.h>
#include <KttTypes.h>
 
namespace ktt
{
 
class KTT_API ComputationResult
{
public:
    ComputationResult();
 
    explicit ComputationResult(const std::string& kernelFunction);
 
    ComputationResult(const ComputationResult& other);
 
    void SetDurationData(const Nanoseconds duration, const Nanoseconds overhead, const Nanoseconds compilationOverhead, const Nanoseconds profilingOverhead = 0, const Nanoseconds preciseMeasurementOverhead = 0);
 
    void SetSizeData(const DimensionVector& globalSize, const DimensionVector& localSize);
 
    void SetCompilationData(std::unique_ptr<KernelCompilationData> data);
 
    void SetProfilingData(std::unique_ptr<KernelProfilingData> data);
 
    void SetPowerUsage(const uint32_t powerUsage);
 
    void SetTemperature(const double powerUsage);
 
    void SetSMFrequency(const uint32_t frequency);
 
    void SetMemoryFrequency(const uint32_t frequency);
 
    void SetFanSpeed(const int32_t fanSpeed);
 
    void SetDurationStdev(const double durationStdev);
 
    const std::string& GetKernelFunction() const;
 
    const DimensionVector& GetGlobalSize() const;
 
    const DimensionVector& GetLocalSize() const;
 
    Nanoseconds GetDuration() const;
 
    Nanoseconds GetOverhead() const;
 
    Nanoseconds GetCompilationOverhead() const;
 
    Nanoseconds GetProfilingOverhead() const;
 
    Nanoseconds GetPreciseMeasurementOverhead() const;
 
    bool HasCompilationData() const;
 
    const KernelCompilationData& GetCompilationData() const;
 
    bool HasProfilingData() const;
 
    const KernelProfilingData& GetProfilingData() const;
 
    bool HasRemainingProfilingRuns() const;
 
    bool HasPowerData() const;
 
    bool HasTemperatureData() const;
 
    bool HasSMFrequencyData() const;
 
    bool HasMemoryFrequencyData() const;
 
    bool HasFanSpeedData() const;
 
    uint32_t GetPowerUsage() const;
 
    double GetTemperature() const;
 
    uint32_t GetSMFrequency() const;
 
    uint32_t GetMemoryFrequency() const;
 
    int32_t GetFanSpeed() const;
 
    double GetEnergyConsumption() const;
 
    bool HasDurationStdevData() const;
 
    double GetDurationStdev() const;
 
    ComputationResult& operator=(const ComputationResult& other);
 
private:
    std::string m_KernelFunction;
    DimensionVector m_GlobalSize;
    DimensionVector m_LocalSize;
    Nanoseconds m_Duration;
    Nanoseconds m_Overhead;
    Nanoseconds m_CompilationOverhead;
    Nanoseconds m_ProfilingOverhead;
    Nanoseconds m_PreciseMeasurementOverhead;
    std::unique_ptr<KernelCompilationData> m_CompilationData;
    std::unique_ptr<KernelProfilingData> m_ProfilingData;
    std::optional<uint32_t> m_PowerUsage;
    std::optional<double> m_Temperature;
    std::optional<uint32_t> m_SMFrequency;
    std::optional<uint32_t> m_MemFrequency;
    std::optional<int32_t> m_FanSpeed;
    std::optional<double> m_DurationStdev;
};
 
} // namespace ktt