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

#ifndef __GA_RTIOffset__
#define __GA_RTIOffset__

#include "GA_API.h"
#include "GA_RangeTypeInterface.h"
#include "GA_Types.h"


class GA_IndexMap;
class GA_IteratorState;
class GA_Range;
class GA_RangeMemberQuery;


/// Including temporaries will also include temporary vertex/point indices in
/// the range.  Most ranges are only interested in the visible elements.
/// However, some operations need to be applied to *all* elements.
template <bool IncludeTemporaries>
class GA_RTIOffset_T : public GA_RangeTypeInterface 
{
public:
    // Range containing the entire range of the element list
    GA_RTIOffset_T(const GA_IndexMap &list);

    // Range containing a single element
    GA_RTIOffset_T(const GA_IndexMap &list, GA_Offset singleton);

    // Range of a subset of elements
    GA_RTIOffset_T(const GA_IndexMap &list, GA_Offset start, GA_Offset end);

    // Copy c-tor
    GA_RTIOffset_T(const GA_RTIOffset_T &src);

    ~GA_RTIOffset_T() override;

    /// @{
    /// RangeTypeInterface implementation
    GA_RangeTypeInterface       *copy() const override;
    bool        isSplittable() const override   { return true; }
    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 { return true; }
    bool        areTraversalDeletionsSafe() const override { return true; }
    bool        canContainDuplicates() const override { return false; }
    const GA_RangeMemberQuery   *allocMemberQuery() const override;

    GA_Size     getPageCount() const override;
    bool        getPageElementRange(GA_Range &range,
                    GA_Size relative_page, GA_Size npages) const override;
    GA_Offset   getFirstOffsetInPage(GA_Size relative_page) const override;
    /// @}

private:
    void        init(GA_Size start, GA_Size end);
    void        extractRange(GA_Offset &curr,
                        GA_Offset &start, GA_Offset &end) const;

    // State information
    GA_Offset           myStart, myEnd;
    GA_Size             myComputedSize;
};

typedef GA_RTIOffset_T<false>   GA_RTIOffset;
typedef GA_RTIOffset_T<true>    GA_RTIOffsetComplete;

#endif