types.h

Go to the documentation of this file.

/* Author: Christoph Lassner. */
#pragma once
#ifndef FORPY_TYPES_H_
#define FORPY_TYPES_H_

#include <Eigen/Dense>
#include <map>
#include <memory>
#include <numeric>
#include <utility>
#include <vector>

#include "./util/hash.h"
#include "./util/storage.h"

namespace forpy {

typedef unsigned int uint;

template <typename T>
struct Name {
  static std::string value() { return "unknown"; };
};
template <>
struct Name<double> {
  static std::string value() { return "d"; }
};
template <>
struct Name<float> {
  static std::string value() { return "f"; }
};
template <>
struct Name<uint> {
  static std::string value() { return "ui"; }
};
template <>
struct Name<uint8_t> {
  static std::string value() { return "ui8"; }
};
template <>
struct Name<int16_t> {
  static std::string value() { return "i16"; }
};
template <>
struct Name<int> {
  static std::string value() { return "i"; }
};

template <typename DT>
using Mat = Eigen::Matrix<DT, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>;

template <typename DT>
using MatCM =
    Eigen::Matrix<DT, Eigen::Dynamic, Eigen::Dynamic, Eigen::ColMajor>;

template <typename DT>
using MatCRef = Eigen::Ref<const Mat<DT>>;

template <typename DT>
using MatCMCRef = Eigen::Ref<const MatCM<DT>>;

template <typename DT>
using MatRef = Eigen::Ref<Mat<DT>>;

template <typename DT>
using Vec = Eigen::Matrix<DT, Eigen::Dynamic, 1, Eigen::ColMajor>;

template <typename DT>
using VecRM = Eigen::Matrix<DT, 1, Eigen::Dynamic, Eigen::RowMajor>;

template <typename DT>
using VecRef = Eigen::Ref<Vec<DT>>;

template <typename DT>
using VecRMRef = Eigen::Ref<VecRM<DT>>;

template <typename DT>
using VecCRef = Eigen::Ref<const Vec<DT>>;

template <typename DT>
using VecCMap =
    Eigen::Map<const Eigen::Matrix<DT, 1, Eigen::Dynamic, Eigen::RowMajor>,
               Eigen::Unaligned, Eigen::InnerStride<>>;

enum class ECompletionLevel {
  Node,
  Level,
  Complete
};

typedef size_t id_t;

typedef std::function<id_t(const Data<MatCRef> &, const id_t &,
                           const std::function<void(void *)> &)>
    node_predf;

enum class EThresholdSelection { LessEqOnly, GreaterOnly, Both };

template <typename FT>
struct SplitOptRes {
  id_t split_idx;
  FT thresh;
  float gain;
  bool valid;

  inline friend std::ostream &operator<<(std::ostream &stream,
                                         const SplitOptRes<FT> &self) {
    stream << "forpy::SplitOptRes_X[<=" << self.thresh
           << "; gain: " << self.gain << ", valid: " << self.valid << "]";
    return stream;
  };

  bool operator==(SplitOptRes<FT> const &rhs) const {
    return split_idx == rhs.split_idx && thresh == rhs.thresh &&
           gain == rhs.gain && valid == rhs.valid;
  }
};
typedef mu::variant<SplitOptRes<float>, SplitOptRes<double>, SplitOptRes<uint>,
                    SplitOptRes<uint8_t>>
    OptSplitV;

typedef std::pair<id_t, id_t> interv_t;

struct TodoMark {
  inline TodoMark() : node_id(0), depth(0){};
  inline TodoMark(std::shared_ptr<std::vector<id_t>> sample_ids,
                  const interv_t &interv, const id_t &node_id,
                  const uint &depth)
      : sample_ids(sample_ids),
        interv(interv),
        node_id(node_id),
        depth(depth){};
  std::shared_ptr<std::vector<id_t>> sample_ids;
  interv_t interv;
  id_t node_id;
  uint depth;
  inline bool operator==(TodoMark const &rhs) const {
    return node_id == rhs.node_id && depth == rhs.depth &&
           interv == rhs.interv && *sample_ids == *(rhs.sample_ids);
  }
  inline friend std::ostream &operator<<(std::ostream &stream,
                                         const TodoMark &self) {
    stream << "forpy::TodoMark[node_id:  " << self.node_id << ", depth "
           << self.depth << "]";
    return stream;
  };
  MOVE_ASSIGN(TodoMark);

 private:
  friend class cereal::access;
  template <class Archive>
  void serialize(Archive &ar, const uint &) {
    ar(CEREAL_NVP(sample_ids), CEREAL_NVP(interv), CEREAL_NVP(node_id),
       CEREAL_NVP(depth));
  };
  DISALLOW_COPY_AND_ASSIGN(TodoMark);
};

typedef std::pair<ptrdiff_t, ptrdiff_t> regint_t;

typedef std::vector<std::pair<std::shared_ptr<std::vector<size_t>>,
                              std::shared_ptr<std::vector<float> const>>>
    usage_map_t;

typedef std::pair<std::shared_ptr<std::vector<id_t>>, id_t> include_pair_t;

enum class ESearchType { DFS, BFS };

typedef std::unordered_set<std::vector<size_t>, vector_hasher> proposal_set_t;

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-variable"
const double GAIN_EPS = 1E-7;
#pragma clang diagnostic pop
const MatCRef<float> FORPY_ZERO_MATR(Mat<float>::Zero(0, 1));
};      // namespace forpy
#endif  // FORPY_TYPES_H_