IndexMask.h

Go to the documentation of this file.

#ifndef INDEX_MASK_H
#define INDEX_MASK_H
 
#include <stdexcept>
#include <memory>
#include <numeric>
#include <algorithm>
 
namespace CNum::DataStructs {
  template <typename T> class Matrix;


   *
   * The index mask at its core is a list of indeces that can be used to reorder and get subsets of
   * datasets. 
   */
  class IndexMask {
  private:
    ::std::unique_ptr<size_t[]> _mask;
    size_t _size;

    void copy(const IndexMask &other) noexcept;
    void move(IndexMask &&other) noexcept;
  
  public:
    IndexMask() = delete;
    IndexMask(::std::unique_ptr<size_t[]> mask, size_t size);

    IndexMask(const IndexMask &other) noexcept;
    IndexMask &operator=(const IndexMask &other) noexcept;

    IndexMask(IndexMask &&other) noexcept;
    IndexMask &operator=(IndexMask &&other) noexcept;

    template <typename T>
    ::CNum::DataStructs::Matrix<T> matrix_apply_mask(const ::CNum::DataStructs::Matrix<T> &m) const;

    template <typename T>
    ::CNum::DataStructs::Matrix<T> matrix_apply_mask_col_wise(const ::CNum::DataStructs::Matrix<T> &m) const;

    template <typename Container, typename T, typename CompareFunction = ::std::greater<T>>
    static IndexMask argsort(const Container &container);
  };
 
#include "CNum/DataStructs/Matrix/IndexMask.tpp"
};
 
#endif