Defines a pointer to a specific location in the cache. More...

#include <ringfilecache.H>

Collaboration diagram for RingFileCache< T >::Pointer:

Public Member Functions
	Pointer ()=default

	Pointer (const RingFileCache &cache, const size_t __pos=0)
	Construct a pointer to the current head (oldest item in the cache)

Pointer	operator++ () noexcept
	Prefix increment: advance one position (with wraparound)

Pointer	operator++ (int) noexcept
	Postfix increment: advance one position (with wraparound)

Pointer	operator-- () noexcept
	Prefix decrement: move back one position (with wraparound)

Pointer	operator-- (int) noexcept
	Postfix decrement: move back one position (with wraparound)

Pointer &	operator+= (const long val) noexcept
	Advance by `val` positions (with wraparound)

Pointer &	operator-= (const long val) noexcept
	Move back by `val` positions (with wraparound)

Pointer	operator+ (const long val) const noexcept
	Return a new Pointer advanced by `val` positions.

Pointer	operator- (const long val) const noexcept
	Return a new Pointer moved back by `val` positions.

size_t	get_pos_respect_to_head () const noexcept
	Offset of this pointer relative to the current head of the cache.

size_t	get_pos () const noexcept
	Alias of `get_pos_respect_to_head()`

Private Member Functions
void	validate_position (const size_t pos) const

void	increase_pos (const long delta=1) noexcept

void	decrease_pos (const long delta=1) noexcept

Private Attributes
RingFileCache *	cache_ptr = nullptr

size_t	pos = 0

Friends
class	RingFileCache

Detailed Description

template<typename T>
class RingFileCache< T >::Pointer

Defines a pointer to a specific location in the cache.

Cache entries can be read or written through a pointer object that moves circularly over the storage.

Definition at line 405 of file ringfilecache.H.

Constructor & Destructor Documentation

◆ Pointer() [1/2]

template<typename T >

RingFileCache< T >::Pointer::Pointer ( )

default

◆ Pointer() [2/2]

template<typename T >

RingFileCache< T >::Pointer::Pointer	(	const RingFileCache &	cache,
		const size_t	__pos = `0`
	)

inline

Construct a pointer to the current head (oldest item in the cache)

Parameters

[in]	cache	the cache
[in]	__pos	offset relative to the current head of cache

Definition at line 457 of file ringfilecache.H.

Member Function Documentation

◆ decrease_pos()

template<typename T >

void RingFileCache< T >::Pointer::decrease_pos ( const long delta = 1 )

inlineprivatenoexcept

Definition at line 434 of file ringfilecache.H.

References RingFileCache< T >::Pointer::cache_ptr, RingFileCache< T >::dim, RingFileCache< T >::Pointer::increase_pos(), Aleph::maps(), and RingFileCache< T >::Pointer::pos.

Referenced by RingFileCache< T >::Pointer::increase_pos(), RingFileCache< T >::Pointer::operator--(), RingFileCache< T >::Pointer::operator--(), and RingFileCache< T >::Pointer::operator-=().

◆ get_pos()

template<typename T >

size_t RingFileCache< T >::Pointer::get_pos ( ) const

inlinenoexcept

Alias of get_pos_respect_to_head()

Definition at line 531 of file ringfilecache.H.

References RingFileCache< T >::Pointer::get_pos_respect_to_head().

◆ get_pos_respect_to_head()

template<typename T >

size_t RingFileCache< T >::Pointer::get_pos_respect_to_head ( ) const

inlinenoexcept

Offset of this pointer relative to the current head of the cache.

Definition at line 522 of file ringfilecache.H.

References RingFileCache< T >::Pointer::cache_ptr, RingFileCache< T >::dim, RingFileCache< T >::head, and RingFileCache< T >::Pointer::pos.

Referenced by RingFileCache< T >::Pointer::get_pos(), and RingFileCache< T >::read_from().

◆ increase_pos()

template<typename T >

void RingFileCache< T >::Pointer::increase_pos ( const long delta = 1 )

inlineprivatenoexcept

Definition at line 422 of file ringfilecache.H.

References RingFileCache< T >::Pointer::cache_ptr, RingFileCache< T >::Pointer::decrease_pos(), RingFileCache< T >::dim, and RingFileCache< T >::Pointer::pos.

Referenced by RingFileCache< T >::Pointer::decrease_pos(), RingFileCache< T >::Pointer::operator++(), RingFileCache< T >::Pointer::operator++(), and RingFileCache< T >::Pointer::operator+=().

◆ operator+()

template<typename T >

Pointer RingFileCache< T >::Pointer::operator+ ( const long val ) const

inlinenoexcept

Return a new Pointer advanced by val positions.

Definition at line 506 of file ringfilecache.H.

References Aleph::maps().

◆ operator++() [1/2]

template<typename T >

Pointer RingFileCache< T >::Pointer::operator++ ( )

inlinenoexcept

Prefix increment: advance one position (with wraparound)

Definition at line 462 of file ringfilecache.H.

References RingFileCache< T >::Pointer::increase_pos().

◆ operator++() [2/2]

template<typename T >

Pointer RingFileCache< T >::Pointer::operator++ ( int )

inlinenoexcept

Postfix increment: advance one position (with wraparound)

Definition at line 469 of file ringfilecache.H.

References RingFileCache< T >::Pointer::increase_pos(), and Aleph::maps().

◆ operator+=()

template<typename T >

Pointer & RingFileCache< T >::Pointer::operator+= ( const long val )

inlinenoexcept

Advance by val positions (with wraparound)

Definition at line 492 of file ringfilecache.H.

References RingFileCache< T >::Pointer::increase_pos().

◆ operator-()

template<typename T >

Pointer RingFileCache< T >::Pointer::operator- ( const long val ) const

inlinenoexcept

Return a new Pointer moved back by val positions.

Definition at line 514 of file ringfilecache.H.

References Aleph::maps().

◆ operator--() [1/2]

template<typename T >

Pointer RingFileCache< T >::Pointer::operator-- ( )

inlinenoexcept

Prefix decrement: move back one position (with wraparound)

Definition at line 477 of file ringfilecache.H.

References RingFileCache< T >::Pointer::decrease_pos().

◆ operator--() [2/2]

template<typename T >

Pointer RingFileCache< T >::Pointer::operator-- ( int )

inlinenoexcept

Postfix decrement: move back one position (with wraparound)

Definition at line 484 of file ringfilecache.H.

References RingFileCache< T >::Pointer::decrease_pos(), and Aleph::maps().

◆ operator-=()

template<typename T >

Pointer & RingFileCache< T >::Pointer::operator-= ( const long val )

inlinenoexcept

Move back by val positions (with wraparound)

Definition at line 499 of file ringfilecache.H.

References RingFileCache< T >::Pointer::decrease_pos().

◆ validate_position()

template<typename T >

void RingFileCache< T >::Pointer::validate_position ( const size_t pos ) const

inlineprivate

Definition at line 412 of file ringfilecache.H.

References ah_out_of_range_error_if, RingFileCache< T >::Pointer::cache_ptr, RingFileCache< T >::dim, Aleph::maps(), and RingFileCache< T >::Pointer::pos.

Friends And Related Symbol Documentation

◆ RingFileCache

template<typename T >

friend class RingFileCache

friend

Definition at line 407 of file ringfilecache.H.

Member Data Documentation

◆ cache_ptr

template<typename T >

RingFileCache* RingFileCache< T >::Pointer::cache_ptr = nullptr

private

Definition at line 409 of file ringfilecache.H.

Referenced by RingFileCache< T >::Pointer::decrease_pos(), RingFileCache< T >::Pointer::get_pos_respect_to_head(), RingFileCache< T >::Pointer::increase_pos(), RingFileCache< T >::read(), RingFileCache< T >::Pointer::validate_position(), and RingFileCache< T >::write().

◆ pos

template<typename T >

size_t RingFileCache< T >::Pointer::pos = 0

private

Definition at line 410 of file ringfilecache.H.

Referenced by RingFileCache< T >::Pointer::decrease_pos(), RingFileCache< T >::Pointer::get_pos_respect_to_head(), RingFileCache< T >::Pointer::increase_pos(), RingFileCache< T >::read(), RingFileCache< T >::Pointer::validate_position(), and RingFileCache< T >::write().

The documentation for this class was generated from the following file:

ringfilecache.H

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Pointer() [1/2]

◆ Pointer() [2/2]

Member Function Documentation

◆ decrease_pos()

◆ get_pos()

◆ get_pos_respect_to_head()

◆ increase_pos()

◆ operator+()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ validate_position()

Friends And Related Symbol Documentation

◆ RingFileCache

Member Data Documentation

◆ cache_ptr

◆ pos