casacore::ArrayBase Class Reference

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

#include <ArrayBase.h>

Inheritance diagram for casacore::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 CountedPtr< ArrayBase >	makeArray () const
	Make an empty array of the same type.
virtual void	resize (const IPosition &newShape, Bool copyValues=False)
	Resize the array and optionally copy the values.
virtual void	resize (const IPosition &newShape, Bool copyValues, ArrayInitPolicy policy)
	Resize the array and optionally copy the values.
virtual CountedPtr < ArrayPositionIterator >	makeIterator (uInt byDim) const
	Create an ArrayIterator object of the correct type.
virtual CountedPtr< ArrayBase >	getSection (const Slicer &) const
	Get a reference to a section of an array.
virtual void	assignBase (const ArrayBase &source, Bool checkType=True)
	Assign the source array to this array.
virtual void *	getVStorage (Bool &deleteIt)
	The following functions behave the same as the corresponding getStorage functions in the derived templated Array class.
virtual const void *	getVStorage (Bool &deleteIt) const
virtual void	putVStorage (void *&storage, Bool deleteAndCopy)
virtual void	freeVStorage (const void *&storage, Bool deleteIt) const
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	reformOrResize (const IPosition &newShape, Bool resizeIfNeeded, uInt nReferences, Int64 nElementsAllocated, Bool copyDataIfNeeded, uInt resizePercentage)
	Either reforms the array if size permits or resizes it to the new shape.
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, Bool strict=True) 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.
size_t	makeDiagonal (uInt firstAxis, Int64 diag)
	Set the length and stride such that the diagonal of the matrices defined by two consecutive axes is formed.
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
	Number of elements in the array.
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 74 of file ArrayBase.h.

Constructor & Destructor Documentation

casacore::ArrayBase::ArrayBase ( )

casacore::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.

casacore::ArrayBase::ArrayBase ( const ArrayBase & other )

Copy constructor.

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

Destructor.

Member Function Documentation

static uInt casacore::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 138 of file ArrayBase.h.

virtual void casacore::ArrayBase::assignBase	(	const ArrayBase &	source,
		Bool	checkType = `True`
	)			`[virtual]`

Assign the source array to this array.

If checkType==True, it is checked if the underlying template types match. Otherwise, it is only checked in debug mode (for performance).
The default implementation in ArrayBase throws an exception.

void casacore::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 casacore::ArrayBase::baseCopy ( const ArrayBase & that ) [inline, protected]

Definition at line 182 of file ArrayBase.h.

References operator=().

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

Make the indexing step sizes.

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

void casacore::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 casacore::ArrayBase::baseReform	(	ArrayBase &	tmp,
		const IPosition &	shape,
		Bool	strict = `True`
	)			const `[protected]`

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

If nonStrict then caller assumes responsibility for not overrunning storage (avoid or use with extreme care).

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

Check if the shape of a cube is correct.

Adjust it if smaller.

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

Check if the shape of a matrix is correct.

Adjust it if smaller.

void casacore::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 casacore::ArrayBase::conform2 ( const ArrayBase & other ) const [inline, protected]

Are the shapes identical?

Definition at line 239 of file ArrayBase.h.

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

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

Bool casacore::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 112 of file ArrayBase.h.

References contiguous_p.

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

Helper function for templated Vector class.

It returns if this and other are conformant.

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

Is the array empty (i.e.

no elements)?

Definition at line 106 of file ArrayBase.h.

References nels_p.

Referenced by casa::sdfiller::DataChunk::accumulate(), casacore::ImageBeamSet::empty(), casacore::MArrayBase::hasMask(), casa::sdfiller::DataAccumulator::isValidRecord(), and casa::sdfiller::DataChunk::isValidRecord().

IPosition casacore::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 void casacore::ArrayBase::freeVStorage	(	const void *&	storage,
		Bool	deleteIt
	)			const `[virtual]`

virtual CountedPtr<ArrayBase> casacore::ArrayBase::getSection ( const Slicer & ) const [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.
The default implementation in ArrayBase throws an exception.

virtual const void* casacore::ArrayBase::getVStorage ( Bool & deleteIt ) const [virtual]

virtual void* casacore::ArrayBase::getVStorage ( Bool & deleteIt ) [virtual]

The following functions behave the same as the corresponding getStorage functions in the derived templated Array class.

They handle a pointer to a contiguous block of array data. If the array is not contiguous, a copy is used to make it contiguous.

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

Determine if the storage of a subset is contiguous.

virtual CountedPtr<ArrayBase> casacore::ArrayBase::makeArray ( ) const [virtual]

Make an empty array of the same type.

The default implementation in ArrayBase throws an exception.

size_t casacore::ArrayBase::makeDiagonal	(	uInt	firstAxis,
		Int64	diag
	)			`[protected]`

Set the length and stride such that the diagonal of the matrices defined by two consecutive axes is formed.

diag == 0 indicates the main diagonal, >0 above, <0 below. It returns the offset of the diagonal in the (original) array.

virtual CountedPtr<ArrayPositionIterator> casacore::ArrayBase::makeIterator ( uInt byDim ) const [virtual]

Create an ArrayIterator object of the correct type.

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

size_t casacore::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 (original) array.

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

The dimensionality of this array.

Definition at line 94 of file ArrayBase.h.

References ndimen_p.

Referenced by casacore::TableProxy::record2Array(), and casacore::Array< ArgType >::setEndIter().

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

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

Definition at line 99 of file ArrayBase.h.

References nels_p.

Referenced by casa::sdfiller::DataChunk::accumulate(), casacore::areEQ(), casacore::TabVecRep< T >::conform(), casacore::MSSelection::getDDIDList(), casacore::MSSelection::getSPWDDIDList(), casacore::MSSelection::getStateObsModeList(), casacore::ColumnsIndex::isUnique(), casacore::ColumnsIndexArray::isUnique(), casacore::ArrayMath_global_functions_Array_mathematical_operations::madfm(), casacore::ArrayMath_global_functions_Array_mathematical_operations::madfmInPlace(), casacore::ArrayMath_global_functions_Array_mathematical_operations::median(), casacore::ArrayMath_global_functions_Array_mathematical_operations::medianInPlace(), casacore::LCSlicer::ndim(), casacore::ArrayLogical_global_functions_Array_logical_operations::ntrue(), casacore::Vector< ArgType >::resize(), and casa::ScantableFrequenciesIterator::ScantableFrequenciesIterator().

virtual Bool casacore::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& casacore::ArrayBase::operator= ( const ArrayBase & )

Assignment.

Reimplemented in casacore::Array< T >, casacore::Cube< T >, casacore::Matrix< T >, casacore::Vector< T >, casacore::Array< double >, casacore::Array< recordType >, casacore::Array< Range >, casacore::Array< DComplex >, casacore::Array< Type >, casacore::Array< Complex >, casacore::Array< Domain >, casacore::Array< ArgType >, casacore::Matrix< Complex >, casacore::Vector< double >, casacore::Vector< Range >, casacore::Vector< Type >, casacore::Vector< Domain >, and casacore::Vector< ArgType >.

Referenced by baseCopy().

virtual void casacore::ArrayBase::putVStorage	(	void *&	storage,
		Bool	deleteAndCopy
	)			`[virtual]`

Bool casacore::ArrayBase::reformOrResize	(	const IPosition &	newShape,
		Bool	resizeIfNeeded,
		uInt	nReferences,
		Int64	nElementsAllocated,
		Bool	copyDataIfNeeded,
		uInt	resizePercentage
	)			`[protected]`

Either reforms the array if size permits or resizes it to the new shape.

Implementation of Array<T>::reformOrResize (slightly different signature).

virtual void casacore::ArrayBase::resize	(	const IPosition &	newShape,
		Bool	copyValues,
		ArrayInitPolicy	policy
	)			`[virtual]`

Resize the array and optionally copy the values.

The default implementation in ArrayBase throws an exception.

virtual void casacore::ArrayBase::resize	(	const IPosition &	newShape,
		Bool	copyValues = `False`
	)			`[virtual]`

Resize the array and optionally copy the values.

The default implementation in ArrayBase throws an exception.

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

The length of each axis.

Definition at line 121 of file ArrayBase.h.

References length_p.

Referenced by casacore::checkArrayShapes(), casacore::MArray< MVTime >::fill(), casacore::TableProxy::record2Array(), and casacore::HDF5Record::writeArr().

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

Definition at line 101 of file ArrayBase.h.

References nels_p.

Referenced by casacore::CoordinateSystem::_downcase(), casa::sdfiller::DataChunk::accumulate(), casacore::ArrayLogical_global_functions_Array_logical_operations::allSame(), casacore::TableParseSelect::doGroupByAggrSingleKey(), casacore::MArray< T >::flatten(), casacore::ColumnSlicer::freeSlicers(), casa::ScantableFrequenciesIterator::getEntry(), casa::ScantableSourceIterator::getEntry(), casa::ScantableFieldIterator::getEntry(), casacore::FITSImgParser::has_qualityimg(), casacore::ImageBeamSet::hasMultiBeam(), casacore::ImageBeamSet::hasSingleBeam(), casacore::ImageBeamSet::nelements(), casa::ScantableFieldIterator::ScantableFieldIterator(), casa::ScantableSourceIterator::ScantableSourceIterator(), casacore::ImageBeamSet::size(), casacore::TableExprNodeSet::toArray(), and casacore::ColumnSlicer::validateParameters().

const IPosition& casacore::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 132 of file ArrayBase.h.

References steps_p.

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

Throw expection if vector dimensionality is incorrect.

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

Various helper functions.