ConstantSizeMatrix< T, ALLOC > Class Template Reference

Drop in replacement for OhmmsMatrix as a storage object backed by PooledMemory, does not support PETE. More...

Inheritance diagram for ConstantSizeMatrix< T, ALLOC >:

Collaboration diagram for ConstantSizeMatrix< T, ALLOC >:

Public Member Functions
	ConstantSizeMatrix (size_t m, size_t n, size_t m_max, size_t n_max, T val=T())
	ConstantSizeMatrix (const ConstantSizeMatrix &csm)
const T *	operator[] (size_t i) const
T *	operator[] (size_t i)
template<typename Allocator = ALLOC, typename = IsHostSafe<Allocator>>
T &	operator() (size_t i)
template<typename Allocator = ALLOC, typename = IsHostSafe<Allocator>>
T	operator() (size_t i) const
template<typename Allocator = ALLOC, typename = IsHostSafe<Allocator>>
T &	operator() (size_t i, size_t j)
template<typename Allocator = ALLOC, typename = IsHostSafe<Allocator>>
const T &	operator() (size_t i, size_t j) const
T *	data ()
const T *	data () const
size_t	capacity ()
size_t	n_capacity ()
size_t	size () const
size_t	cols () const
size_t	rows () const
void	resize (size_t m, size_t n)
auto	begin ()
auto	end ()
auto	begin () const
auto	end () const
template<class RHS , typename allocator = ALLOC, typename = IsHostSafe<allocator>>
void	copy (const RHS &rhs)
	Methods for assignment or copy of identically sized or smaller ConstantSizeMatrix<T, ALLOC>. More...
void	copy (const ConstantSizeMatrix &rhs)
ConstantSizeMatrix &	operator= (const ConstantSizeMatrix &rhs)
template<template< typename, class > class RHS, typename TP , class ALLOCP , typename = IsHostSafe<ALLOC>, typename = IsHostSafe<ALLOCP>>
ConstantSizeMatrix< T, ALLOC > &	operator= (const RHS< TP, ALLOCP > &rhs)
template<class TP , class ALLOCP , typename = IsHostSafe<ALLOC>, typename = IsHostSafe<ALLOCP>>
ConstantSizeMatrix< T, ALLOC > &	operator= (const Matrix< TP, ALLOCP > &rhs)

Private Attributes
size_t	m_
size_t	n_
size_t	m_max_
size_t	n_max_
size_t	capacity_
std::vector< T, ALLOC >	data_

Detailed Description

template<class T, typename ALLOC = std::allocator<T>>
class qmcplusplus::ConstantSizeMatrix< T, ALLOC >

Drop in replacement for OhmmsMatrix as a storage object backed by PooledMemory, does not support PETE.

rows are contiguous i.e. it's row major like OhmmsMatrix Constant size removes worry about synchronizing DataSet in Walker.

Reproduces some creative operator semantics from OhmmsMatrix, be careful.

This is intended as a host object, Not for use on accelerators.

Definition at line 23 of file ConstantSizeMatrix.hpp.

Constructor & Destructor Documentation

ConstantSizeMatrix() [1/2]

ConstantSizeMatrix ( size_t  m, size_t  n, size_t  m_max, size_t  n_max, T  val = T()  )

inline

Definition at line 26 of file ConstantSizeMatrix.hpp.

      : m_(m), n_(n), m_max_(m_max), n_max_(n_max), capacity_(n_max * m_max), data_(n_max * m_max, val)
  {
    if (n_max <= 0 || n > n_max || m_max <= 0 || m > m_max)
      throw std::runtime_error("Cannot construct ConstantSizeMatrix with an invalid size");
  }

ConstantSizeMatrix() [2/2]

ConstantSizeMatrix ( const ConstantSizeMatrix< T, ALLOC > &  csm )

inline

Definition at line 33 of file ConstantSizeMatrix.hpp.

      : m_(csm.m_), n_(csm.n_), m_max_(csm.m_max_), n_max_(csm.n_max_), capacity_(csm.capacity_), data_(csm.capacity_)
  {
    //I don't just do an = here because of the posible semantics of allocator propagation.
    data_.assign(csm.begin(), csm.end());
  }

Member Function Documentation

begin() [1/2]

auto begin ( )

inline

Definition at line 187 of file ConstantSizeMatrix.hpp.

Referenced by ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::ConstantSizeMatrix().

{ return data_.begin(); }

begin() [2/2]

auto begin ( ) const

inline

Definition at line 189 of file ConstantSizeMatrix.hpp.

{ return data_.begin(); }

capacity()

size_t capacity ( )

inline

Definition at line 154 of file ConstantSizeMatrix.hpp.

Referenced by Walker< qmcplusplus::QMCTraits, qmcplusplus::PtclOnLatticeTraits >::copyFromBuffer(), Walker< qmcplusplus::QMCTraits, qmcplusplus::PtclOnLatticeTraits >::registerData(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::resize(), qmcplusplus::TEST_CASE(), and Walker< qmcplusplus::QMCTraits, qmcplusplus::PtclOnLatticeTraits >::updateBuffer().

{ return capacity_; }

cols()

size_t cols ( ) const

inline

Definition at line 158 of file ConstantSizeMatrix.hpp.

Referenced by qmcplusplus::TEST_CASE().

{ return n_; }

copy() [1/2]

void copy ( const RHS &  rhs )

inline

Methods for assignment or copy of identically sized or smaller ConstantSizeMatrix<T, ALLOC>.

Definition at line 46 of file ConstantSizeMatrix.hpp.

Referenced by Walker< qmcplusplus::QMCTraits, qmcplusplus::PtclOnLatticeTraits >::makeCopy().

  {
    if (this->data_.capacity() < rhs.size())
      throw std::runtime_error("Constant size vector cannot fit matrix to be copied.");
    data_.assign(rhs.begin(), rhs.end());
  }

copy() [2/2]

void copy ( const ConstantSizeMatrix< T, ALLOC > &  rhs )

inline

Definition at line 52 of file ConstantSizeMatrix.hpp.

  {
    if (this->data_.capacity() < rhs.size())
      throw std::runtime_error("Constant size vector cannot fit matrix to be copied.");
    if (&rhs == this)
      throw std::runtime_error("ConstantSizeMatrix.copy(ConstantSizeMatrix& rhs) &rhs == this");
    data_.assign(rhs.data_.begin(), rhs.data_.end());
  }

data() [1/2]

T* data ( )

inline

Definition at line 151 of file ConstantSizeMatrix.hpp.

Referenced by Walker< qmcplusplus::QMCTraits, qmcplusplus::PtclOnLatticeTraits >::copyFromBuffer(), Walker< qmcplusplus::QMCTraits, qmcplusplus::PtclOnLatticeTraits >::getPropertyBase(), ParticleSet::getPropertyBase(), Walker< qmcplusplus::QMCTraits, qmcplusplus::PtclOnLatticeTraits >::registerData(), and Walker< qmcplusplus::QMCTraits, qmcplusplus::PtclOnLatticeTraits >::updateBuffer().

{ return data_.data(); }

data() [2/2]

const T* data ( ) const

inline

Definition at line 152 of file ConstantSizeMatrix.hpp.

{ return data_.data(); }

end() [1/2]

auto end ( )

inline

Definition at line 188 of file ConstantSizeMatrix.hpp.

Referenced by ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::ConstantSizeMatrix().

{ return data_.end(); }

end() [2/2]

auto end ( ) const

inline

Definition at line 190 of file ConstantSizeMatrix.hpp.

{ return data_.end(); }

n_capacity()

size_t n_capacity ( )

inline

Definition at line 155 of file ConstantSizeMatrix.hpp.

{ return n_max_; }

operator()() [1/4]

T& operator() ( size_t  i )

inline

Definition at line 120 of file ConstantSizeMatrix.hpp.

  {
    // As far as I know no code does this and none should
    if (n_ <= i)
      throw std::runtime_error("ConstantSizeMatrix doesn't support access to second row values through operator()");
    return data_[i];
  }

operator()() [2/4]

T operator() ( size_t  i ) const

inline

Definition at line 129 of file ConstantSizeMatrix.hpp.

  {
    // As far as I know no code does this and none should
    if (n_ <= i)
      throw std::runtime_error("ConstantSizeMatrix doesn't support access to second row values through operator()");
    return data_[i];
  }

operator()() [3/4]

T& operator() ( size_t  i, size_t  j  )

inline

Definition at line 139 of file ConstantSizeMatrix.hpp.

  {
    return data_[i * n_max_ + j];
  }

operator()() [4/4]

const T& operator() ( size_t  i, size_t  j  ) const

inline

Definition at line 146 of file ConstantSizeMatrix.hpp.

  {
    return data_[i * n_max_ + j];
  }

operator=() [1/3]

ConstantSizeMatrix& operator= ( const ConstantSizeMatrix< T, ALLOC > &  rhs )

inline

Definition at line 61 of file ConstantSizeMatrix.hpp.

  {
    if (this->data_.capacity() < rhs.size())
      throw std::runtime_error("ConstantSizeMatrix cannot take assignment of larger than max size");
    if (&rhs != this)
    {
      if (rhs.n_max_ == n_max_)
        data_.assign(rhs.data_.begin(), rhs.data_.end());
      else
        throw std::runtime_error("ConstnatSizedMatrix assignment for mismatched n_max not yet supported.");
    }
    return *this;
  }

operator=() [2/3]

ConstantSizeMatrix<T, ALLOC>& operator= ( const RHS< TP, ALLOCP > &  rhs )

inline

Definition at line 80 of file ConstantSizeMatrix.hpp.

  {
    if (this->data_.capacity() < rhs.size())
      throw std::runtime_error("ConstantSizeMatrix cannot be assigned a matrix larger than itself.");
    data_.assign(rhs.begin(), rhs.end());
    return *this;
  }

operator=() [3/3]

ConstantSizeMatrix<T, ALLOC>& operator= ( const Matrix< TP, ALLOCP > &  rhs )

inline

Definition at line 89 of file ConstantSizeMatrix.hpp.

  {
    if (this->data_.capacity() < rhs.size())
    {
      std::basic_ostringstream<char> error;
      error << "ConstantSizeMatrix cannot take assignment of larger than max size (" << n_max_ << " by " << m_max_
            << ") \n";
      throw std::runtime_error(error.str());
    }
    if (this->n_max_ < rhs.cols())
    {
      std::basic_ostringstream<char> error;
      error << "ConstantSizeMatrix cannot be assigned a matrix dimension larger than n_max (" << n_max_ << ")\n";
      throw std::runtime_error(error.str());
    }
    n_ = rhs.cols();
    m_ = rhs.rows();
    for (size_t row = 0; row < rhs.rows(); ++row)
      std::copy(rhs[row], rhs[row] + n_, (*this)[row]);
    return *this;
  }

operator[]() [1/2]

const T* operator[] ( size_t  i ) const

inline

Definition at line 113 of file ConstantSizeMatrix.hpp.

{ return data_.data() + i * n_max_; }

operator[]() [2/2]

T* operator[] ( size_t  i )

inline

Definition at line 116 of file ConstantSizeMatrix.hpp.

{ return data_.data() + i * n_max_; }

resize()

void resize ( size_t  m, size_t  n  )

inline

Definition at line 161 of file ConstantSizeMatrix.hpp.

Referenced by MCPopulation::createWalkers(), MCWalkerConfiguration::resetWalkerProperty(), Walker< qmcplusplus::QMCTraits, qmcplusplus::PtclOnLatticeTraits >::resizeProperty(), and qmcplusplus::TEST_CASE().

  {
    if (n * m > capacity())
    {
      std::ostringstream error;
      error << "You cannot resize a constant size matrix beyond its initial max dimensions ( " << m << "," << n << " > "
            << m_max_ << "," << n_max_ << " )\n";
      throw std::domain_error(error.str());
    }

    if (n > n_max_)
    {
      n_max_ = n;
      m_max_ = capacity() / n_max_;
    }

    if (m > m_max_)
    {
      m_max_ = m;
      n_max_ = capacity() / m_max_;
    }

    n_ = n;
    m_ = m;
  }

rows()

size_t rows ( ) const

inline

Definition at line 159 of file ConstantSizeMatrix.hpp.

{ return m_; }

size()

size_t size ( ) const

inline

Definition at line 157 of file ConstantSizeMatrix.hpp.

Referenced by ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::copy(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::operator=(), and qmcplusplus::TEST_CASE().

{ return n_ * m_; }

Member Data Documentation

capacity_

size_t capacity_

private

Definition at line 197 of file ConstantSizeMatrix.hpp.

Referenced by ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::capacity().

data_

std::vector<T, ALLOC> data_

private

Definition at line 198 of file ConstantSizeMatrix.hpp.

Referenced by ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::begin(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::ConstantSizeMatrix(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::copy(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::data(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::end(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::operator()(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::operator=(), and ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::operator[]().

m_

size_t m_

private

Definition at line 193 of file ConstantSizeMatrix.hpp.

Referenced by ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::operator=(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::resize(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::rows(), and ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::size().

m_max_

size_t m_max_

private

Definition at line 195 of file ConstantSizeMatrix.hpp.

Referenced by ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::operator=(), and ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::resize().

n_

size_t n_

private

Definition at line 194 of file ConstantSizeMatrix.hpp.

Referenced by ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::cols(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::operator()(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::operator=(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::resize(), and ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::size().

n_max_

size_t n_max_

private

Definition at line 196 of file ConstantSizeMatrix.hpp.

Referenced by ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::n_capacity(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::operator()(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::operator=(), ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::operator[](), and ConstantSizeMatrix< FullPrecRealType, std::allocator< FullPrecRealType > >::resize().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Containers/MinimalContainers/ConstantSizeMatrix.hpp