casacore
QVector.h
Go to the documentation of this file.
1//# Quantum.h: class to manipulate physical, dimensioned quantities
2//# Copyright (C) 1994,1995,1996,1997,1998,1999,2000,2001
3//# Associated Universities, Inc. Washington DC, USA.
4//#
5//# This library is free software; you can redistribute it and/or modify it
6//# under the terms of the GNU Library General Public License as published by
7//# the Free Software Foundation; either version 2 of the License, or (at your
8//# option) any later version.
9//#
10//# This library is distributed in the hope that it will be useful, but WITHOUT
11//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13//# License for more details.
14//#
15//# You should have received a copy of the GNU Library General Public License
16//# along with this library; if not, write to the Free Software Foundation,
17//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18//#
19//# Correspondence concerning AIPS++ should be addressed as follows:
20//# Internet email: aips2-request@nrao.edu.
21//# Postal address: AIPS++ Project Office
22//# National Radio Astronomy Observatory
23//# 520 Edgemont Road
24//# Charlottesville, VA 22903-2475 USA
25//#
26//# $Id: Quantum.h 20993 2010-11-08 13:36:32Z gervandiepen $
27
28#ifndef CASA_QVECTOR_H
29#define CASA_QVECTOR_H
30
31//# Includes
32#include <casacore/casa/aips.h>
33#include <casacore/casa/Quanta/Quantum.h>
34
35namespace casacore { //# NAMESPACE CASACORE - BEGIN
36
37template <class T> class QVector;
38
40
41// <summary>
42// Specialization for Quantum<Vector<T> >
43// </summary>
44
45// <use visibility=export>
46//
47// <prerequisite>
48// <li> <linkto class=Quantum>Quantum</linkto>
49// </prerequisite>
50//
51// <etymology>
52// Vector of quantities.
53// </etymology>
54//
55// <synopsis>
56// Objects of type Quantum<Vector<Double> > are used often in our code.
57// We need a way to access individual elements easily
58// </synopsis>
59
60template <class T> class QVector : public Quantum<Vector<T> > {
61
62 public:
63
64 // zero elements
66
67 QVector(const Vector<T>& v, const Unit& u);
68
69 // convert a Vector of Quanta to a QVector. Useful
70 // when reading a table column of Quanta. All elements in
71 // q will be converted to units of the first element in q.
72 // An exception will be thrown if not all elements in q conform
73 // to the same unit.
75
76 // access single element
78
79 size_t size() const;
80
81 size_t nelements() const;
82
83 void scale(T d);
84
85 // add operators as needed
89
90
91 Quantum<T> min() const;
92
93 Quantum<T> max() const;
94
95};
96
97}
98
99#ifndef CASACORE_NO_AUTO_TEMPLATES
100#include <casacore/casa/Quanta/QVector.tcc>
101#endif
102
103#endif
size_t nelements() const
QVector< T > operator+(const QVector< T > &d) const
add operators as needed
Quantum< T > min() const
Quantum< T > operator[](uInt index) const
access single element
size_t size() const
QVector(const Vector< Quantum< T > > &q)
convert a Vector of Quanta to a QVector.
Quantum< T > max() const
QVector< T > operator-(const QVector< T > &d) const
QVector()
zero elements
QVector< T > operator/(T d) const
QVector(const Vector< T > &v, const Unit &u)
this file contains all the compiler specific defines
Definition: mainpage.dox:28
unsigned int uInt
Definition: aipstype.h:51
QVector< Double > QVD
Definition: QVector.h:39