DiscreteRange.inl

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2026.  All rights reserved
 */
#include "Stroika/Foundation/Debug/Assertions.h"
#include "Stroika/Foundation/Memory/BlockAllocated.h"
 
namespace Stroika::Foundation::Traversal {
 
    /*
     ********************************************************************************
     ***************** DiscreteRange<T, TRAITS>::MyIteratorRep_ *********************
     ********************************************************************************
     */
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    struct DiscreteRange<T, TRAITS>::MyIteratorRep_ : Iterator<T>::IRep, public Memory::UseBlockAllocationIfAppropriate<MyIteratorRep_> {
        using inherited = typename Iterator<T>::IRep;
        T    fCur;
        T    fEnd;
        bool fAtEnd;
        MyIteratorRep_ ()
            : fCur{TRAITS::kLowerBound}
            , fEnd{TRAITS::kLowerBound}
            , fAtEnd{true}
        {
        }
        MyIteratorRep_ (T start, T end)
            : fCur{start}
            , fEnd{end}
            , fAtEnd{false}
        {
        }
        bool AtEnd () const override
        {
            return fAtEnd;
        }
        optional<T> Current () const override
        {
            if (fAtEnd) {
                return nullopt;
            }
            else {
                return fCur;
            }
        }
        virtual optional<T> More () override
        {
            Require (not fAtEnd);
            if (fCur == fEnd) {
                fAtEnd = true;
            }
            else {
                fCur = TRAITS::GetNext (fCur);
            }
            if (not fAtEnd) {
                return fCur;
            }
            return nullopt;
        }
        virtual bool Equals ([[maybe_unused]] const typename Iterator<T>::IRep* rhs) const override
        {
            RequireNotNull (rhs);
            AssertNotImplemented ();
            return false;
        }
        virtual unique_ptr<typename Iterator<T>::IRep> Clone () const override
        {
            unique_ptr<MyIteratorRep_> tmp = make_unique<MyIteratorRep_> (fCur, fEnd);
            tmp->fAtEnd                    = fAtEnd;
            return tmp;
        }
    };
 
    /*
     ********************************************************************************
     ***************** DiscreteRange<T, TRAITS>::MyIterable_ ************************
     ********************************************************************************
     */
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    struct DiscreteRange<T, TRAITS>::MyIterable_ : Iterable<T> {
        struct MyRep_ : Iterable<T>::_IRep, public Memory::UseBlockAllocationIfAppropriate<MyRep_> {
            using inherited = typename Iterable<T>::_IRep;
            T    fStart;
            T    fEnd;
            bool fForcedEnd;
            MyRep_ ()
                : fStart{TRAITS::kLowerBound}
                , fEnd{TRAITS::kLowerBound}
                , fForcedEnd{true}
            {
            }
            MyRep_ (T start, T end)
                : fStart{start}
                , fEnd{end}
                , fForcedEnd{false}
            {
            }
            virtual shared_ptr<typename Iterable<T>::_IRep> Clone () const override
            {
                return Memory::MakeSharedPtr<MyRep_> (*this);
            }
            virtual Iterator<T> MakeIterator () const override
            {
                if (fForcedEnd) {
                    return Iterator<T>{make_unique<DiscreteRange::MyIteratorRep_> ()};
                }
                else {
                    return Iterator<T>{make_unique<DiscreteRange::MyIteratorRep_> (fStart, fEnd)};
                }
            }
            virtual size_t size () const override
            {
                using SignedDifferenceType = typename TRAITS::SignedDifferenceType;
                if (fForcedEnd) {
                    return TRAITS::DifferenceToSizeT (SignedDifferenceType{0});
                }
                else {
                    return TRAITS::DifferenceToSizeT (SignedDifferenceType{1} + DiscreteRange{fStart, fEnd}.GetDistanceSpanned ());
                }
            }
            virtual bool empty () const override
            {
                if (fForcedEnd) {
                    return true;
                }
                else {
                    return false;
                    //return fStart == fEnd;
                }
            }
        };
        MyIterable_ ()
            : Iterable<T>{Memory::MakeSharedPtr<MyRep_> ()}
        {
        }
        MyIterable_ (T start, T end)
            : Iterable<T>{Memory::MakeSharedPtr<MyRep_> (start, end)}
        {
        }
    };
 
    /*
     ********************************************************************************
     ***************************** DiscreteRange<T> *********************************
     ********************************************************************************
     */
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    constexpr DiscreteRange<T, TRAITS>::DiscreteRange (T begin, T end)
        : inherited{begin, end}
    {
        Require (begin <= end);
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    constexpr DiscreteRange<T, TRAITS>::DiscreteRange (const optional<T>& begin, const optional<T>& end)
        : inherited{begin, end}
    {
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    constexpr DiscreteRange<T, TRAITS>::DiscreteRange (const Range<T, TRAITS>& r)
    {
        // Could do more efficiently
        if (not r.empty ()) {
            Require (r.GetLowerBoundOpenness () == Openness::eClosed);
            Require (r.GetUpperBoundOpenness () == Openness::eClosed);
            *this = DiscreteRange{r.GetLowerBound (), r.GetUpperBound ()};
        }
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    constexpr DiscreteRange<T, TRAITS> DiscreteRange<T, TRAITS>::FullRange ()
    {
        return DiscreteRange{TRAITS::kLowerBound, TRAITS::kUpperBound};
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    constexpr Range<T, TRAITS> DiscreteRange<T, TRAITS>::Intersection (const Range<T, TRAITS>& rhs) const
    {
        return inherited::Intersection (rhs);
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    constexpr DiscreteRange<T, TRAITS> DiscreteRange<T, TRAITS>::Intersection (const DiscreteRange& rhs) const
    {
        return DiscreteRange{inherited::Intersection (rhs)};
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    constexpr Range<T, TRAITS> DiscreteRange<T, TRAITS>::UnionBounds (const Range<T, TRAITS>& rhs) const
    {
        return inherited::UnionBounds (rhs);
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    constexpr DiscreteRange<T, TRAITS> DiscreteRange<T, TRAITS>::UnionBounds (const DiscreteRange& rhs) const
    {
        auto r = inherited::UnionBounds (rhs);
        return DiscreteRange{r.GetLowerBound (), r.GetUpperBound ()};
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    constexpr typename DiscreteRange<T, TRAITS>::UnsignedDifferenceType DiscreteRange<T, TRAITS>::GetNumberOfContainedPoints () const
    {
        if (this->empty ()) {
            return 0;
        }
        else {
            return this->GetDistanceSpanned () + 1;
        }
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    constexpr auto DiscreteRange<T, TRAITS>::Offset (SignedDifferenceType o) const -> DiscreteRange
    {
        Require (not this->empty ());
        return inherited::Offset (o);
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    Iterable<T> DiscreteRange<T, TRAITS>::Elements () const
    {
        return this->empty () ? MyIterable_{} : MyIterable_{this->GetLowerBound (), this->GetUpperBound ()};
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    inline DiscreteRange<T, TRAITS>::operator Iterable<T> () const
    {
        return Elements ();
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    Iterator<T> DiscreteRange<T, TRAITS>::begin () const
    {
        if (this->empty ()) {
            return Iterator<T>::GetEmptyIterator ();
        }
        else {
            return Iterator<T>{make_unique<MyIteratorRep_> (this->GetLowerBound (), this->GetUpperBound ())};
        }
    }
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    inline Iterator<T> DiscreteRange<T, TRAITS>::end () const
    {
        return Iterator<T>::GetEmptyIterator ();
    }
 
    /*
     ********************************************************************************
     *********************************** operator^ **********************************
     ********************************************************************************
     */
    template <IDiscreteRangeable T, IDiscreteRangeableTraits<T> TRAITS>
    inline DiscreteRange<T, TRAITS> operator^ (const DiscreteRange<T, TRAITS>& lhs, const DiscreteRange<T, TRAITS>& rhs)
    {
        return lhs.Intersection (rhs);
    }
 
}