CaloRec::Arrayrep Class Reference

Representation class for Array's. More...

#include <Arrayrep.h>

Inheritance diagram for CaloRec::Arrayrep:

Collaboration diagram for CaloRec::Arrayrep:

Public Member Functions
	Arrayrep ()
	Default constructor. More...
	Arrayrep (const std::string &str, const std::string &context="")
	Construct from a string. More...
	Arrayrep (const std::vector< unsigned int > &shape)
	Construct an empty array of a given shape. More...
	Arrayrep (const unsigned int shape[], unsigned int n)
	Construct an empty array of a given shape. More...
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...

Public 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...

Detailed Description

Representation class for Array's.

This class is used for the implementation of multidimensional array constants. The user interface is provided by the Array template class. Given an Array<N> a, we want a[i] to be an Array<N-1>. However, we don't want to have to copy the array data. Thus, the Array class just holds a reference to the actual array data. Those data are stored in an instance of Arrayrep.

An Arrayrep is defined by two vectors: one giving all the array elements, and the second giving the shape of the array. (A shape is a vector with one integer per array dimension, the integers giving the size of the dimensions.)

We maintain one additional array as an optimization. m_sizes[0] contains the total size in elements of the array resulting from a single indexing operation. m_sizes[1] contains the size of the array resulting from two indexing operations, and so on. m_sizes has the same length as m_shape, but the last element is always 1. The function init_sizes will initialize the m_sizes array from the contents of m_shape.

A scalar (0-dimensional array) is represented by m_shape (and m_sizes) being empty, and m_data having a single element.

If both m_shape and m_data are empty, then the representation is uninitialized.

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

Constructor & Destructor Documentation

Arrayrep() [1/4]

CaloRec::Arrayrep::Arrayrep ( )

inline

Default constructor.

This makes an uninitialized Arrayrep.

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

{}

Arrayrep() [2/4]

CaloRec::Arrayrep::Arrayrep ( const std::string &  str, const std::string &  context = ""  )

explicit

Construct from a string.

Parameters

str	The string to convert.
context	An optional string to use for error reporting.

Parse the string and initialize the array. This string should be like ‘[[1, 2], [3, 4]]’.

Definition at line 202 of file Arrayrep.cxx.

{
  // Special cases for True and False.
  if (str == "True")
    m_data.push_back (1);
  else if (str == "False")
    m_data.push_back (0);
  else {
    // Make the token stream from which we're reading.
    std::istringstream is (str);
    ArrayScanner s (is);
 
    // If we're looking at an open bracket, consume it, and proceed
    // to read an array.
    if (s.at_open())
      read_array (*this, s, 0, context);
    else {
      // Otherwise, we're reading a scalar.  So read a single number.
      Arrayelt elt;
      if (!s.at_num (elt))
    error (context, "Number expected");
      m_data.push_back (elt);
    }
 
    // We should now be at the end of the stream.
    if (!s.at_end())
      error (context, "End of vector before end of string");
  }
 
  // Set up the m_sizes vector.
  init_sizes();
}

Arrayrep() [3/4]

CaloRec::Arrayrep::Arrayrep ( const std::vector< unsigned int > &  shape )

explicit

Construct an empty array of a given shape.

Parameters

shape

The shape of the array.

Initialize an array of a given shape. The array will contain all 0's.

Definition at line 69 of file Arrayrep.cxx.

  : m_shape (shape)
{
  // Set up m_sizes.
  init_sizes (true);
}

Arrayrep() [4/4]

CaloRec::Arrayrep::Arrayrep ( const unsigned int  shape[], unsigned int  n  )

explicit

Construct an empty array of a given shape.

Parameters

shape	The shape of the array.
n	The length of the shape array.

Initialize an array of a given shape. The array will contain all 0's. This version is more convenient to call with a constant shape.

Definition at line 86 of file Arrayrep.cxx.

{
  // Copy the data into m_shape.
  m_shape.reserve (n);
  for (unsigned int i=0; i < n; i++)
    m_shape.push_back (shape[i]);
 
  // Set up m_sizes.
  init_sizes (true);
}

Member Function Documentation

init_sizes()

void CaloRec::Arrayrep::init_sizes

(

bool

resize_data = false

)

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());
    }
  }
}

write_array()

void CaloRec::Arrayrep::write_array

(

std::ostream &

stream

)

const

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

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

The array data, stored using the C array ordering.

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

m_shape

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

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

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 files:

• Control/CxxUtils/CxxUtils/Arrayrep.h
• Arrayrep.cxx