Audacity 3.2.0
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
GraphicsDataCacheIterator< CacheElementType > Class Template Referencefinal

A class that implements an iterator for the cache lookup result. More...

#include <GraphicsDataCache.h>

Collaboration diagram for GraphicsDataCacheIterator< CacheElementType >:
[legend]

Public Types

using iterator_category = std::forward_iterator_tag
 
using difference_type = std::ptrdiff_t
 
using value_type = CacheElementType
 
using pointer = value_type *
 
using reference = value_type &
 

Public Member Functions

 GraphicsDataCacheIterator ()=default
 
 GraphicsDataCacheIterator (const GraphicsDataCacheIterator &)=default
 
 GraphicsDataCacheIterator (GraphicsDataCacheIterator &&)=default
 
GraphicsDataCacheIterator & operator= (const GraphicsDataCacheIterator &)=default
 
GraphicsDataCacheIterator & operator= (GraphicsDataCacheIterator &&)=default
 
reference operator* () const
 
pointer operator-> ()
 
GraphicsDataCacheIterator & operator++ ()
 
GraphicsDataCacheIterator operator++ (int)
 
size_t GetLeftOffset () const
 
size_t GetRightOffset () const
 

Private Member Functions

 GraphicsDataCacheIterator (const GraphicsDataCacheBase::BaseLookupResult &base, bool begin)
 

Private Attributes

GraphicsDataCacheBase::BaseLookupResult mBaseLookup
 
GraphicsDataCacheBase::Lookup::const_iterator mIterator
 

Friends

template<typename T >
class GraphicsDataCache
 
bool operator== (const GraphicsDataCacheIterator &lhs, const GraphicsDataCacheIterator &rhs)
 
bool operator!= (const GraphicsDataCacheIterator &lhs, const GraphicsDataCacheIterator &rhs)
 

Detailed Description

template<typename CacheElementType>
class GraphicsDataCacheIterator< CacheElementType >

A class that implements an iterator for the cache lookup result.

Definition at line 148 of file GraphicsDataCache.h.

Member Typedef Documentation

◆ difference_type

template<typename CacheElementType >
using GraphicsDataCacheIterator< CacheElementType >::difference_type = std::ptrdiff_t

Definition at line 152 of file GraphicsDataCache.h.

◆ iterator_category

template<typename CacheElementType >
using GraphicsDataCacheIterator< CacheElementType >::iterator_category = std::forward_iterator_tag

Definition at line 151 of file GraphicsDataCache.h.

◆ pointer

template<typename CacheElementType >
using GraphicsDataCacheIterator< CacheElementType >::pointer = value_type*

Definition at line 154 of file GraphicsDataCache.h.

◆ reference

template<typename CacheElementType >
using GraphicsDataCacheIterator< CacheElementType >::reference = value_type&

Definition at line 155 of file GraphicsDataCache.h.

◆ value_type

template<typename CacheElementType >
using GraphicsDataCacheIterator< CacheElementType >::value_type = CacheElementType

Definition at line 153 of file GraphicsDataCache.h.

Constructor & Destructor Documentation

◆ GraphicsDataCacheIterator() [1/4]

template<typename CacheElementType >
GraphicsDataCacheIterator< CacheElementType >::GraphicsDataCacheIterator ( )
default

◆ GraphicsDataCacheIterator() [2/4]

template<typename CacheElementType >
GraphicsDataCacheIterator< CacheElementType >::GraphicsDataCacheIterator ( const GraphicsDataCacheIterator< CacheElementType > &  )
default

◆ GraphicsDataCacheIterator() [3/4]

template<typename CacheElementType >
GraphicsDataCacheIterator< CacheElementType >::GraphicsDataCacheIterator ( GraphicsDataCacheIterator< CacheElementType > &&  )
default

◆ GraphicsDataCacheIterator() [4/4]

template<typename CacheElementType >
GraphicsDataCacheIterator< CacheElementType >::GraphicsDataCacheIterator ( const GraphicsDataCacheBase::BaseLookupResult &  base,
bool  begin 
)
inlineprivate

Definition at line 215 of file GraphicsDataCache.h.

217 : mBaseLookup(base)
218 , mIterator(begin ? base.Begin : base.End)
219 {
220 }
GraphicsDataCacheIterator::mBaseLookup
GraphicsDataCacheBase::BaseLookupResult mBaseLookup
Definition: GraphicsDataCache.h:222
GraphicsDataCacheIterator::mIterator
GraphicsDataCacheBase::Lookup::const_iterator mIterator
Definition: GraphicsDataCache.h:223
details::begin
const char * begin(const char *str) noexcept
Definition: StringUtils.h:101
GraphicsDataCacheBase::BaseLookupResult::Begin
Lookup::iterator Begin
Iterator to the first cache element that fulfills the request.
Definition: GraphicsDataCache.h:89
GraphicsDataCacheBase::BaseLookupResult::End
Lookup::iterator End
Iterator past the last cache element that fulfills the request.
Definition: GraphicsDataCache.h:91

Member Function Documentation

◆ GetLeftOffset()

template<typename CacheElementType >
size_t GraphicsDataCacheIterator< CacheElementType >::GetLeftOffset ( ) const
inline

Definition at line 187 of file GraphicsDataCache.h.

188 {
189 return mIterator == mBaseLookup.Begin ? mBaseLookup.LeftOffset : 0;
190 }
GraphicsDataCacheBase::BaseLookupResult::LeftOffset
size_t LeftOffset
First column of the first element that matches the request.
Definition: GraphicsDataCache.h:93

References GraphicsDataCacheBase::BaseLookupResult::Begin, GraphicsDataCacheBase::BaseLookupResult::LeftOffset, GraphicsDataCacheIterator< CacheElementType >::mBaseLookup, and GraphicsDataCacheIterator< CacheElementType >::mIterator.

◆ GetRightOffset()

template<typename CacheElementType >
size_t GraphicsDataCacheIterator< CacheElementType >::GetRightOffset ( ) const
inline

Definition at line 192 of file GraphicsDataCache.h.

193 {
194 auto next = mIterator;
195 ++next;
196
197 return next == mBaseLookup.End ? mBaseLookup.RightOffset : 0;
198 }
GraphicsDataCacheBase::BaseLookupResult::RightOffset
size_t RightOffset
Offset from the right for the last element that matches the request.
Definition: GraphicsDataCache.h:95

References GraphicsDataCacheBase::BaseLookupResult::End, GraphicsDataCacheIterator< CacheElementType >::mBaseLookup, GraphicsDataCacheIterator< CacheElementType >::mIterator, and GraphicsDataCacheBase::BaseLookupResult::RightOffset.

◆ operator*()

template<typename CacheElementType >
reference GraphicsDataCacheIterator< CacheElementType >::operator* ( ) const
inline

Definition at line 163 of file GraphicsDataCache.h.

164 {
165 return static_cast<reference>(*mIterator->Data);
166 }

References GraphicsDataCacheIterator< CacheElementType >::mIterator.

◆ operator++() [1/2]

template<typename CacheElementType >
GraphicsDataCacheIterator & GraphicsDataCacheIterator< CacheElementType >::operator++ ( )
inline

Definition at line 173 of file GraphicsDataCache.h.

174 {
175 mIterator++;
176 return *this;
177 }

References GraphicsDataCacheIterator< CacheElementType >::mIterator.

◆ operator++() [2/2]

template<typename CacheElementType >
GraphicsDataCacheIterator GraphicsDataCacheIterator< CacheElementType >::operator++ ( int  )
inline

Definition at line 180 of file GraphicsDataCache.h.

181 {
182 GraphicsDataCacheIterator tmp = *this;
183 ++(*this);
184 return tmp;
185 }
GraphicsDataCacheIterator
A class that implements an iterator for the cache lookup result.
Definition: GraphicsDataCache.h:149

◆ operator->()

template<typename CacheElementType >
pointer GraphicsDataCacheIterator< CacheElementType >::operator-> ( )
inline

Definition at line 167 of file GraphicsDataCache.h.

168 {
169 return static_cast<pointer>(mIterator->Data);
170 }

References GraphicsDataCacheIterator< CacheElementType >::mIterator.

◆ operator=() [1/2]

template<typename CacheElementType >
GraphicsDataCacheIterator & GraphicsDataCacheIterator< CacheElementType >::operator= ( const GraphicsDataCacheIterator< CacheElementType > &  )
default

◆ operator=() [2/2]

template<typename CacheElementType >
GraphicsDataCacheIterator & GraphicsDataCacheIterator< CacheElementType >::operator= ( GraphicsDataCacheIterator< CacheElementType > &&  )
default

Friends And Related Function Documentation

◆ GraphicsDataCache

template<typename CacheElementType >
template<typename T >
friend class GraphicsDataCache
friend

Definition at line 226 of file GraphicsDataCache.h.

◆ operator!=

template<typename CacheElementType >
bool operator!= ( const GraphicsDataCacheIterator< CacheElementType > &  lhs,
const GraphicsDataCacheIterator< CacheElementType > &  rhs 
)
friend

Definition at line 207 of file GraphicsDataCache.h.

210 {
211 return lhs.mIterator != rhs.mIterator;
212 };

◆ operator==

template<typename CacheElementType >
bool operator== ( const GraphicsDataCacheIterator< CacheElementType > &  lhs,
const GraphicsDataCacheIterator< CacheElementType > &  rhs 
)
friend

Definition at line 200 of file GraphicsDataCache.h.

203 {
204 return lhs.mIterator == rhs.mIterator;
205 };

Member Data Documentation

◆ mBaseLookup

template<typename CacheElementType >
GraphicsDataCacheBase::BaseLookupResult GraphicsDataCacheIterator< CacheElementType >::mBaseLookup
private

Definition at line 222 of file GraphicsDataCache.h.

Referenced by GraphicsDataCacheIterator< CacheElementType >::GetLeftOffset(), and GraphicsDataCacheIterator< CacheElementType >::GetRightOffset().

◆ mIterator

template<typename CacheElementType >
GraphicsDataCacheBase::Lookup::const_iterator GraphicsDataCacheIterator< CacheElementType >::mIterator
private

Definition at line 223 of file GraphicsDataCache.h.

Referenced by GraphicsDataCacheIterator< CacheElementType >::GetLeftOffset(), GraphicsDataCacheIterator< CacheElementType >::GetRightOffset(), GraphicsDataCacheIterator< CacheElementType >::operator*(), GraphicsDataCacheIterator< CacheElementType >::operator++(), and GraphicsDataCacheIterator< CacheElementType >::operator->().

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.3