GA_RTIOrderedRange.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        GA_RTIOrderedRange.h ( GA Library, C++)
 *
 * COMMENTS:    This is an RTI class that sorts and orders another RTI for
 *              iteration or traversal.
 */

#ifndef __GA_RTIOrderedRange__
#define __GA_RTIOrderedRange__

#include "GA_API.h"
#include "GA_OffsetList.h"
#include "GA_RTISingle.h"
#include "GA_Types.h"

class GA_IteratorState;
class GA_Range;
class GA_RangeTypeInterface;


class GA_API GA_RTIOrderedRange : public GA_RTISingle 
{
public:
    /// Iterate over the source range but in order.
    /// @param  descending  If true, the index order is going to be in
    ///             a descending order. If false, it's ascending.
    GA_RTIOrderedRange(const GA_RangeTypeInterface &src, 
                       bool descending = false);

    /// Copy constructor
    GA_RTIOrderedRange(const GA_RTIOrderedRange &src);

    /// Destructor
    ~GA_RTIOrderedRange() override;

    /// @{
    /// RangeTypeInterface implementation
    GA_RangeTypeInterface       *copy() const override;
    bool        isSplittable() const override   { return false; }
    bool        isEmpty() const override;
    GA_Size     getMaxEntries() const override;
    GA_Size     getEntries() const override;
    bool        split(GA_RangeTypeInterface *list[2]) const override;
    bool        isEqual(const GA_RangeTypeInterface &src) const override;
    void        iterateCopy(GA_IteratorState &dest,
                            const GA_IteratorState &src) const override;
    bool        isOrdered() const override;
    bool        areTraversalDeletionsSafe() const override { return true; }
    GA_Size     getPageCount() const override   { return -1; }
    bool        getPageElementRange(GA_Range &, GA_Size, GA_Size) const override
                            { return getPageElementRangeNonSplittable(); }
    GA_Offset   getFirstOffsetInPage(GA_Size) const override
                            { return getFirstOffsetInPageNonSplittable(); }
    /// @}

private:
    /// @{
    /// RangeTypeInterface implementation
    void        singleRewind(GA_IteratorState &state) const override;
    bool        singleGet(const GA_IteratorState &state,
                        GA_Offset &value) const override;
    void        singleNext(GA_IteratorState &state) const override;
    /// @}

    /// Initialize the ordered range object.
    void                init(const GA_RangeTypeInterface &src,
                             bool descending = false);

    /// Finds an index that has a valid offset that is equal or greater
    /// than the index given by the argument. Returns -1 if no such valid 
    /// index can be found.
    GA_Size             findValidOffsetIndexAtOrAfter(GA_Size index) const;

    /// The array that contains a permutation of offsets that orders
    /// them according to the index 
    GA_OffsetList       myOffsetOrder;

    /// The iteration step, usually +1 or -1 to indicate traversal direction.
    int                 myStep;
};

#endif