BLI_index_mask.hh

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
 
#pragma once
 
#include "BLI_index_range.hh"
#include "BLI_span.hh"
 
namespace blender {
 
class IndexMask {
 private:
  /* The underlying reference to sorted integers. */
  Span<int64_t> indices_;
 
 public:
  /* Creates an IndexMask that contains no indices. */
  IndexMask() = default;
 
  IndexMask(Span<int64_t> indices) : indices_(indices)
  {
#ifdef DEBUG
    for (int64_t i = 1; i < indices.size(); i++) {
      BLI_assert(indices[i - 1] < indices[i]);
    }
#endif
  }
 
  IndexMask(IndexRange range) : indices_(range.as_span())
  {
  }
 
  IndexMask(const std::initializer_list<int64_t> &indices) : IndexMask(Span<int64_t>(indices))
  {
  }
 
  explicit IndexMask(int64_t n) : IndexMask(IndexRange(n))
  {
  }
 
  operator Span<int64_t>() const
  {
    return indices_;
  }
 
  const int64_t *begin() const
  {
    return indices_.begin();
  }
 
  const int64_t *end() const
  {
    return indices_.end();
  }
 
  int64_t operator[](int64_t n) const
  {
    return indices_[n];
  }
 
  int64_t min_array_size() const
  {
    if (indices_.size() == 0) {
      return 0;
    }
    else {
      return indices_.last() + 1;
    }
  }
 
  Span<int64_t> indices() const
  {
    return indices_;
  }
 
  bool is_range() const
  {
    return indices_.size() > 0 && indices_.last() - indices_.first() == indices_.size() - 1;
  }
 
  IndexRange as_range() const
  {
    BLI_assert(this->is_range());
    return IndexRange{indices_.first(), indices_.size()};
  }
 
  template<typename CallbackT> void foreach_index(const CallbackT &callback) const
  {
    if (this->is_range()) {
      IndexRange range = this->as_range();
      for (int64_t i : range) {
        callback(i);
      }
    }
    else {
      for (int64_t i : indices_) {
        callback(i);
      }
    }
  }
 
  IndexRange index_range() const
  {
    return indices_.index_range();
  }
 
  int64_t last() const
  {
    return indices_.last();
  }
 
  int64_t size() const
  {
    return indices_.size();
  }
};
 
}  // namespace blender