#include <coupling_matrix.h>

Public Member Functions
	ConstCouplingRowConstIterator (const ConstCouplingRow &row_in, std::size_t loc_in, CouplingMatrix::rc_type::const_iterator it_in)

std::size_t	operator* ()

ConstCouplingRowConstIterator &	operator++ ()

bool	operator== (const ConstCouplingRowConstIterator &other) const

bool	operator!= (const ConstCouplingRowConstIterator &other) const

Private Attributes
std::size_t	_location

const ConstCouplingRow &	_row

CouplingMatrix::rc_type::const_iterator	_it

Detailed Description

Definition at line 457 of file coupling_matrix.h.

Constructor & Destructor Documentation

◆ ConstCouplingRowConstIterator()

libMesh::ConstCouplingRowConstIterator::ConstCouplingRowConstIterator	(	const ConstCouplingRow &	row_in,
		std::size_t	loc_in,
		CouplingMatrix::rc_type::const_iterator	it_in
	)

inline

Definition at line 460 of file coupling_matrix.h.

                                                                            :
    _location(loc_in),
    _row(row_in),
    _it(it_in)
  {
#ifndef NDEBUG
    if (_it != _row._mat._ranges.end())
      {
        libmesh_assert_less_equal(_it->first, _location);
        libmesh_assert_less_equal(_location, _it->second);
      }
    else
      {
        libmesh_assert_equal_to
          (_location, std::numeric_limits<size_t>::max());
      }
#endif
  }

References _it, _location, libMesh::ConstCouplingRow::_mat, libMesh::CouplingMatrix::_ranges, and _row.

Member Function Documentation

◆ operator!=()

bool libMesh::ConstCouplingRowConstIterator::operator!= ( const ConstCouplingRowConstIterator & other ) const

inline

Definition at line 533 of file coupling_matrix.h.

  {
    return !(*this == other);
  }

◆ operator*()

std::size_t libMesh::ConstCouplingRowConstIterator::operator* ( )

inline

Definition at line 481 of file coupling_matrix.h.

  {
    libmesh_assert_not_equal_to
      (_location, std::numeric_limits<std::size_t>::max());
    return _location % _row._mat.size();
  }

References _location, libMesh::ConstCouplingRow::_mat, _row, and libMesh::CouplingMatrix::size().

◆ operator++()

ConstCouplingRowConstIterator & libMesh::ConstCouplingRowConstIterator::operator++ ( )

inline

Definition at line 488 of file coupling_matrix.h.

  {
    libmesh_assert_not_equal_to
      (_location, std::numeric_limits<std::size_t>::max());
    libmesh_assert
      (_it != _row._mat._ranges.end());
 
    if (_location >= _it->second)
      {
        ++_it;
 
        // Are we past the end of the matrix?
        if (_it == _row._mat._ranges.end())
          _location = std::numeric_limits<std::size_t>::max();
        else
          {
            _location = _it->first;
            // Is the new range past the end of the row?
            if (_location > _row._end_location)
              _location = std::numeric_limits<std::size_t>::max();
          }
      }
    // Would incrementing put us past the end of the row?
    else if (_location >= _row._end_location)
      _location = std::numeric_limits<std::size_t>::max();
    else
      ++_location;
 
    return *this;
  }

References libMesh::ConstCouplingRow::_end_location, _it, _location, libMesh::ConstCouplingRow::_mat, libMesh::CouplingMatrix::_ranges, _row, and libMesh::libmesh_assert().

◆ operator==()

bool libMesh::ConstCouplingRowConstIterator::operator== ( const ConstCouplingRowConstIterator & other ) const

inline

Definition at line 519 of file coupling_matrix.h.

  {
    // Thinking that iterators from different row objects are equal
    // is not even wrong
    libmesh_assert(_row == other._row);
 
    return (_location == other._location);
    // Testing for equality of _it is either redundant (for a
    // dereferenceable iterator, where _it is defined to be the range
    // which includes _location) or wrong (for an end iterator, where
    // we don't always bother to set _it)
    //        && (_it == other._it);
  }