Data.hpp

Go to the documentation of this file.

/*
Copyright (c) 2018, University of Oxford.
All rights reserved.

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of trase.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/


#ifndef DATA_H_
#define DATA_H_

#include <cassert>
#include <functional>
#include <map>
#include <memory>
#include <set>
#include <unordered_map>
#include <vector>

#include "util/BBox.hpp"
#include "util/Colors.hpp"
#include "util/ColumnIterator.hpp"
#include "util/Exception.hpp"

namespace trase {

class RawData {
  // raw data set, in row major order
  std::vector<float> m_matrix;

  // sets for non-numeric string data
  std::vector<std::set<std::string>> m_string_data;

  std::vector<float> m_tmp;

  int m_rows{0};
  int m_cols{0};

public:
  int cols() const { return m_cols; };

  int rows() const { return m_rows; };

  template <typename T> void add_column(T new_col_begin, T new_col_end);

  template <typename T> void add_row(T new_row_begin, T new_row_end);

  template <typename T> void add_column(const std::vector<T> &new_col);

  template <typename T> void add_row(const std::vector<T> &new_row);

  template <typename T> void set_column(int i, const std::vector<T> &new_col);

  ColumnIterator begin(int i) const;

  ColumnIterator end(int i) const;

  const std::set<std::string> &string_data(int i) const;

  template <typename T>
  std::map<T, std::shared_ptr<RawData>> facet(const std::vector<T> &data) const;

  template <typename T1, typename T2>
  std::map<std::pair<T1, T2>, std::shared_ptr<RawData>>
  facet(const std::vector<T1> &data1, const std::vector<T2> &data2) const;
};

struct Aesthetic {
  // total number of Aesthetics
  static const int N = 9;

  using Limits = bbox<float, N - 4>;

  struct x {
    static const int index = 0;
    static const char *name;
    static float to_display(float data, const Limits &data_lim,
                            const bfloat2_t &display_lim);
    static float from_display(float display, const Limits &data_lim,
                              const bfloat2_t &display_lim);
  };

  struct y {
    static const int index = 1;
    static const char *name;
    static float to_display(float data, const Limits &data_lim,
                            const bfloat2_t &display_lim);
    static float from_display(float display, const Limits &data_lim,
                              const bfloat2_t &display_lim);
  };

  struct color {
    static const int index = 2;
    static const char *name;

    static float to_display(float data, const Limits &data_lim,
                            const bfloat2_t &display_lim);
    static float from_display(float display, const Limits &data_lim,
                              const bfloat2_t &display_lim);
  };

  struct size {
    static const int index = 3;
    static const char *name;

    static float to_display(float data, const Limits &data_lim,
                            const bfloat2_t &display_lim);
    static float from_display(float display, const Limits &data_lim,
                              const bfloat2_t &display_lim);
  };

  struct fill {
    static const int index = 4;
    static const char *name;

    static float to_display(float data, const Limits &data_lim,
                            const bfloat2_t &display_lim);
    static float from_display(float display, const Limits &data_lim,
                              const bfloat2_t &display_lim);
  };

  // NOTE: xmin,ymin,xmax,ymax need to go at end so that the indices for
  // Limits work out

  struct xmin {
    static const int index = 5;
    static const char *name;
    static float to_display(float data, const Limits &data_lim,
                            const bfloat2_t &display_lim);
    static float from_display(float display, const Limits &data_lim,
                              const bfloat2_t &display_lim);
  };

  struct ymin {
    static const int index = 6;
    static const char *name;
    static float to_display(float data, const Limits &data_lim,
                            const bfloat2_t &display_lim);
    static float from_display(float display, const Limits &data_lim,
                              const bfloat2_t &display_lim);
  };

  struct xmax {
    static const int index = 7;
    static const char *name;
    static float to_display(float data, const Limits &data_lim,
                            const bfloat2_t &display_lim);
    static float from_display(float display, const Limits &data_lim,
                              const bfloat2_t &display_lim);
  };

  struct ymax {
    static const int index = 8;
    static const char *name;
    static float to_display(float data, const Limits &data_lim,
                            const bfloat2_t &display_lim);
    static float from_display(float display, const Limits &data_lim,
                              const bfloat2_t &display_lim);
  };
};

using Limits = Aesthetic::Limits;

class DataWithAesthetic {
  std::shared_ptr<RawData> m_data;

  std::unordered_map<int, int> m_map;

  Limits m_limits;

public:
  DataWithAesthetic() : m_data(std::make_shared<RawData>()) {}

  explicit DataWithAesthetic(std::shared_ptr<RawData> data)
      : m_data(std::move(data)) {}

  DataWithAesthetic(std::shared_ptr<RawData> data,
                    const std::unordered_map<int, int> &map,
                    const Limits &limits)
      : m_data(std::move(data)), m_map(map), m_limits(limits) {}

  template <typename Aesthetic> ColumnIterator begin() const;

  template <typename Aesthetic> ColumnIterator end() const;

  template <typename Aesthetic, typename T>
  void set(const std::vector<T> &data);

  template <typename Aesthetic> void set(float min, float max);

  template <typename Aesthetic> bool has() const;

  int rows() const;

  int cols() const;

  const Limits &limits() const;

  template <typename T> DataWithAesthetic &x(const std::vector<T> &data);
  DataWithAesthetic &x(float min, float max);

  template <typename T> DataWithAesthetic &y(const std::vector<T> &data);
  DataWithAesthetic &y(float min, float max);

  template <typename T> DataWithAesthetic &color(const std::vector<T> &data);
  DataWithAesthetic &color(float min, float max);

  template <typename T> DataWithAesthetic &size(const std::vector<T> &data);
  DataWithAesthetic &size(float min, float max);

  template <typename T> DataWithAesthetic &fill(const std::vector<T> &data);
  DataWithAesthetic &fill(float min, float max);

  template <typename T> DataWithAesthetic &xmin(const std::vector<T> &data);
  DataWithAesthetic &xmin(float min, float max);

  template <typename T> DataWithAesthetic &ymin(const std::vector<T> &data);
  DataWithAesthetic &ymin(float min, float max);

  template <typename T> DataWithAesthetic &xmax(const std::vector<T> &data);
  DataWithAesthetic &xmax(float min, float max);

  template <typename T> DataWithAesthetic &ymax(const std::vector<T> &data);
  DataWithAesthetic &ymax(float min, float max);

  template <typename T>
  std::map<T, DataWithAesthetic> facet(const std::vector<T> &data) const;

  template <typename T1, typename T2>
  std::map<std::pair<T1, T2>, DataWithAesthetic>
  facet(const std::vector<T1> &data1, const std::vector<T2> &data2) const;

private:
  template <typename Aesthetic, typename T>
  void calculate_limits(T begin, T end);
};

DataWithAesthetic create_data();

} // namespace trase

#include "Data.tcc"

#endif // DATA_H_