array.hpp

Go to the documentation of this file.

//==-------- array.hpp --- SYCL common iteration object --------------------==//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
 
#pragma once
 
#include <sycl/detail/defines_elementary.hpp> // for __SYCL_ALWAYS_INLINE
#include <sycl/detail/pi.h>                   // for PI_ERROR_INVALID_VALUE
#include <sycl/exception.hpp>                 // for invalid_parameter_error
 
#include <stddef.h>    // for size_t
#include <type_traits> // for enable_if_t
 
namespace sycl {
inline namespace _V1 {
template <int dimensions> class id;
template <int dimensions> class range;
namespace detail {
 
template <int dimensions = 1> class array {
  static_assert(dimensions >= 1, "Array cannot be 0-dimensional.");
 
public:
  /* The following constructor is only available in the array struct
   * specialization where: dimensions==1 */
  template <int N = dimensions>
  array(typename std::enable_if_t<(N == 1), size_t> dim0 = 0)
      : common_array{dim0} {}
 
  /* The following constructors are only available in the array struct
   * specialization where: dimensions==2 */
  template <int N = dimensions>
  array(typename std::enable_if_t<(N == 2), size_t> dim0, size_t dim1)
      : common_array{dim0, dim1} {}
 
  template <int N = dimensions, std::enable_if_t<(N == 2), size_t> = 0>
  array() : array(0, 0) {}
 
  /* The following constructors are only available in the array struct
   * specialization where: dimensions==3 */
  template <int N = dimensions>
  array(typename std::enable_if_t<(N == 3), size_t> dim0, size_t dim1,
        size_t dim2)
      : common_array{dim0, dim1, dim2} {}
 
  template <int N = dimensions, std::enable_if_t<(N == 3), size_t> = 0>
  array() : array(0, 0, 0) {}
 
  // Conversion operators to derived classes
  operator sycl::id<dimensions>() const {
    sycl::id<dimensions> result;
    for (int i = 0; i < dimensions; ++i) {
      result[i] = common_array[i];
    }
    return result;
  }
 
  size_t get(int dimension) const {
    check_dimension(dimension);
    return common_array[dimension];
  }
 
  size_t &operator[](int dimension) {
    check_dimension(dimension);
    return common_array[dimension];
  }
 
  size_t operator[](int dimension) const {
    check_dimension(dimension);
    return common_array[dimension];
  }
 
  array(const array<dimensions> &rhs) = default;
  array(array<dimensions> &&rhs) = default;
  array<dimensions> &operator=(const array<dimensions> &rhs) = default;
  array<dimensions> &operator=(array<dimensions> &&rhs) = default;
 
  // Returns true iff all elements in 'this' are equal to
  // the corresponding elements in 'rhs'.
  bool operator==(const array<dimensions> &rhs) const {
    for (int i = 0; i < dimensions; ++i) {
      if (this->common_array[i] != rhs.common_array[i]) {
        return false;
      }
    }
    return true;
  }
 
  // Returns true iff there is at least one element in 'this'
  // which is not equal to the corresponding element in 'rhs'.
  bool operator!=(const array<dimensions> &rhs) const {
    for (int i = 0; i < dimensions; ++i) {
      if (this->common_array[i] != rhs.common_array[i]) {
        return true;
      }
    }
    return false;
  }
 
protected:
  size_t common_array[dimensions];
  __SYCL_ALWAYS_INLINE void check_dimension(int dimension) const {
#ifndef __SYCL_DEVICE_ONLY__
    if (dimension >= dimensions || dimension < 0) {
      throw sycl::invalid_parameter_error("Index out of range",
                                          PI_ERROR_INVALID_VALUE);
    }
#endif
    (void)dimension;
  }
};
 
} // namespace detail
} // namespace _V1
} // namespace sycl