libMesh::ConstCouplingRow Class Reference

This proxy class acts like a container of indices from a single coupling row. More...

#include <coupling_matrix.h>

Public Types
typedef ConstCouplingRowConstIterator	const_iterator

Public Member Functions
	ConstCouplingRow (std::size_t row_in, const CouplingMatrix &mat_in)
const_iterator	begin () const
const_iterator	end () const
bool	operator== (const ConstCouplingRow &other) const
bool	operator!= (const ConstCouplingRow &other) const

Protected Attributes
std::size_t	_row_i
const CouplingMatrix &	_mat
std::size_t	_begin_location
const std::size_t	_end_location
CouplingMatrix::rc_type::const_iterator	_begin_it

Friends
class	ConstCouplingRowConstIterator

Detailed Description

This proxy class acts like a container of indices from a single coupling row.

Definition at line 336 of file coupling_matrix.h.

Member Typedef Documentation

const_iterator

typedef ConstCouplingRowConstIterator libMesh::ConstCouplingRow::const_iterator

Definition at line 406 of file coupling_matrix.h.

Constructor & Destructor Documentation

ConstCouplingRow()

libMesh::ConstCouplingRow::ConstCouplingRow ( std::size_t  row_in, const CouplingMatrix &  mat_in  )

inline

Definition at line 339 of file coupling_matrix.h.

                                                  :
    _row_i(row_in), _mat(mat_in),
    _end_location(_row_i*_mat.size()+_mat.size()-1)
  {
    libmesh_assert_less(_row_i, _mat.size());
 
    // Location for i,N, where we'll start looking for our beginning
    // range
    _begin_location = _end_location;
 
    const std::size_t max_size = std::numeric_limits<std::size_t>::max();
 
    // Find the range that might contain i,N
    // lower_bound isn't *quite* what we want
    _begin_it = std::upper_bound
      (_mat._ranges.begin(), _mat._ranges.end(),
       std::make_pair(_begin_location, max_size));
    if (_begin_it !=_mat._ranges.begin())
      --_begin_it;
    else
      _begin_it=_mat._ranges.end();
 
    // If that range doesn't exist then we're an empty row
    if (_begin_it == _mat._ranges.end())
      _begin_location = max_size;
    else
      {
        const std::size_t lastloc  = _begin_it->second;
#ifdef DEBUG
        const std::size_t firstloc = _begin_it->first;
        libmesh_assert_less_equal(firstloc, lastloc);
#endif
 
        // If that range ends before i,0 then we're an empty row
        std::size_t zero_location = _row_i*_mat.size();
        if (zero_location > lastloc)
          {
            _begin_location = max_size;
            _begin_it = _mat._ranges.end();
          }
        else
          // We have *some* entry(s) in this row, we just need to find
          // the earliest
          {
            while (_begin_it != _mat._ranges.begin())
              {
                CouplingMatrix::rc_type::const_iterator prev =
                  _begin_it;
                --prev;
 
                if (prev->second < zero_location)
                  break;
 
                _begin_it = prev;
              }
            if (_begin_it->first < zero_location)
              _begin_location = zero_location;
            else
              _begin_location = _begin_it->first;
          }
      }
  }

References _begin_it, _begin_location, _end_location, _mat, libMesh::CouplingMatrix::_ranges, _row_i, and libMesh::CouplingMatrix::size().

Member Function Documentation

begin()

ConstCouplingRow::const_iterator libMesh::ConstCouplingRow::begin ( ) const

inline

Definition at line 553 of file coupling_matrix.h.

{
  return const_iterator (*this, _begin_location, _begin_it);
}

References _begin_it, and _begin_location.

Referenced by CouplingMatrixTest::testIteratorAPI().

end()

ConstCouplingRow::const_iterator libMesh::ConstCouplingRow::end ( ) const

inline

Definition at line 559 of file coupling_matrix.h.

{
  return const_iterator
    (*this, std::numeric_limits<std::size_t>::max(),
     _mat._ranges.end());
}

References _mat, and libMesh::CouplingMatrix::_ranges.

Referenced by CouplingMatrixTest::testIteratorAPI().

operator!=()

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

inline

Definition at line 429 of file coupling_matrix.h.

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

operator==()

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

inline

Definition at line 419 of file coupling_matrix.h.

  {
    // Thinking that rows from different matrix objects are equal is
    // not even wrong
    libmesh_assert(&_mat == &other._mat);
 
    return ((_begin_location == other._begin_location) &&
            (_begin_it == other._begin_it));
  }

References _begin_it, _begin_location, _mat, and libMesh::libmesh_assert().

Friends And Related Symbol Documentation

ConstCouplingRowConstIterator

friend class ConstCouplingRowConstIterator

friend

Definition at line 435 of file coupling_matrix.h.

Member Data Documentation

_begin_it

CouplingMatrix::rc_type::const_iterator libMesh::ConstCouplingRow::_begin_it

protected

Definition at line 452 of file coupling_matrix.h.

Referenced by begin(), ConstCouplingRow(), and operator==().

_begin_location

std::size_t libMesh::ConstCouplingRow::_begin_location

protected

Definition at line 442 of file coupling_matrix.h.

Referenced by begin(), ConstCouplingRow(), and operator==().

_end_location

const std::size_t libMesh::ConstCouplingRow::_end_location

protected

Definition at line 447 of file coupling_matrix.h.

Referenced by ConstCouplingRow(), and libMesh::ConstCouplingRowConstIterator::operator++().

_mat

const CouplingMatrix& libMesh::ConstCouplingRow::_mat

protected

Definition at line 438 of file coupling_matrix.h.

Referenced by ConstCouplingRow(), libMesh::ConstCouplingRowConstIterator::ConstCouplingRowConstIterator(), end(), libMesh::ConstCouplingRowConstIterator::operator*(), libMesh::ConstCouplingRowConstIterator::operator++(), and operator==().

_row_i

std::size_t libMesh::ConstCouplingRow::_row_i

protected

Definition at line 437 of file coupling_matrix.h.

Referenced by ConstCouplingRow().

---

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

• include/numerics/coupling_matrix.h