IndexRange.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000- 2011, Hammersmith Imanet Ltd
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0 AND License-ref-PARAPET-license

    See STIR/LICENSE.txt for details
*/

#ifndef __IndexRange_H__
#define __IndexRange_H__

#include "stir/VectorWithOffset.h"
#include "stir/BasicCoordinate.h"

START_NAMESPACE_STIR

template <int num_dimensions>
class IndexRange : public VectorWithOffset<IndexRange<num_dimensions - 1>>
{
protected:
  typedef VectorWithOffset<IndexRange<num_dimensions - 1>> base_type;

public:
  typedef typename base_type::iterator iterator;
  typedef typename base_type::const_iterator const_iterator;

  inline IndexRange();

  inline IndexRange(const VectorWithOffset<IndexRange<num_dimensions - 1>>& range);

  inline IndexRange(const IndexRange<num_dimensions>& range);

  inline IndexRange(const BasicCoordinate<num_dimensions, int>& min, const BasicCoordinate<num_dimensions, int>& max);

  inline IndexRange(const BasicCoordinate<num_dimensions, int>& sizes);

  inline size_t size_all() const;

  // these are derived from VectorWithOffset
  //  TODO these should be overloaded, to set regular_range as well.
  /*
  const IndexRange<num_dimensions-1>& operator[](int i) const
  { return range[i]; }

  IndexRange<num_dimensions-1>& operator[](int i)
  { return range[i]; }
  */

  inline bool operator==(const IndexRange<num_dimensions>&) const;
  inline bool operator!=(const IndexRange<num_dimensions>&) const;

  inline bool is_regular() const;

  bool get_regular_range(BasicCoordinate<num_dimensions, int>& min, BasicCoordinate<num_dimensions, int>& max) const;

private:
  enum is_regular_type
  {
    regular_true,
    regular_false,
    regular_to_do
  };

  mutable is_regular_type is_regular_range;
};

template <>
class IndexRange<1>
{
public:
  inline IndexRange();
  inline IndexRange(const int min, const int max);

  inline IndexRange(const BasicCoordinate<1, int>& min, const BasicCoordinate<1, int>& max);

  inline IndexRange(const int length);
  inline IndexRange(const BasicCoordinate<1, int>& size);

  inline int get_min_index() const;
  inline int get_max_index() const;
  inline int get_length() const;
  inline size_t size_all() const;

  inline bool operator==(const IndexRange<1>& range2) const;

  inline bool is_regular() const;

  inline bool get_regular_range(BasicCoordinate<1, int>& min, BasicCoordinate<1, int>& max) const;
  inline void resize(const int min_index, const int max_index);

private:
  int min;
  int max;
};

END_NAMESPACE_STIR

#include "stir/IndexRange.inl"

#endif