Blaze 3.9
Classes
UniformIterator.h File Reference

Header file for the UniformIterator class template. More...

#include <iterator>
#include <blaze/math/AlignmentFlag.h>
#include <blaze/math/SIMD.h>
#include <blaze/util/Assert.h>
#include <blaze/util/MaybeUnused.h>
#include <blaze/util/Types.h>

Go to the source code of this file.

Classes

class  blaze::UniformIterator< Type, AF >
 Implementation of a generic iterator for uniform vectors and matrices. More...
 

Functions

UniformIterator operators
template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator== (const UniformIterator< T1, AF1 > &lhs, const UniformIterator< T2, AF2 > &rhs) noexcept
 Equality comparison between two UniformIterator objects. More...
 
template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator!= (const UniformIterator< T1, AF1 > &lhs, const UniformIterator< T2, AF2 > &rhs) noexcept
 Inequality comparison between two UniformIterator objects. More...
 
template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator< (const UniformIterator< T1, AF1 > &lhs, const UniformIterator< T2, AF2 > &rhs) noexcept
 Less-than comparison between two UniformIterator objects. More...
 
template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator> (const UniformIterator< T1, AF1 > &lhs, const UniformIterator< T2, AF2 > &rhs) noexcept
 Greater-than comparison between two UniformIterator objects. More...
 
template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator<= (const UniformIterator< T1, AF1 > &lhs, const UniformIterator< T2, AF2 > &rhs) noexcept
 Less-or-equal-than comparison between two UniformIterator objects. More...
 
template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator>= (const UniformIterator< T1, AF1 > &lhs, const UniformIterator< T2, AF2 > &rhs) noexcept
 Greater-or-equal-than comparison between two UniformIterator objects. More...
 
template<typename Type , AlignmentFlag AF>
constexpr const UniformIterator< Type, AF > blaze::operator+ (const UniformIterator< Type, AF > &it, ptrdiff_t inc) noexcept
 Addition between a UniformIterator and an integral value. More...
 
template<typename Type , AlignmentFlag AF>
constexpr const UniformIterator< Type, AF > blaze::operator+ (ptrdiff_t inc, const UniformIterator< Type, AF > &it) noexcept
 Addition between an integral value and a UniformIterator. More...
 
template<typename Type , AlignmentFlag AF>
constexpr const UniformIterator< Type, AF > blaze::operator- (const UniformIterator< Type, AF > &it, ptrdiff_t dec) noexcept
 Subtraction between a UniformIterator and an integral value. More...
 
template<typename Type , AlignmentFlag AF>
constexpr ptrdiff_t blaze::operator- (const UniformIterator< Type, AF > &lhs, const UniformIterator< Type, AF > &rhs) noexcept
 Calculating the number of elements between two UniformIterator objects. More...
 

Detailed Description

Header file for the UniformIterator class template.

Copyright (C) 2012-2020 Klaus Iglberger - All Rights Reserved

This file is part of the Blaze library. You can redistribute it and/or modify it under

  The names of its contributors may not be used to endorse or promote products derived

from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

◆ operator!=()

template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator!= ( const UniformIterator< T1, AF1 > &  lhs,
const UniformIterator< T2, AF2 > &  rhs 
)
constexprnoexcept

Inequality comparison between two UniformIterator objects.

Parameters
lhsThe left-hand side iterator.
rhsThe right-hand side iterator.
Returns
true if the iterators don't refer to the same element, false if they do.

◆ operator+() [1/2]

template<typename Type , AlignmentFlag AF>
constexpr const UniformIterator< Type, AF > blaze::operator+ ( const UniformIterator< Type, AF > &  it,
ptrdiff_t  inc 
)
constexprnoexcept

Addition between a UniformIterator and an integral value.

Parameters
itThe iterator to be incremented.
incThe number of elements the iterator is incremented.
Returns
The incremented iterator.

◆ operator+() [2/2]

template<typename Type , AlignmentFlag AF>
constexpr const UniformIterator< Type, AF > blaze::operator+ ( ptrdiff_t  inc,
const UniformIterator< Type, AF > &  it 
)
constexprnoexcept

Addition between an integral value and a UniformIterator.

Parameters
incThe number of elements the iterator is incremented.
itThe iterator to be incremented.
Returns
The incremented iterator.

◆ operator-() [1/2]

template<typename Type , AlignmentFlag AF>
constexpr const UniformIterator< Type, AF > blaze::operator- ( const UniformIterator< Type, AF > &  it,
ptrdiff_t  dec 
)
constexprnoexcept

Subtraction between a UniformIterator and an integral value.

Parameters
itThe iterator to be decremented.
decThe number of elements the iterator is decremented.
Returns
The decremented iterator.

◆ operator-() [2/2]

template<typename Type , AlignmentFlag AF>
constexpr ptrdiff_t blaze::operator- ( const UniformIterator< Type, AF > &  lhs,
const UniformIterator< Type, AF > &  rhs 
)
constexprnoexcept

Calculating the number of elements between two UniformIterator objects.

Parameters
lhsThe left-hand side iterator.
rhsThe right-hand side iterator.
Returns
The number of elements between the two iterators.

◆ operator<()

template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator< ( const UniformIterator< T1, AF1 > &  lhs,
const UniformIterator< T2, AF2 > &  rhs 
)
constexprnoexcept

Less-than comparison between two UniformIterator objects.

Parameters
lhsThe left-hand side iterator.
rhsThe right-hand side iterator.
Returns
true if the left-hand side iterator is smaller, false if not.

◆ operator<=()

template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator<= ( const UniformIterator< T1, AF1 > &  lhs,
const UniformIterator< T2, AF2 > &  rhs 
)
constexprnoexcept

Less-or-equal-than comparison between two UniformIterator objects.

Parameters
lhsThe left-hand side iterator.
rhsThe right-hand side iterator.
Returns
true if the left-hand side iterator is less or equal, false if not.

◆ operator==()

template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator== ( const UniformIterator< T1, AF1 > &  lhs,
const UniformIterator< T2, AF2 > &  rhs 
)
constexprnoexcept

Equality comparison between two UniformIterator objects.

Parameters
lhsThe left-hand side iterator.
rhsThe right-hand side iterator.
Returns
true if the iterators refer to the same element, false if not.

◆ operator>()

template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator> ( const UniformIterator< T1, AF1 > &  lhs,
const UniformIterator< T2, AF2 > &  rhs 
)
constexprnoexcept

Greater-than comparison between two UniformIterator objects.

Parameters
lhsThe left-hand side iterator.
rhsThe right-hand side iterator.
Returns
true if the left-hand side iterator is greater, false if not.

◆ operator>=()

template<typename T1 , AlignmentFlag AF1, typename T2 , AlignmentFlag AF2>
constexpr bool blaze::operator>= ( const UniformIterator< T1, AF1 > &  lhs,
const UniformIterator< T2, AF2 > &  rhs 
)
constexprnoexcept

Greater-or-equal-than comparison between two UniformIterator objects.

Parameters
lhsThe left-hand side iterator.
rhsThe right-hand side iterator.
Returns
true if the left-hand side iterator is greater or equal, false if not.