xaizek / etabench (License: GPLv3) (since 2022-09-08)
Benchmark for algorithms that compute I/O ETA
<root> / src / core.hpp (760750dbaa47e56bbc8a41e66f11cd81b6d6bab3) (1,460B) (mode 100644) [raw]
// etabench
// Copyright (C) 2022 xaizek <xaizek@posteo.net>
//
// This file is part of etabench.
//
// etabench is free software: you can redistribute it and/or modify
// it under the terms of version 3 of the GNU General Public License
// as published by the Free Software Foundation.
//
// etabench 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
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with etabench.  If not, see <https://www.gnu.org/licenses/>.

#ifndef ETABENCH__CORE_HPP__
#define ETABENCH__CORE_HPP__

#include <string>

class Profile
{
public:
    virtual ~Profile() = default;

public:
    // Returned value should be unique.
    virtual std::string getName() const = 0;

    // Reset any permanent state.  Always called before first invocation of
    // `operator()`.
    virtual void reset()
    { }

    virtual int operator()(int time) = 0;
};

class EtaAlg
{
public:
    virtual ~EtaAlg() = default;

public:
    virtual std::string getName() const = 0;

    // Reset any permanent state.  Always called before estimate().
    virtual void reset() = 0;

    // current, total -- in bytes
    // time, return -- in seconds
    virtual int estimate(int current, int total, int time) = 0;
};

#endif // ETABENCH__CORE_HPP__
Hints

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/etabench

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/etabench

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master