casacore::Vector< T > Class Template Reference

A 1-D Specialization of the Array class. More...

#include <Vector.h>

Inheritance diagram for casacore::Vector< T >:

Public Member Functions
	Vector ()
	A zero-length Vector.
	Vector (size_t Length)
	A Vector with a defined length and origin of zero.
	Vector (size_t Length, ArrayInitPolicy initPolicy)
	Vector (const IPosition &Length)
	Vector (const IPosition &Length, ArrayInitPolicy initPolicy)
	Vector (size_t Length, const T &initialValue)
	A Vector with a defined length and origin of zero.
	Vector (const IPosition &Length, const T &initialValue)
	Vector (const Block< T > &other, Int64 nr)
	Create a Vector from the given Block "other." Make it length "nr" and copy over that many elements.
	Vector (const Block< T > &other)
	Create a Vector of length other.nelements() and copy over its values.
	Vector (const Vector< T > &other)
	Create a reference to other.
	Vector (const Array< T > &other)
	Create a reference to the other array.
	Vector (const IPosition &shape, T *storage, StorageInitPolicy policy=COPY)
	Create an Vector of a given shape from a pointer.
	Vector (const IPosition &shape, T *storage, StorageInitPolicy policy, AbstractAllocator< T > const &allocator)
	Create an Vector of a given shape from a pointer.
	Vector (const IPosition &shape, const T *storage)
	Create an Vector of a given shape from a pointer.
template<class U , class V >
	Vector (const vector< U, V > &other)
	Create a Vector from an STL vector (see `tovector()` in Array for the reverse operation).
template<typename Iterator >
	Vector (Iterator first, size_t size, int dummy)
	Create a Vector from a container iterator and its length.
virtual	~Vector ()
	Define a destructor, otherwise the compiler makes a static one.
virtual void	assign (const Array< T > &other)
	Assign the other array (which must be of dimension one) to this vector.
virtual void	reference (const Array< T > &other)
	Create a reference to "other", which must be of dimension one.
void	resize (size_t len, Bool copyValues=False)
void	resize (size_t len, Bool copyValues, ArrayInitPolicy policy)
virtual void	resize ()
	Make this array a different shape.
virtual void	resize (const IPosition &len, Bool copyValues, ArrayInitPolicy policy)
	Resize the array and optionally copy the values.
Vector< T > &	operator= (const Vector< T > &other)
	Assign to this Vector.
virtual Array< T > &	operator= (const Array< T > &other)
	Other must be a 1-dimensional array.
Array< T > &	operator= (const T &val)
	Set every element of this Vector to Val.
Vector< T > &	operator= (const MaskedArray< T > &marray)
	Copy to this those values in marray whose corresponding elements in marray's mask are True.
void	toBlock (Block< T > &other) const
	Convert a Vector to a Block, resizing the block and copying values.
T &	operator[] (size_t index)
	Single-pixel addressing.
const T &	operator[] (size_t index) const
	Get the subset given by the i-th value of the last axis.
T &	operator() (const IPosition &i)
	Access a single element of the array.
const T &	operator() (const IPosition &i) const
T &	operator() (size_t index)
const T &	operator() (size_t index) const
Vector< T >	operator() (const Slice &slice)
	Take a slice of this vector.
const Vector< T >	operator() (const Slice &slice) const
Array< T >	operator() (const IPosition &blc, const IPosition &trc, const IPosition &incr)
	Slice using IPositions.
const Array< T >	operator() (const IPosition &blc, const IPosition &trc, const IPosition &incr) const
Array< T >	operator() (const IPosition &blc, const IPosition &trc)
	Get a reference to an array section extending from start to end (inclusive).
const Array< T >	operator() (const IPosition &blc, const IPosition &trc) const
Array< T >	operator() (const Slicer &slicer)
	Get a reference to an array section using a Slicer.
const Array< T >	operator() (const Slicer &slicer) const
MaskedArray< T >	operator() (const LogicalArray &mask) const
	The array is masked by the input LogicalArray.
MaskedArray< T >	operator() (const LogicalArray &mask)
	Return a MaskedArray.
MaskedArray< T >	operator() (const MaskedLogicalArray &mask) const
	The array is masked by the input MaskedLogicalArray.
MaskedArray< T >	operator() (const MaskedLogicalArray &mask)
	Return a MaskedArray.
const IPosition &	shape () const
	The length of the Vector.
void	shape (Int &Shape) const
virtual Bool	ok () const
	Verify that dimensionality is 1 and then call Array<T>::ok().
Protected Member Functions
virtual void	preTakeStorage (const IPosition &shape)
	pre/post processing hook of takeStorage() for subclasses.
virtual void	doNonDegenerate (const Array< T > &other, const IPosition &ignoreAxes)
	Remove the degenerate axes from other and store result in this vector.
Private Member Functions
void	initVector (const Block< T > &, Int64 nr)
	Helper functions for constructors.

Detailed Description

template<class T>
class casacore::Vector< T >

A 1-D Specialization of the Array class.

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25

Vector objects are one-dimensional specializations (e.g., more convenient and efficient indexing) of the general Array class. You might also want to look at the Array documentation to see inherited functionality.

Generally the member functions of Array are also available in Vector versions which take an integer where the array needs an IPosition. Since the Vector is one-dimensional, the IPositions are overkill, although you may use those versions if you want to.

 Vector<Int> vi(100);  // Vector 100 elements long.
 vi.resize(50);        // Now only 50 long.

Slices may be taken with the Slice class. To take a slice, one "indexes" with Slice(start, length, inc) where end and inc are optional.

 Vector<Float> vf(100);
 //..\.
 vf(Slice(0,50,2)) = vf(Slice(1,50,2));  // Copy values from odd onto even
 Vector<Float> firstHalf, secondHalf;
 firstHalf.reference(vf(Slice(0,50)));
 secondHalf.reference(vf(Slice(50,50)));
 // Now we have aliases for two slices into the Vector

Element-by-element arithmetic and logical operations are available (in aips/ArrayMath.h and aips/ArrayLogical.h) as well as dot and cross products (in aips/MatrixMath.h).

A Vector can be constructed from an STL vector. The reverse operation (Array::tovector()) can construct an STL vector from any Array.
Tip: To create any other STL container from an Array (or the reverse), always create from/to a vector, and use the range constructor to create from/to others (like set, list, deque);

As with the Arrays, if the preprocessor symbol AIPS_DEBUG is defined at compile time invariants will be checked on entry to most member functions. Additionally, if AIPS_ARRAY_INDEX_CHECK is defined index operations will be bounds-checked. Neither of these should be defined for production code.

Definition at line 92 of file Vector.h.

Constructor & Destructor Documentation

template<class T>

casacore::Vector< T >::Vector ( )

A zero-length Vector.

template<class T>

casacore::Vector< T >::Vector ( size_t Length ) [explicit]

A Vector with a defined length and origin of zero.

template<class T>

casacore::Vector< T >::Vector	(	size_t	Length,
		ArrayInitPolicy	initPolicy
	)

template<class T>

casacore::Vector< T >::Vector ( const IPosition & Length ) [explicit]

template<class T>

casacore::Vector< T >::Vector	(	const IPosition &	Length,
		ArrayInitPolicy	initPolicy
	)

template<class T>

casacore::Vector< T >::Vector	(	size_t	Length,
		const T &	initialValue
	)

A Vector with a defined length and origin of zero.

Fill it with the initial value.

template<class T>

casacore::Vector< T >::Vector	(	const IPosition &	Length,
		const T &	initialValue
	)

template<class T>

casacore::Vector< T >::Vector	(	const Block< T > &	other,
		Int64	nr
	)

Create a Vector from the given Block "other." Make it length "nr" and copy over that many elements.

template<class T>

casacore::Vector< T >::Vector ( const Block< T > & other ) [explicit]

Create a Vector of length other.nelements() and copy over its values.

template<class T>

casacore::Vector< T >::Vector ( const Vector< T > & other )

Create a reference to other.

template<class T>

casacore::Vector< T >::Vector ( const Array< T > & other )

Create a reference to the other array.

It is always possible if the array has zero or one axes. If it has > 1 axes, it is only possible if the array has at most one axis with length > 1. In that case the degenerated axes are removed.

template<class T>

casacore::Vector< T >::Vector	(	const IPosition &	shape,
		T *	storage,
		StorageInitPolicy	policy = `COPY`
	)

Create an Vector of a given shape from a pointer.

template<class T>

casacore::Vector< T >::Vector	(	const IPosition &	shape,
		T *	storage,
		StorageInitPolicy	policy,
		AbstractAllocator< T > const &	allocator
	)

Create an Vector of a given shape from a pointer.

template<class T>

casacore::Vector< T >::Vector	(	const IPosition &	shape,
		const T *	storage
	)

Create an Vector of a given shape from a pointer.

Because the pointer is const, a copy is always made.

template<class T>

template<class U , class V >

casacore::Vector< T >::Vector ( const vector< U, V > & other ) [inline]

Create a Vector from an STL vector (see tovector() in Array for the reverse operation).

Tip: Both this constructor and the tovector() are defined in Vector2;cc;
It does implicit promotion/demotion of the type U if different from T.

template<class T>

template<typename Iterator >

casacore::Vector< T >::Vector	(	Iterator	first,
		size_t	size,
		int	dummy
	)			`[inline]`

Create a Vector from a container iterator and its length.

Note: The length is used instead of last, because the distance function needed to calculate the length can be expensive;
A third dummy argument is unfortunately needed to avoid ambiguity with another Vector constructor (taking two uInts);

template<class T>

virtual casacore::Vector< T >::~Vector ( ) [virtual]

Define a destructor, otherwise the compiler makes a static one.

Member Function Documentation

template<class T>

virtual void casacore::Vector< T >::assign ( const Array< T > & other ) [virtual]

Assign the other array (which must be of dimension one) to this vector.

If the shapes mismatch, this array is resized.

Referenced by casa::sdfiller::DataChunk::accumulate().

template<class T>

virtual void casacore::Vector< T >::doNonDegenerate	(	const Array< T > &	other,
		const IPosition &	ignoreAxes
	)			`[protected, virtual]`

Remove the degenerate axes from other and store result in this vector.

An exception is thrown if removing degenerate axes does not result in a vector.

template<class T>

void casacore::Vector< T >::initVector	(	const Block< T > &	,
		Int64	nr
	)			`[private]`

Helper functions for constructors.

template<class T>

virtual Bool casacore::Vector< T >::ok ( ) const [virtual]

Verify that dimensionality is 1 and then call Array<T>::ok().

const Array<T> casacore::Vector< T >::operator()	(	const IPosition &	blc,
		const IPosition &	trc
	)			const `[inline]`

Array<T> casacore::Vector< T >::operator()	(	const IPosition &	start,
		const IPosition &	end
	)			`[inline]`

virtual void casacore::Vector< T >::resize	(	const IPosition &	newShape,
		Bool	copyValues,
		ArrayInitPolicy	policy
	)			`[virtual]`

void casacore::Vector< T >::resize	(	size_t	len,
		Bool	copyValues,
		ArrayInitPolicy	policy
	)			`[inline]`

casacore::Vector< T > Class Template Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

template<class T> class casacore::Vector< T >

Review Status

Constructor & Destructor Documentation

Member Function Documentation

template<class T>
class casacore::Vector< T >