series.h

/*
** Copyright 2007-2024, RTE (https://www.rte-france.com)
** See AUTHORS.txt
** SPDX-License-Identifier: MPL-2.0
** This file is part of Antares-Simulator,
** Adequacy and Performance assessment for interconnected energy networks.
**
** Antares_Simulator is free software: you can redistribute it and/or modify
** it under the terms of the Mozilla Public Licence 2.0 as published by
** the Mozilla Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** Antares_Simulator is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** Mozilla Public Licence 2.0 for more details.
**
** You should have received a copy of the Mozilla Public Licence 2.0
** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
*/
#ifndef __ANTARES_LIBS_STUDY_PARTS_COMMON_TIMESERIES_H__
#define __ANTARES_LIBS_STUDY_PARTS_COMMON_TIMESERIES_H__
 
#include <map>
#include <optional>
#include <string>
 
#include <antares/array/matrix.h>
 
namespace Antares::Data
{
class TimeSeries;
 
class TimeSeriesNumbers
{
public:
    void registerSeries(const TimeSeries* s, std::string label);
    // Return a description of the error in case of inconsistent number of columns, std::nullopt
    // otherwis
    std::optional<std::string> checkSeriesNumberOfColumnsConsistency() const;
 
    uint32_t operator[](uint y) const;
    uint32_t& operator[](uint y);
 
    void clear();
    void reset(uint h);
 
    uint height() const;
 
    void saveToBuffer(std::string& data) const;
 
private:
    Matrix<uint32_t> tsNumbers;
    std::map<std::string, const TimeSeries*> series;
};
 
class TimeSeries
{
public:
    using TS = Matrix<double>;
 
    explicit TimeSeries(TimeSeriesNumbers& tsNumbers);
    bool loadFromFile(const std::filesystem::path& path, const bool average);
    int saveToFolder(const std::string& areaID,
                     const std::string& folder,
                     const std::string& prefix) const;
 
    int saveToFile(const std::string& filename, bool saveEvenIfAllZero) const;
 
    double getCoefficient(uint32_t year, uint32_t timestep) const;
    const double* getColumn(uint32_t year) const;
    uint32_t getSeriesIndex(uint32_t year) const;
 
    double* operator[](uint32_t index);
 
    void reset();
    void reset(uint32_t width, uint32_t height);
    uint32_t numberOfColumns() const;
    void unloadFromMemory() const;
    void roundAllEntries();
    void resize(uint32_t timeSeriesCount, uint32_t timestepCount);
    void fill(double value);
    void averageTimeseries();
 
    bool forceReload(bool reload = false) const;
    void markAsModified() const;
 
    TS timeSeries;
    TimeSeriesNumbers& timeseriesNumbers;
 
    static const std::vector<double> emptyColumn; 
};
 
} // namespace Antares::Data
#endif /* __ANTARES_LIBS_STUDY_PARTS_COMMON_TIMESERIES_H__ */