time_series_functor.h

Go to the documentation of this file.

/* 
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Rene Schmieding
*
* Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MIO_MATH_TIME_SERIES_FUNCTOR_H
#define MIO_MATH_TIME_SERIES_FUNCTOR_H
 
#include "memilio/io/default_serialize.h"
#include "memilio/math/interpolation.h"
#include "memilio/utils/time_series.h"
 
#include <cassert>
#include <vector>
 
namespace mio
{
 
enum class TimeSeriesFunctorType
{
    LinearInterpolation,
};
 
template <class FP>
class TimeSeriesFunctor
{
public:
    TimeSeriesFunctor(TimeSeriesFunctorType type, const TimeSeries<FP>& data)
        : m_type(type)
        , m_data(data)
    {
        // data shape checks and preprocessing
        switch (m_type) {
        case TimeSeriesFunctorType::LinearInterpolation:
            // make sure data has the correct shape, i.e. a list of (time, value) pairs
            assert(m_data.get_num_time_points() > 0 && "Need at least one time point for LinearInterpolation.");
            assert(m_data.get_num_elements() == 1 && "LinearInterpolation requires exactly one value per time point.");
            assert(m_data.is_strictly_monotonic());
            break;
        default:
            assert(false && "Unhandled TimeSeriesFunctorType!");
            break;
        }
    }
 
    TimeSeriesFunctor(TimeSeriesFunctorType type, std::vector<std::vector<FP>>&& table)
        : TimeSeriesFunctor(type, TimeSeries<FP>{std::move(table)})
    {
    }
 
    TimeSeriesFunctor()
        : TimeSeriesFunctor(TimeSeriesFunctorType::LinearInterpolation, {{FP(0.0), FP(0.0)}})
    {
    }
 
    FP operator()(FP time) const
    {
        switch (m_type) {
        case TimeSeriesFunctorType::LinearInterpolation:
            return linear_interpolation(time, m_data)[0];
        default:
            assert(false && "Unhandled TimeSeriesFunctorType!");
            return FP();
        }
    }
 
    auto default_serialize()
    {
        return Members("TimeSeriesFunctor").add("type", m_type).add("data", m_data);
    }
 
private:
    TimeSeriesFunctorType m_type; 
    TimeSeries<FP> m_data; 
};
 
} // namespace mio
 
#endif