IntervalsParser.H

Go to the documentation of this file.

/* Copyright 2022 Andrew Myers, Burlen Loring, Luca Fedeli
 * Maxence Thevenet, Remi Lehe, Revathi Jambunathan
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
 
#ifndef WARPX_UTILS_PARSER_INTERVALSPARSER_H_
#define WARPX_UTILS_PARSER_INTERVALSPARSER_H_
 
#include <limits>
#include <string>
#include <vector>
 
namespace utils::parser
{

    class SliceParser
    {
    public:
        SliceParser (const std::string& instr, bool isBTD=false);

        [[nodiscard]] bool contains (int n) const;

        [[nodiscard]] int nextContains (int n) const;

        [[nodiscard]] int previousContains (int n) const;

        [[nodiscard]] int getPeriod () const;

        [[nodiscard]] int getStart () const;

        [[nodiscard]] int getStop () const;

        [[nodiscard]] int numContained() const;
 
    private:
        bool m_isBTD = false;
        int m_start = 0;
        int m_stop = std::numeric_limits<int>::max();
        int m_period = 1;
        std::string m_separator = ":";
 
    };
 

    class IntervalsParser
    {
    public:
        IntervalsParser () = default;

        IntervalsParser (const std::vector<std::string>& instr_vec);

        [[nodiscard]] bool contains (int n) const;

        [[nodiscard]] int nextContains (int n) const;

        [[nodiscard]] int previousContains (int n) const;

        [[nodiscard]] int previousContainsInclusive (int n) const;

        [[nodiscard]] int localPeriod (int n) const;

        [[nodiscard]] bool isActivated () const;
 
    private:
        std::vector<SliceParser> m_slices;
        std::string m_separator = ",";
        bool m_activated = false;
    };

    class BTDIntervalsParser
    {
    public:
        BTDIntervalsParser () = default;

        BTDIntervalsParser (const std::vector<std::string>& instr_vec);

        [[nodiscard]] int NumSnapshots () const;

        [[nodiscard]] int GetBTDIteration(int i_buffer) const;

        [[nodiscard]] int GetFinalIteration() const;

        [[nodiscard]] bool isActivated () const;
 
    private:
        std::vector<int> m_btd_iterations;
        std::vector<SliceParser> m_slices;
        std::vector<int> m_slice_starting_i_buffer;
        static constexpr char m_separator = ',';
        bool m_activated = false;
    };
}
 
#endif // WARPX_UTILS_PARSER_INTERVALSPARSER_H_