CxxUtils::WritableArrayData< N > Class Template Reference

#include <Array.h>

Inheritance diagram for CxxUtils::WritableArrayData< N >:

Collaboration diagram for CxxUtils::WritableArrayData< N >:

Public Member Functions
	WritableArrayData (const unsigned int shape[])
	Constructor. More...
	WritableArrayData (const std::vector< unsigned int > &shape)
	Constructor. More...
WritableArray< N-1 >	operator[] (unsigned int i)
	Array indexing. More...
Array< N-1 >	operator[] (unsigned int i) const
	Array indexing. More...
Arrayelt *	ptr ()
	Return a direct pointer to array elements. More...

Private Member Functions
void	init_sizes (bool resize_data=false)
	Initialize the m_sizes vector from the m_shape vector. More...
void	write_array (std::ostream &stream) const
	Creates a text representation of the array content. More...
void	write_subarray (std::ostream &stream, std::vector< Arrayelt >::size_type &idx, unsigned dimIndex) const
	Helper function for write_array. More...

Private Attributes
std::vector< Arrayelt >	m_data
	The array data, stored using the C array ordering. More...
std::vector< unsigned int >	m_shape
	The array shape. More...
std::vector< unsigned int >	m_sizes
	Subarray sizes, for faster access. More...
Arrayrep *	m_rep_nc
	The underlying array representation, non-const copy. More...

Detailed Description

template<unsigned int N>
class CxxUtils::WritableArrayData< N >

Definition at line 772 of file Control/CxxUtils/CxxUtils/Array.h.

Constructor & Destructor Documentation

WritableArrayData() [1/2]

template<unsigned int N>

CxxUtils::WritableArrayData< N >::WritableArrayData

(

const unsigned int

shape[]

)

Constructor.

Parameters

shape

The shape of the array, as a C array. Should be N elements long.

The shape is the size of the array along each dimension.

WritableArrayData() [2/2]

template<unsigned int N>

CxxUtils::WritableArrayData< N >::WritableArrayData

(

const std::vector< unsigned int > &

shape

)

Constructor.

Parameters

shape

The shape of the array, as a std::vector. Should be N elements long.

The shape is the size of the array along each dimension.

Member Function Documentation

init_sizes()

void CaloRec::Arrayrep::init_sizes ( bool  resize_data = false )

inherited

Initialize the m_sizes vector from the m_shape vector.

Parameters

resize_data

Should m_data be resized appropriately?

The contents of the m_sizes vector are initialized from the contents of the m_shape vector. If resize_data is true, then the size of m_data is changed to the total size indicated by m_shape. Otherwise, we verify that m_data has the correct size, and raise an assertion if not.

Definition at line 34 of file Arrayrep.cxx.

{
  // Don't do anything if we've already done this, or if the array
  // is empty.
  if (m_sizes.size() < m_shape.size())
  {
    // Calculate the m_sizes array.
    unsigned int sz = 1;
    unsigned int dim = m_shape.size();
    m_sizes.resize (dim);
    m_sizes[0] = 1;
    for (unsigned int i=0; i < dim; i++) {
      m_sizes[i] = sz;
      sz *= m_shape[dim-1 - i];
    }
    
    if (resize_data) {
      // Resize m_data to the proper size.
      m_data.resize (sz);
    }
    else {
      // Check that m_data has the correct size.
      assert (sz == m_data.size());
    }
  }
}

operator[]() [1/2]

WritableArray<N-1> CxxUtils::WritableArray::operator[] ( unsigned int  i )

inherited

Array indexing.

Parameters

i	The desired index. Must be less than the array size along this dimension.

Returns

The i'th N-1 dimensional subarray in the array.

Note that this operation is not available if N is 0.

operator[]() [2/2]

Array<N-1> CxxUtils::WritableArray::operator[] ( unsigned int  i ) const

inherited

Array indexing.

Parameters

i	The desired index. Must be less than the array size along this dimension.

Returns

The i'th N-1 dimensional subarray in the array.

Note that this operation is not available if N is 0.

ptr()

Arrayelt* CxxUtils::WritableArray::ptr

inherited

Return a direct pointer to array elements.

Returns

A pointer to the first array elements.

Subsequent elements follow in standard C indexing order.

write_array()

void CaloRec::Arrayrep::write_array ( std::ostream &  stream ) const

inherited

Creates a text representation of the array content.

Helper function for write_array.

Parameters

std::ostream

where the text should be written

Writes the content of the array to a ostream. The sub-arrays are enclosed by square brackets and separated by commas.

Parameters

stream	where the array should be written
idx	Current index in m_data
dimIndex	Current index in m_shapes

Calls itself recursively with dimIndex-1

Definition at line 245 of file Arrayrep.cxx.

                                                   {
  if (!m_data.size()) {//Empty array
    stream << "[ ]" << std::endl;
    return;
  }
 
  if (!m_shape.size()) {//Single element
    stream << m_data[0] << std::endl;
    return;
  }
 
  //All other cases: Array of dimension>=1
  //check consistency of Array
  unsigned totSize=m_shape[0];
  for (unsigned i=1;i<m_shape.size();i++)
    totSize=totSize*m_shape[i];
  if (totSize!=m_data.size()) 
    error("","Array is inconsistent!");
 
  std::vector<Arrayelt>::size_type dataIndex=0;
  write_subarray(stream,dataIndex,0);
  stream << "]" << std::endl;
  return;
}

write_subarray()

void CaloRec::Arrayrep::write_subarray ( std::ostream &  stream, std::vector< Arrayelt >::size_type &  idx, unsigned  dimIndex  ) const

inherited

Helper function for write_array.

Creates a text representation of the array content.

Parameters

stream	where the array should be written
idx	Current index in m_data
dimIndex	Current index in m_shapes

Calls itself recursively with dimIndex-1

Parameters

std::ostream

where the text should be written

Writes the content of the array to a ostream. The sub-arrays are enclosed by square brackets and separated by commas.

Definition at line 279 of file Arrayrep.cxx.

                                                                                                            {
  if (dimIndex<(m_shape.size()-1)) {
    stream << "[\n    ";
    for (unsigned i=0;i<m_shape[dimIndex];i++) {
      write_subarray(stream,idx,dimIndex+1);
      if (i==m_shape[dimIndex]-1)
    stream << "]\n    ";
      else
    stream << "],\n    ";
    }
  }
  else { // last dimension
    stream << "[" << m_data[idx++];
    for (unsigned i=1;i<m_shape[dimIndex];i++)
      stream << ", " << m_data[idx++];
  }
  return;
}

Member Data Documentation

m_data

std::vector<Arrayelt> CaloRec::Arrayrep::m_data

inherited

The array data, stored using the C array ordering.

Definition at line 102 of file Control/CxxUtils/CxxUtils/Arrayrep.h.

m_rep_nc

Arrayrep* CxxUtils::WritableArray::m_rep_nc

privateinherited

The underlying array representation, non-const copy.

Definition at line 704 of file Control/CxxUtils/CxxUtils/Array.h.

m_shape

std::vector<unsigned int> CaloRec::Arrayrep::m_shape

inherited

The array shape.

One entry per dimension, giving the size of each dimension.

Definition at line 106 of file Control/CxxUtils/CxxUtils/Arrayrep.h.

m_sizes

std::vector<unsigned int> CaloRec::Arrayrep::m_sizes

inherited

Subarray sizes, for faster access.

See above. This member could be considered transient.

Definition at line 110 of file Control/CxxUtils/CxxUtils/Arrayrep.h.

---

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

• Control/CxxUtils/CxxUtils/Array.h