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

#include <ArrayBase.h>

Inheritance diagram for casacore::ArrayBase:

Public Member Functions
	ArrayBase () noexcept

	ArrayBase (const IPosition &shape)
	Create an array of the given shape, i.e. More...

	ArrayBase (const ArrayBase &other)
	Copy constructor. More...

	ArrayBase (ArrayBase &&source) noexcept

ArrayBase &	assign (const ArrayBase &)
	Assignment. More...

ArrayBase &	operator= (const ArrayBase &)=delete

ArrayBase &	operator= (ArrayBase &&) noexcept

virtual	~ArrayBase () noexcept
	Destructor. More...

size_t	ndim () const
	The dimensionality of this array. More...

size_t	nelements () const
	How many elements does this array have? Product of all axis lengths. More...

size_t	size () const

bool	empty () const
	Is the array empty (i.e. More...

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

virtual bool	ok () const
	Check to see if the Array is consistent. More...

const IPosition &	shape () const
	The length of each axis. More...

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

const IPosition &	steps () const
	Return steps to be made if stepping one element in a dimension. More...

virtual std::unique_ptr < ArrayBase >	makeArray () const
	Make an empty array of the same type. More...

virtual void	resize (const IPosition &newShape, bool copyValues=false)
	Resize the array and optionally copy the values. More...

virtual std::unique_ptr < ArrayPositionIterator >	makeIterator (size_t byDim) const
	Resize the array and optionally copy the values. More...

virtual std::unique_ptr < ArrayBase >	getSection (const Slicer &) const
	Get a reference to a section of an array. More...

virtual void	assignBase (const ArrayBase &source, bool checkType=true)
	Assign the source array to this array. More...

virtual void *	getVStorage (bool &deleteIt)
	The following functions behave the same as the corresponding getStorage functions in the derived templated Array class. More...

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

void	validateIndex (const IPosition &) const

void	validateIndex (size_t index) const

void	validateIndex (size_t index1, size_t index2) const

void	validateIndex (size_t index1, size_t index2, size_t index3) const

Static Public Member Functions
static unsigned	arrayVersion ()
	Array version for major change (used by ArrayIO). More...

Protected Member Functions
	ArrayBase (ArrayBase &&source, const IPosition &shapeForSource) noexcept
	For subclasses, this move constructor allows the moved-from object to obtain a given shape after resizing. More...

void	swap (ArrayBase &source) noexcept

bool	reformOrResize (const IPosition &newShape, bool resizeIfNeeded, size_t nReferences, long long nElementsAllocated, bool copyDataIfNeeded, size_t resizePercentage)
	Either reforms the array if size permits or resizes it to the new shape. More...

bool	isStorageContiguous () const
	Determine if the storage of a subset is contiguous. More...

void	checkVectorShape ()
	Check if the shape of a vector is correct. More...

void	checkMatrixShape ()
	Check if the shape of a matrix is correct. More...

void	checkCubeShape ()
	Check if the shape of a cube is correct. More...

void	baseReform (ArrayBase &tmp, const IPosition &shape, bool strict=true) const
	Reform the array to a shape with the same nr of elements. More...

void	baseNonDegenerate (const ArrayBase &other, const IPosition &ignoreAxes)
	Remove the degenerate axes from the Array object. More...

void	baseAddDegenerate (ArrayBase &, size_t 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. More...

size_t	makeSubset (ArrayBase &out, const IPosition &b, const IPosition &e, const IPosition &i)
	Make a subset of an array. More...

size_t	makeDiagonal (size_t firstAxis, long long diag)
	Set the length and stride such that the diagonal of the matrices defined by two consecutive axes is formed. More...

bool	conform2 (const ArrayBase &other) const
	Are the shapes identical? More...

void	baseMakeSteps ()
	Make the indexing step sizes. More...

bool	copyVectorHelper (const ArrayBase &other)
	Helper function for templated Vector class. More...

Protected Attributes
size_t	nels_p
	Number of elements in the array. More...

size_t	ndimen_p
	Dimensionality of the array. More...

bool	contiguous_p
	Are the data contiguous? More...

IPosition	length_p
	Used to hold the shape, increment into the underlying storage and originalLength of the array. More...

IPosition	inc_p

IPosition	originalLength_p

IPosition	steps_p
	Used to hold the step to next element in each dimension. More...

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

casacore::ArrayBase::ArrayBase ( )

noexcept

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.

casacore::ArrayBase::ArrayBase ( ArrayBase && source )

noexcept

virtual casacore::ArrayBase::~ArrayBase ( )

virtualnoexcept

Destructor.

casacore::ArrayBase::ArrayBase	(	ArrayBase &&	source,
		const IPosition &	shapeForSource
	)

protectednoexcept

For subclasses, this move constructor allows the moved-from object to

obtain a given shape after resizing.

This way, e.g. a source Matrix can still kee a dimensionality of 2.

Member Function Documentation

static unsigned casacore::ArrayBase::arrayVersion ( )

inlinestatic

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 142 of file ArrayBase.h.

ArrayBase& casacore::ArrayBase::assign ( const ArrayBase & )

Assignment.

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 &	,
		size_t	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::baseMakeSteps ( )

protected

Make the indexing step sizes.

Referenced by casacore::Array< T, std::allocator< T > >::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

inlineprotected

Are the shapes identical?

Definition at line 247 of file ArrayBase.h.

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

Referenced by casacore::Array< T, std::allocator< T > >::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 116 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 110 of file ArrayBase.h.

References nels_p.

Referenced by casacore::MArrayBase::hasMask().

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

Referenced by casacore::Adios2StManColumnT< std::string >::toAdios().

virtual std::unique_ptr<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 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.

Referenced by casacore::Adios2StManColumnT< std::string >::fromAdios(), and casacore::Adios2StManColumnT< std::string >::toAdios().

virtual const void* casacore::ArrayBase::getVStorage ( bool & deleteIt ) const

virtual

bool casacore::ArrayBase::isStorageContiguous ( ) const

protected

Determine if the storage of a subset is contiguous.

virtual std::unique_ptr<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	(	size_t	firstAxis,
		long long	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 std::unique_ptr<ArrayPositionIterator> casacore::ArrayBase::makeIterator ( size_t byDim ) const

virtual

Resize the array and optionally copy the values.

The default implementation in ArrayBase throws an exception. virtual void resize(const IPosition &newShape, bool copyValues, ArrayInitPolicy policy);

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.

size_t casacore::ArrayBase::ndim ( ) const

inline

The dimensionality of this array.

Definition at line 98 of file ArrayBase.h.

References ndimen_p.

Referenced by casacore::Matrix< Complex >::assign_conforming(), casacore::ArrayMath_global_functions_Array_mathematical_operations::expandArray(), casacore::Cube< casacore::RigidVector< Double, 2 > >::operator=(), casacore::TableProxy::record2Array(), and casacore::Array< T, std::allocator< T > >::setEndIter().

size_t casacore::ArrayBase::nelements ( ) const

inline

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

Definition at line 103 of file ArrayBase.h.

References nels_p.

Referenced by casacore::areEQ(), casacore::TabVecRep< T >::conform(), casacore::MSSelection::getDDIDList(), casacore::MSSelection::getSPWDDIDList(), casacore::MSSelection::getStateObsModeList(), casacore::ColumnsIndexArray::isUnique(), casacore::ColumnsIndex::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::FunctionParam< Domain >::nelements(), casacore::ArrayLogical_global_functions_Array_logical_operations::ntrue(), and casacore::Vector< ArgType >::resize().

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 & )

delete

ArrayBase& casacore::ArrayBase::operator= ( ArrayBase && )

noexcept

virtual void casacore::ArrayBase::putVStorage	(	void *&	storage,
		bool	deleteAndCopy
	)

virtual

Referenced by casacore::Adios2StManColumnT< std::string >::fromAdios().

bool casacore::ArrayBase::reformOrResize	(	const IPosition &	newShape,
		bool	resizeIfNeeded,
		size_t	nReferences,
		long long	nElementsAllocated,
		bool	copyDataIfNeeded,
		size_t	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 = `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 125 of file ArrayBase.h.

References length_p.

Referenced by casacore::checkArrayShapes(), casacore::ArrayMath_global_functions_Array_mathematical_operations::expandArray(), casacore::MArray< casacore::String >::fill(), casacore::ArrayMath_global_functions_Array_mathematical_operations::operator*(), casacore::ArrayMath_global_functions_Array_mathematical_operations::operator/(), casacore::MArrayMath_global_functions_MArray_mathematical_operations::partialArrayMath(), casacore::TableProxy::record2Array(), casacore::LELArray< Bool >::shape(), and casacore::HDF5Record::writeArr().

size_t casacore::ArrayBase::size ( ) const

inline

Definition at line 105 of file ArrayBase.h.

References nels_p.

Referenced by casacore::CoordinateSystem::_downcase(), casacore::ArrayLogical_global_functions_Array_logical_operations::allSame(), casacore::TableParseSelect::doGroupByAggrSingleKey(), casacore::MArray< T >::flatten(), and casacore::TableExprNodeSet::toArray().

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 136 of file ArrayBase.h.

References steps_p.

void casacore::ArrayBase::swap ( ArrayBase & source )

protectednoexcept

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

Various helper functions.

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

Referenced by casacore::Vector< ArgType >::operator()().

void casacore::ArrayBase::validateIndex ( size_t index ) const

void casacore::ArrayBase::validateIndex	(	size_t	index1,
		size_t	index2
	)		const

void casacore::ArrayBase::validateIndex	(	size_t	index1,
		size_t	index2,
		size_t	index3
	)		const

Member Data Documentation

bool casacore::ArrayBase::contiguous_p

protected

Are the data contiguous?

Definition at line 273 of file ArrayBase.h.

Referenced by contiguousStorage(), casacore::Matrix< Complex >::operator()(), casacore::Vector< ArgType >::operator[](), and casacore::Array< T, std::allocator< T > >::setEndIter().

IPosition casacore::ArrayBase::inc_p

protected

Definition at line 276 of file ArrayBase.h.

Referenced by casacore::Cube< casacore::RigidVector< Double, 2 > >::index(), casacore::Cube< casacore::RigidVector< Double, 2 > >::index_continuous(), casacore::Vector< ArgType >::operator()(), casacore::Vector< ArgType >::operator[](), casacore::Cube< casacore::RigidVector< Double, 2 > >::xinc(), casacore::Matrix< Complex >::xinc(), casacore::Cube< casacore::RigidVector< Double, 2 > >::yinc(), casacore::Matrix< Complex >::yinc(), and casacore::Cube< casacore::RigidVector< Double, 2 > >::zinc().

IPosition casacore::ArrayBase::length_p

protected

Used to hold the shape, increment into the underlying storage and originalLength of the array.

Definition at line 276 of file ArrayBase.h.

Referenced by conform2(), casacore::Cube< casacore::RigidVector< Double, 2 > >::ncolumn(), casacore::Matrix< Complex >::ncolumn(), casacore::Cube< casacore::RigidVector< Double, 2 > >::nplane(), casacore::Cube< casacore::RigidVector< Double, 2 > >::nrow(), casacore::Matrix< Complex >::nrow(), casacore::Array< T, std::allocator< T > >::setEndIter(), shape(), casacore::Cube< casacore::RigidVector< Double, 2 > >::shape(), casacore::Matrix< Complex >::shape(), and casacore::Vector< ArgType >::shape().

size_t casacore::ArrayBase::ndimen_p

protected

Dimensionality of the array.

Definition at line 271 of file ArrayBase.h.

Referenced by ndim().

size_t casacore::ArrayBase::nels_p

protected

Number of elements in the array.

Cached rather than computed.

Definition at line 269 of file ArrayBase.h.

Referenced by empty(), nelements(), casacore::Array< T, std::allocator< T > >::setEndIter(), and size().

IPosition casacore::ArrayBase::originalLength_p

protected

Definition at line 276 of file ArrayBase.h.

Referenced by casacore::Cube< casacore::RigidVector< Double, 2 > >::index(), casacore::Cube< casacore::RigidVector< Double, 2 > >::index_continuous(), casacore::Cube< casacore::RigidVector< Double, 2 > >::yinc(), casacore::Matrix< Complex >::yinc(), and casacore::Cube< casacore::RigidVector< Double, 2 > >::zinc().

IPosition casacore::ArrayBase::steps_p

protected

Used to hold the step to next element in each dimension.

Definition at line 278 of file ArrayBase.h.

Referenced by casacore::Array< T, std::allocator< T > >::setEndIter(), and steps().

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

casa/Arrays/ArrayBase.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation