EIC code displayed by LXR master/​include/​corecel/​cont/​Range.hh	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 09:54:46

 //---------------------------------*-C++-*-----------------------------------//
 // Copyright 2020-2024 UT-Battelle, LLC, and other Celeritas developers.
 // See the top-level COPYRIGHT file for details.
 // SPDX-License-Identifier: (Apache-2.0 OR MIT)
 //---------------------------------------------------------------------------//
 //! \file corecel/cont/Range.hh
 //---------------------------------------------------------------------------//
 #pragma once
 
 #include "detail/RangeImpl.hh"
 
 namespace celeritas
 {
 //---------------------------------------------------------------------------//
 /*!
  * \fn range
  * \tparam T Value type to iterate over
  * Get iterators over a range of values, or a semi-infinite range.
  *
  * \par Code Sample:
  * \code
 
     for (auto i : Range(1, 5))
         cout << i << "\n";
 
     // Range of [0, 10)
     for (auto u : Range(10u))
         cout << u << "\n";
 
     for (auto c : Range('a', 'd'))
         cout << c << "\n";
 
     for (auto i : Count(100).step(-3))
         if (i < 90) break;
         else        cout << i << "\n";
 
  * \endcode
  */
 
 //! Publicly expose traits for countable (OpaqueId, enum, init) type T
 template<class T>
 using RangeIter = detail::range_iter<T>;
 
 //---------------------------------------------------------------------------//
 /*!
  * Proxy container for iterating over a range of integral values.
  *
  * Here, T can be any of:
  * - an integer,
  * - an enum that has contiguous zero-indexed values and a "size_" enumeration
  *   value indicating how many, or
  * - an OpaqueId.
  *
  * It is OK to dereference the end iterator! The result should just be the
  * off-the-end value for the range, e.g. `FooEnum::size_` or `bar.size()`.
  */
 template<class T>
 class Range
 {
     using TraitsT = detail::RangeTypeTraits<T>;
 
   public:
     //!@{
     //! \name Type aliases
     using const_iterator = detail::range_iter<T>;
     using size_type = typename TraitsT::counter_type;
     using value_type = T;
     //@}
 
     template<class U>
     using step_type = typename TraitsT::template common_type<U>;
 
   public:
     //// CONSTRUCTORS ////
 
     //! Empty constructor for empty range
     CELER_CONSTEXPR_FUNCTION Range() : begin_{}, end_{} {}
 
     //! Construct from stop
     CELER_CONSTEXPR_FUNCTION Range(T end) : begin_{}, end_(end) {}
 
     //! Construct from start/stop
     CELER_CONSTEXPR_FUNCTION Range(T begin, T end) : begin_(begin), end_(end)
     {
     }
 
     //// CONTAINER-LIKE ACCESS ////
 
     //!@{
     //! Iterators
     CELER_CONSTEXPR_FUNCTION const_iterator begin() const { return begin_; }
     CELER_CONSTEXPR_FUNCTION const_iterator cbegin() const { return begin_; }
     CELER_CONSTEXPR_FUNCTION const_iterator end() const { return end_; }
     CELER_CONSTEXPR_FUNCTION const_iterator cend() const { return end_; }
     //!@}
 
     //! Array-like access
     CELER_CONSTEXPR_FUNCTION value_type operator[](size_type i) const
     {
         return *(begin_ + i);
     }
 
     //! Number of elements
     CELER_CONSTEXPR_FUNCTION size_type size() const
     {
         return TraitsT::to_counter(*end_) - TraitsT::to_counter(*begin_);
     }
 
     //! Whether the range has no elements
     CELER_CONSTEXPR_FUNCTION bool empty() const { return begin_ == end_; }
 
     //! First item in the range
     CELER_CONSTEXPR_FUNCTION value_type front() const { return *begin_; }
 
     //! Last item in the range
     CELER_CONSTEXPR_FUNCTION value_type back() const
     {
         return (*this)[this->size() - 1];
     }
 
     //// STRIDED ACCESS ////
 
     //! Return a stepped range using a *signed* integer type
     template<class U, std::enable_if_t<std::is_signed<U>::value, bool> = true>
     CELER_CONSTEXPR_FUNCTION detail::StepRange<step_type<U>> step(U step)
     {
         if (step < 0)
         {
             return {TraitsT::increment(*end_, step), *begin_, step};
         }
 
         return {*begin_, *end_, step};
     }
 
     //! \cond
     //! Return a stepped range using an *unsigned* integer type
     template<class U, std::enable_if_t<std::is_unsigned<U>::value, bool> = true>
     CELER_CONSTEXPR_FUNCTION detail::StepRange<step_type<U>> step(U step)
     {
         return {*begin_, *end_, static_cast<size_type>(step)};
     }
     //! \endcond
 
   private:
     const_iterator begin_;
     const_iterator end_;
 };
 
 //---------------------------------------------------------------------------//
 /*!
  * Proxy container for an unbounded range with a given start value.
  */
 template<class T>
 class Count
 {
     using TraitsT = detail::RangeTypeTraits<T>;
 
   public:
     //!@{
     //! \name Type aliases
     using const_iterator = detail::inf_range_iter<T>;
     using size_type = typename TraitsT::counter_type;
     using value_type = T;
     //@}
 
     CELER_CONSTEXPR_FUNCTION Count() : begin_{} {}
     CELER_CONSTEXPR_FUNCTION Count(T begin) : begin_(begin) {}
 
     CELER_CONSTEXPR_FUNCTION detail::InfStepRange<T> step(T step)
     {
         return {*begin_, step};
     }
 
     CELER_CONSTEXPR_FUNCTION const_iterator begin() const { return begin_; }
     CELER_CONSTEXPR_FUNCTION const_iterator end() const
     {
         return const_iterator();
     }
     CELER_CONSTEXPR_FUNCTION bool empty() const { return false; }
 
   private:
     const_iterator begin_;
 };
 
 //---------------------------------------------------------------------------//
 /*!
  * Return a range over fixed beginning and end values.
  */
 template<class T>
 CELER_CONSTEXPR_FUNCTION Range<T> range(T begin, T end)
 {
     return {begin, end};
 }
 
 //---------------------------------------------------------------------------//
 /*!
  * Return a range with the default start value (0 for numeric types)
  */
 template<class T>
 CELER_CONSTEXPR_FUNCTION Range<T> range(T end)
 {
     return {end};
 }
 
 //---------------------------------------------------------------------------//
 /*!
  * Count upward from zero.
  */
 template<class T>
 CELER_CONSTEXPR_FUNCTION Count<T> count()
 {
     return {};
 }
 
 //---------------------------------------------------------------------------//
 /*!
  * Count upward from a value.
  */
 template<class T>
 CELER_CONSTEXPR_FUNCTION Count<T> count(T begin)
 {
     return {begin};
 }
 
 //---------------------------------------------------------------------------//
 }  // namespace celeritas

This page was automatically generated by the 2.3.7 LXR engine. The LXR team