range.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2000-2022 Inria
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation
 *  and/or other materials provided with the distribution.
 *  * Neither the name of the ALICE Project-Team nor the names of its
 *  contributors may be used to endorse or promote products derived from this
 *  software without specific prior written permission.
 * 
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 *  Contact: Bruno Levy
 *
 *     https://www.inria.fr/fr/bruno-levy
 *
 *     Inria,
 *     Domaine de Voluceau,
 *     78150 Le Chesnay - Rocquencourt
 *     FRANCE
 *
 */
 
#ifndef GEOGRAM_BASIC_RANGE
#define GEOGRAM_BASIC_RANGE
 
#include <geogram/basic/numeric.h>
#include <geogram/basic/memory.h>
#include <geogram/basic/assert.h>
#include <geogram/basic/argused.h>
 
namespace GEO {
 
    class index_as_iterator {
      public:
        index_as_iterator(index_t val) : val_(val) {
        }
 
        void operator++() {
            ++val_;
        }
   
        bool operator==(index_as_iterator rhs) {
            return val_ == rhs.val_;
        }
 
        bool operator!=(index_as_iterator rhs) {
            return val_ != rhs.val_;
        }
 
        bool operator<(index_as_iterator rhs) {
            return val_ < rhs.val_;
        }
 
        index_t operator*() const  {
            return val_;
        }
 
        index_t operator-(index_as_iterator it) const {
            return val_ - it.val_;
        }
 
        index_as_iterator operator+(index_t i) const {
            return index_as_iterator(val_ + i);
        }
        
      private:
        index_t val_;
    };
 
    class index_range {
      public:
        
        typedef index_as_iterator iterator;
        typedef index_as_iterator const_iterator;
        
        index_range(index_as_iterator b, index_as_iterator e) : begin_(b), end_(e) {
        }
 
        index_as_iterator begin() const {
            return begin_;
        }
 
        index_as_iterator end() const {
            return end_;
        }
 
        index_t nb() const {
            return end_ - begin_;
        }
 
        index_t operator[](index_t i) const {
            geo_debug_assert(i < nb());
            return *(begin_ + i);
        }
        
      private:
        index_as_iterator begin_;
        index_as_iterator end_;
    };
 
    /*************************************************************************/
    
    class const_index_ptr_in_array {
      public:
        const_index_ptr_in_array(
            const index_t* ptr, const index_t* begin, const index_t* end
        ) : ptr_(ptr)
#ifdef GEO_DEBUG
          ,begin_(begin),
           end_(end)
#endif
        {
            geo_argused(begin);
            geo_argused(end);
        }
 
        void operator++() {
            ++ptr_;
        }
   
        bool operator==(const_index_ptr_in_array rhs) {
            return ptr_ == rhs.ptr_;
        }
 
        bool operator!=(const_index_ptr_in_array rhs) {
            return ptr_ != rhs.ptr_;
        }
 
        bool operator<(const_index_ptr_in_array rhs) {
            return ptr_ < rhs.ptr_;
        }
 
        const index_t& operator*() const  {
            geo_debug_assert(ptr_ >= begin_ && ptr_ < end_);            
            return *ptr_;
        }
 
        index_t operator-(const_index_ptr_in_array it) const {
            return index_t(ptr_ - it.ptr_);
        }
 
        const_index_ptr_in_array operator+(index_t i) const {
#ifdef GEO_DEBUG            
            return const_index_ptr_in_array(ptr_ + i, begin_, end_);
#else
            return const_index_ptr_in_array(ptr_ + i, nullptr, nullptr);
#endif            
        }
 
      private:
        const index_t* ptr_;
#ifdef GEO_DEBUG
        const index_t* begin_;
        const index_t* end_;        
#endif
    };
 
    /*************************************************************************/
 
    class index_ptr_in_array {
      public:
        index_ptr_in_array(
            index_t* ptr, index_t* begin, index_t* end
        ) : ptr_(ptr)
#ifdef GEO_DEBUG
          ,begin_(begin),
           end_(end)
#endif
        {
            geo_argused(begin);
            geo_argused(end);
        }
 
        void operator++() {
            ++ptr_;
        }
   
        bool operator==(index_ptr_in_array rhs) {
            return ptr_ == rhs.ptr_;
        }
 
        bool operator!=(index_ptr_in_array rhs) {
            return ptr_ != rhs.ptr_;
        }
 
        bool operator<(index_ptr_in_array rhs) {
            return ptr_ < rhs.ptr_;
        }
 
        const index_t& operator*() const  {
            geo_debug_assert(ptr_ >= begin_ && ptr_ < end_);            
            return *ptr_;
        }
 
        index_t& operator*() {
            geo_debug_assert(ptr_ >= begin_ && ptr_ < end_);            
            return *ptr_;
        }
        
        index_t operator-(index_ptr_in_array it) const {
            return index_t(ptr_ - it.ptr_);
        }
 
        index_ptr_in_array operator+(index_t i) const {
#ifdef GEO_DEBUG            
            return index_ptr_in_array(ptr_ + i, begin_, end_);
#else
            return index_ptr_in_array(ptr_ + i, nullptr, nullptr);
#endif            
        }
 
        operator const_index_ptr_in_array() const {
#ifdef GEO_DEBUG                      
            return const_index_ptr_in_array(ptr_, begin_, end_);
#else
            return const_index_ptr_in_array(ptr_, nullptr, nullptr);
#endif            
        }
        
      private:
        index_t* ptr_;
#ifdef GEO_DEBUG
        index_t* begin_;
        index_t* end_;        
#endif
    };
 
    /*************************************************************************/
 
    class index_ptr_range {
    public:
        typedef index_ptr_in_array iterator;
        typedef const_index_ptr_in_array const_iterator;
 
        index_ptr_range(index_t* begin, index_t* end) :
            begin_(begin, begin, end),
            end_(end,begin,end) {
        }
 
        index_ptr_range(vector<index_t>& V, index_t b, index_t e) :
            begin_(V.data()+b, V.data() + b, V.data() + e),
            end_(V.data()+e, V.data() + b, V.data() + e) {
        }
 
        iterator begin() {
            return begin_;
        }
 
        iterator end() {
            return end_;
        }
 
        const_iterator begin() const {
            return begin_;
        }
 
        const_iterator end() const {
            return end_;
        }
        
    private:
        iterator begin_;
        iterator end_;
    };
 
    /*************************************************************************/
 
    class const_index_ptr_range {
    public:
        typedef const_index_ptr_in_array iterator;
        typedef const_index_ptr_in_array const_iterator;
 
        const_index_ptr_range(const index_t* begin, const index_t* end) :
            begin_(begin, begin, end),
            end_(end,begin,end) {
        }
 
        const_index_ptr_range(const vector<index_t>& V, index_t b, index_t e) :
            begin_(V.data()+b, V.data() + b, V.data() + e),
            end_(V.data()+e, V.data() + b, V.data() + e) {
        }
 
        const_iterator begin() const {
            return begin_;
        }
 
        const_iterator end() const {
            return end_;
        }
        
    private:
        const_iterator begin_;
        const_iterator end_;
    };
 
    /***********************************************************************/
    
}
 
#endif