data_frame.h

Go to the documentation of this file.

#pragma once
 
#include <libopynsim/series.h>
 
#include <cstddef>
#include <iosfwd>
#include <optional>
#include <string>
#include <tuple>
#include <unordered_map>
#include <vector>
 
namespace opyn
{
    class DataFrame final {
    public:
        using value_type = Series;
        using size_type = size_t;
        using const_reference = const value_type&;
        using const_iterator = std::vector<Series>::const_iterator;
 
        DataFrame() = default;
 
        explicit DataFrame(
            std::vector<std::string> column_names,
            std::vector<std::vector<double>> column_data,
            std::unordered_map<std::string, std::string> attrs = {}
        );
 
        explicit DataFrame(
            std::vector<Series> series,
            std::unordered_map<std::string, std::string> attrs = {}
        );
 
        bool operator==(const DataFrame&) const;
 
        std::vector<std::string> columns() const;
 
        std::tuple<size_t, size_t> shape() const;
 
        size_t height() const;
 
        size_t width() const;
 
        std::unordered_map<std::string, std::string> attrs() const;
 
        void set_attrs(std::unordered_map<std::string, std::string> new_attrs);
 
        bool has_attr(const std::string& key) const;
 
        std::optional<std::string> get_attr(const std::string& key) const;
 
        const_reference operator[](std::string_view name) const;
 
        const_reference operator[](size_type pos) const { return series_[pos]; }
 
        size_type size() const { return series_.size(); }
 
        [[nodiscard]] bool empty() const { return series_.empty(); }
 
        const_iterator begin() const { return series_.begin(); }
 
        const_iterator end() const { return series_.end(); }
 
        const_iterator find(std::string_view name) const;
 
        DataFrame with_series(Series series) const;
    private:
        std::vector<Series> series_;
        std::unordered_map<std::string, size_t> column_to_index_lookup_;
        std::unordered_map<std::string, std::string> attrs_;
    };
 
    std::ostream& operator<<(std::ostream& out, const DataFrame& data_frame);
}