Non-templated base class for templated Array class. More...

#include <ArrayBase.h>

Inheritance diagram for casa::ArrayBase:

Public Member Functions
	ArrayBase ()
	ArrayBase (const IPosition &shape)
	Create an array of the given shape, i.e.
	ArrayBase (const ArrayBase &other)
	Copy constructor.
ArrayBase &	operator= (const ArrayBase &)
	Assignment.
virtual	~ArrayBase ()
	Destructor.
uInt	ndim () const
	The dimensionality of this array.
size_t	nelements () const
	How many elements does this array have? Product of all axis lengths.
size_t	size () const
Bool	empty () const
	Is the array empty (i.e.
Bool	contiguousStorage () const
	Are the array data contiguous? If they are not contiguous, `getStorage` (see below) needs to make a copy.
virtual Bool	ok () const
	Check to see if the Array is consistent.
const IPosition &	shape () const
	The length of each axis.
IPosition	endPosition () const
	A convenience function: endPosition(i) = shape(i) - 1; i.e.
const IPosition &	steps () const
	Return steps to be made if stepping one element in a dimension.
virtual ArrayPositionIterator *	makeIterator (uInt byDim)
	Create an ArrayIterator object of the correct type.
virtual ArrayBase *	getSection (const Slicer &)
	Get a reference to a section of an array.
void	validateConformance (const ArrayBase &) const
	Various helper functions.
void	validateIndex (const IPosition &) const
void	validateIndex (uInt index) const
void	validateIndex (uInt index1, uInt index2) const
void	validateIndex (uInt index1, uInt index2, uInt index3) const
Static Public Member Functions
static uInt	arrayVersion ()
	Array version for major change (used by ArrayIO).
Protected Member Functions
void	baseCopy (const ArrayBase &that)
Bool	isStorageContiguous () const
	Determine if the storage of a subset is contiguous.
void	checkVectorShape ()
	Check if the shape of a vector is correct.
void	checkMatrixShape ()
	Check if the shape of a matrix is correct.
void	checkCubeShape ()
	Check if the shape of a cube is correct.
void	baseReform (ArrayBase &tmp, const IPosition &shape) const
	Reform the array to a shape with the same nr of elements.
void	baseNonDegenerate (const ArrayBase &other, const IPosition &ignoreAxes)
	Remove the degenerate axes from the Array object.
void	baseAddDegenerate (ArrayBase &, uInt numAxes)
	These member functions return an Array reference with the specified number of extra axes, all of length one, appended to the end of the Array.
size_t	makeSubset (ArrayBase &out, const IPosition &b, const IPosition &e, const IPosition &i)
	Make a subset of an array.
Bool	conform2 (const ArrayBase &other) const
	Are the shapes identical?
void	baseMakeSteps ()
	Make the indexing step sizes.
void	throwNdimVector ()
	Throw expection if vector dimensionality is incorrect.
Bool	copyVectorHelper (const ArrayBase &other)
	Helper function for templated Vector class.
Protected Attributes
size_t	nels_p

uInt	ndimen_p
	Dimensionality of the array.
Bool	contiguous_p
	Are the data contiguous?
IPosition	length_p
	Used to hold the shape, increment into the underlying storage and originalLength of the array.
IPosition	inc_p
IPosition	originalLength_p
IPosition	steps_p
	Used to hold the step to next element in each dimension.

Detailed Description

Non-templated base class for templated Array class.

ArrayBase is only used to factor out common code from the templated Array class.

Definition at line 72 of file ArrayBase.h.

Constructor & Destructor Documentation

casa::ArrayBase::ArrayBase ( )

casa::ArrayBase::ArrayBase ( const IPosition & shape ) [explicit]

Create an array of the given shape, i.e.

after construction array.ndim() == shape.nelements() and array.shape() == shape. The origin of the Array is zero.

casa::ArrayBase::ArrayBase ( const ArrayBase & other )

Copy constructor.

virtual casa::ArrayBase::~ArrayBase ( ) [virtual]

Destructor.

Member Function Documentation

static uInt casa::ArrayBase::arrayVersion ( ) [inline, static]

Array version for major change (used by ArrayIO).

enum did not work properly with cfront 3.0.1), so replaced by a static inline function. Users won't normally use this.

Definition at line 136 of file ArrayBase.h.

void casa::ArrayBase::baseAddDegenerate	(	ArrayBase &	,
		uInt	numAxes
	)		`[protected]`

These member functions return an Array reference with the specified number of extra axes, all of length one, appended to the end of the Array.

Note that the reform function can also be used to add extra axes.

void casa::ArrayBase::baseCopy ( const ArrayBase & that ) [inline, protected]

Definition at line 151 of file ArrayBase.h.

References operator=().

void casa::ArrayBase::baseMakeSteps ( ) [protected]

Make the indexing step sizes.

Referenced by casa::Array< ArgType >::makeSteps().

void casa::ArrayBase::baseNonDegenerate	(	const ArrayBase &	other,
		const IPosition &	ignoreAxes
	)		`[protected]`

Remove the degenerate axes from the Array object.

This is the implementation of the nonDegenerate functions. It has a different name to be able to make it virtual without having the "hide virtual function" message when compiling derived classes.

void casa::ArrayBase::baseReform	(	ArrayBase &	tmp,
		const IPosition &	shape
	)		const `[protected]`

Reform the array to a shape with the same nr of elements.

void casa::ArrayBase::checkCubeShape ( ) [protected]

Check if the shape of a cube is correct.

Adjust it if smaller.

void casa::ArrayBase::checkMatrixShape ( ) [protected]

Check if the shape of a matrix is correct.

Adjust it if smaller.

void casa::ArrayBase::checkVectorShape ( ) [protected]

Check if the shape of a vector is correct.

If possible, adjust if not. It is possible if at most one axis has length > 1.

Bool casa::ArrayBase::conform2 ( const ArrayBase & other ) const [inline, protected]

Are the shapes identical?

Definition at line 191 of file ArrayBase.h.

References casa::IPosition::isEqual(), and length_p.

Referenced by casa::Array< ArgType >::conform().

Bool casa::ArrayBase::contiguousStorage ( ) const [inline]

Are the array data contiguous? If they are not contiguous, getStorage (see below) needs to make a copy.

Definition at line 110 of file ArrayBase.h.

References contiguous_p.

Referenced by casa::ArrayMath_global_functions_Array_mathematical_operations::arrayContTransform(), and casa::ArrayMath_global_functions_Array_mathematical_operations::arrayTransformInPlace().

Bool casa::ArrayBase::copyVectorHelper ( const ArrayBase & other ) [protected]

Helper function for templated Vector class.

It returns if this and other are conformant.

Bool casa::ArrayBase::empty ( ) const [inline]

Is the array empty (i.e.

no elements)?

Definition at line 104 of file ArrayBase.h.

References nels_p.

Referenced by casa::vi::VisBuffer2Adapter::uvw().

IPosition casa::ArrayBase::endPosition ( ) const

A convenience function: endPosition(i) = shape(i) - 1; i.e.

this is the IPosition of the last element of the Array.

virtual ArrayBase* casa::ArrayBase::getSection ( const Slicer & ) [virtual]

Get a reference to a section of an array.

This is the same as Array<T>::operator(), but without having to know the exact template type.
ArrayBase throws an exception.

Bool casa::ArrayBase::isStorageContiguous ( ) const [protected]

Determine if the storage of a subset is contiguous.

virtual ArrayPositionIterator* casa::ArrayBase::makeIterator ( uInt byDim ) [virtual]

Create an ArrayIterator object of the correct type.

This is implemented in the derived Array classes.
ArrayBase throws an exception.

size_t casa::ArrayBase::makeSubset	(	ArrayBase &	out,
		const IPosition &	b,
		const IPosition &	e,
		const IPosition &	i
	)		`[protected]`

Make a subset of an array.

It checks if start,end,incr are within the array limits. It returns the offset of the subset in the array.

uInt casa::ArrayBase::ndim ( ) const [inline]

The dimensionality of this array.

Definition at line 92 of file ArrayBase.h.

References ndimen_p.

Referenced by casa::Array< ArgType >::setEndIter().

size_t casa::ArrayBase::nelements ( ) const [inline]

How many elements does this array have? Product of all axis lengths.

Definition at line 97 of file ArrayBase.h.

References nels_p.

Referenced by casa::dbus::af(), casa::areEQ(), casa::VisibilityIteratorReadImpl::CJones(), casa::TabVecRep< T >::conform(), casa::MSSelection::getDDIDList(), casa::SpectralElement::getOrder(), casa::MSSelection::getStateObsModeList(), casa::MSAsRaster::ind_(), casa::ColumnsIndexArray::isUnique(), casa::ColumnsIndex::isUnique(), casa::WorldCanvas::ColorIndexedImage_::maskValid(), casa::ArrayMath_global_functions_Array_mathematical_operations::median(), casa::ArrayMath_global_functions_Array_mathematical_operations::medianInPlace(), casa::CalInterpolation::nAxes(), casa::LCSlicer::ndim(), casa::ArrayLogical_global_functions_Array_logical_operations::ntrue(), casa::MSAsRaster::MSpos_::p0(), and casa::Vector< ArgType >::resize().

virtual Bool casa::ArrayBase::ok ( ) const [virtual]

Check to see if the Array is consistent.

This is about the same thing as checking for invariants. If AIPS_DEBUG is defined, this is invoked after construction and on entry to most member functions.

ArrayBase& casa::ArrayBase::operator= ( const ArrayBase & )

Assignment.

Referenced by baseCopy().

const IPosition& casa::ArrayBase::shape ( ) const [inline]

The length of each axis.

Definition at line 119 of file ArrayBase.h.

References length_p.

Referenced by casa::ArrayMath_global_functions_Array_mathematical_operations::checkArrayShapes(), casa::SynthesisUtils::SETVEC(), and casa::HDF5Record::writeArr().

size_t casa::ArrayBase::size ( ) const [inline]

Definition at line 99 of file ArrayBase.h.

References nels_p.

Referenced by casa::ArrayLogical_global_functions_Array_logical_operations::allSame(), casa::PMS::fromIntVector(), casa::FITSImgParser::has_qualityimg(), casa::RSUtils::pixelToScreen(), casa::RSUtils::screenToPixel(), casa::RSUtils::screenToWorld(), and casa::RegionShape::screenToWorld().

const IPosition& casa::ArrayBase::steps ( ) const [inline]

Return steps to be made if stepping one element in a dimension.

This is the 'physical' step, thus it also works correctly for non-contiguous arrays. E.g. data() + steps(0) gives the second element of the first axis.

Definition at line 130 of file ArrayBase.h.

References steps_p.

void casa::ArrayBase::throwNdimVector ( ) [protected]

Throw expection if vector dimensionality is incorrect.

void casa::ArrayBase::validateConformance ( const ArrayBase & ) const

Various helper functions.

void casa::ArrayBase::validateIndex ( const IPosition & ) const

Referenced by casa::Cube< Complex >::at(), casa::Cube< Complex >::operator()(), casa::Matrix< uInt >::operator()(), and casa::Vector< ArgType >::operator()().

void casa::ArrayBase::validateIndex ( uInt index ) const