Audio Processing Framework (APF) version 0.5.0
Public Types | Public Member Functions | List of all members
apf::fixed_matrix< T, Allocator >::slices_iterator Class Reference

Iterator over fixed_matrix::Slices. More...

#include <apf/container.h>

Public Types

using iterator_category = std::random_access_iterator_tag
 
using value_type = Slice
 
using reference = Slice
 
using pointer = SliceArrowProxy
 
using difference_type = typename std::iterator_traits< channel_iterator >::difference_type
 

Public Member Functions

 slices_iterator ()
 Default constructor. More...
 
 slices_iterator (channel_iterator base_iterator, size_type max_channels, size_type max_slices)
 Constructor. More...
 
reference operator* () const
 Dereference operator. More...
 
pointer operator-> () const
 Arrow operator. More...
 

Detailed Description

template<typename T, typename Allocator = std::allocator<T>>
class apf::fixed_matrix< T, Allocator >::slices_iterator

Iterator over fixed_matrix::Slices.

Definition at line 502 of file container.h.

Member Typedef Documentation

◆ iterator_category

template<typename T , typename Allocator = std::allocator<T>>
using apf::fixed_matrix< T, Allocator >::slices_iterator::iterator_category = std::random_access_iterator_tag

Definition at line 515 of file container.h.

◆ value_type

template<typename T , typename Allocator = std::allocator<T>>
using apf::fixed_matrix< T, Allocator >::slices_iterator::value_type = Slice

Definition at line 516 of file container.h.

◆ reference

template<typename T , typename Allocator = std::allocator<T>>
using apf::fixed_matrix< T, Allocator >::slices_iterator::reference = Slice

Definition at line 517 of file container.h.

◆ pointer

template<typename T , typename Allocator = std::allocator<T>>
using apf::fixed_matrix< T, Allocator >::slices_iterator::pointer = SliceArrowProxy

Definition at line 518 of file container.h.

◆ difference_type

template<typename T , typename Allocator = std::allocator<T>>
using apf::fixed_matrix< T, Allocator >::slices_iterator::difference_type = typename std::iterator_traits<channel_iterator>::difference_type

Definition at line 519 of file container.h.

Constructor & Destructor Documentation

◆ slices_iterator() [1/2]

template<typename T , typename Allocator = std::allocator<T>>
apf::fixed_matrix< T, Allocator >::slices_iterator::slices_iterator ( )
inline

Default constructor.

Note
This constructor creates a singular iterator. Another slices_iterator can be assigned to it, but nothing else works.

Definition at line 525 of file container.h.

◆ slices_iterator() [2/2]

template<typename T , typename Allocator = std::allocator<T>>
apf::fixed_matrix< T, Allocator >::slices_iterator::slices_iterator ( channel_iterator  base_iterator,
size_type  max_channels,
size_type  max_slices 
)
inline

Constructor.

Definition at line 531 of file container.h.

Member Function Documentation

◆ operator*()

template<typename T , typename Allocator = std::allocator<T>>
reference apf::fixed_matrix< T, Allocator >::slices_iterator::operator* ( ) const
inline

Dereference operator.

Returns
a proxy object of type fixed_matrix::Slice

Definition at line 540 of file container.h.

References apf::no_nullptr().

◆ operator->()

template<typename T , typename Allocator = std::allocator<T>>
pointer apf::fixed_matrix< T, Allocator >::slices_iterator::operator-> ( ) const
inline

Arrow operator.

Returns
a proxy object of type fixed_matrix::SliceArrowProxy

Definition at line 550 of file container.h.


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