GA_RTIIndex.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_RTIIndex.h ( GA Library, C++)
 *
 * COMMENTS:    This is like the "Python" range function.  That is, the end is
 *              non-inclusive:
 *                      GA_RTIIndex(list, 0, 3) = [0, 1, 2]
 */

#ifndef __GA_RTIIndex__
#define __GA_RTIIndex__

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


class GA_IndexMap;
class GA_IteratorState;
class GA_Range;
class GA_RangeTypeInterface;


class GA_API GA_RTIIndex : public GA_RTISingle 
{
public:
    /// Iterate over the entire range of elements (in order)
    GA_RTIIndex(GA_IndexMap &list);
    GA_RTIIndex(const GA_IndexMap &list);

    /// Specify a single element by index
    GA_RTIIndex(GA_IndexMap &list, GA_Index singleton);
    GA_RTIIndex(const GA_IndexMap &list, GA_Index singleton);

    /// Iterate over a range of elements, passing a negative step will iterate
    /// backward over the range (in this case end should be < start).
    GA_RTIIndex(GA_IndexMap &list, GA_Index start, GA_Index end,
                          GA_Size step=1);
    GA_RTIIndex(const GA_IndexMap &list, GA_Index start, GA_Index end,
                          GA_Size step=1);

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

    /// Destructor
    ~GA_RTIIndex() 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;
    void        iterateRewind(GA_IteratorState &state,
                              GA_Offset &start, GA_Offset &end) const override;
    void        iterateNext(GA_IteratorState &state,
                            GA_Offset &start, GA_Offset &end) const override;
    bool        isOrdered() const override;
    bool        areTraversalDeletionsSafe() const override { return true; }
    bool        canContainDuplicates() const override { return false; }
    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;
    /// @}
    void        init(GA_Size start, GA_Size end, GA_Size step);

    GA_Index    myStart, myEnd;
    GA_Size     myStep;
};

#endif