#include <Matrix.h>
Inheritance diagram for casa::Matrix< T >:
Matrix objects are two-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. A tutorial on using the array classes in general is available in the "AIPS++ Programming Manual".
Generally the member functions of Array are also available in Matrix versions which take a pair of integers where the array needs an IPosition. Since the Matrix is two-dimensional, the IPositions are overkill, although you may use those versions if you want to.
Matrix<Int> mi(100,100); // Shape is 100x100 mi.resize(50,50); // Shape now 50x50
Slices may be taken with the Slice class. To take a slice, one "indexes" with one Slice(start, length, inc) for each axis, where end and inc are optional. Additionally, there are row(), column() and diagonal() member functions which return Vector's which refer to the storage back in the Matrix:
Matrix<Float> mf(100, 100);
mf.diagonal() = 1;
Correct indexing order of a matrix is:
Matrix<Int> mi(n1,n2) // [nrow, ncolumn] for (uInt j=0; j<mi.ncolumn(); j++) { for (uInt i=0; i<mi.nrow(); i++) { mi(i,j) = i*j; } }
Element-by-element arithmetic and logical operations are available (in aips/ArrayMath.h and aips/ArrayLogical.h). Other Matrix operations (e.g. LU decomposition) are available, and more appear periodically.
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 93 of file Matrix.h.
Public Member Functions | |
| Matrix () | |
| A Matrix of length zero in each dimension; zero origin. | |
| Matrix (uInt l1, uInt l2) | |
| A Matrix with "l1" rows and "l2" columns. | |
| Matrix (uInt l1, uInt l2, const T &initialValue) | |
| A Matrix with "l1" rows and "l2" columns. | |
| Matrix (const IPosition &len) | |
| A matrix of shape with shape "len". | |
| Matrix (const IPosition &len, const T &initialValue) | |
| A matrix of shape with shape "len". | |
| Matrix (const Matrix< T > &other) | |
| The copy constructor uses reference semantics. | |
| Matrix (const Array< T > &other) | |
| Construct a Matrix by reference from "other". | |
| Matrix (const IPosition &shape, T *storage, StorageInitPolicy policy=COPY) | |
| Create an Matrix of a given shape from a pointer. | |
| Matrix (const IPosition &shape, const T *storage) | |
| Create an Matrix of a given shape from a pointer. | |
| virtual | ~Matrix () |
| Define a destructor, otherwise the (SUN) compiler makes a static one. | |
| virtual void | assign (const Array< T > &other) |
| Assign the other array (which must be dimension 2) to this matrix. | |
| virtual void | reference (const Array< T > &other) |
| Make this matrix a reference to other. | |
| Array< T > & | operator= (const T &val) |
| Copy val into every element of this Matrix; i.e. | |
| Matrix< T > & | operator= (const MaskedArray< T > &marray) |
| Copy to this those values in marray whose corresponding elements in marray's mask are True. | |
| Matrix< T > | operator() (const Slice &sliceX, const Slice &sliceY) |
| Take a slice of this matrix. | |
| uInt | nrow () const |
| The number of rows in the Matrix, i.e. | |
| uInt | ncolumn () const |
| The number of columns in the Matrix, i.e. | |
| virtual Bool | ok () const |
| Checks that the Matrix is consistent (invariants check out). | |
| void | resize (uInt nx, uInt ny, Bool copyValues=False) |
| Resize to the given shape (must be 2-dimensional). | |
| virtual void | resize () |
| Make this array a different shape. | |
| virtual void | resize (const IPosition &newShape, Bool copyValues=False) |
| Matrix< T > & | operator= (const Matrix< T > &other) |
| Copy the values from other to this Matrix. | |
| virtual Array< T > & | operator= (const Array< T > &other) |
| Copy the values in other to this. | |
| T & | operator() (const IPosition &i) |
| Single-pixel addressing. | |
| const T & | operator() (const IPosition &i) const |
| T & | operator() (uInt i1, uInt i2) |
| const T & | operator() (uInt i1, uInt i2) const |
| MaskedArray< T > | operator() (const LogicalArray &mask) const |
| Return a MaskedArray. | |
| MaskedArray< T > | operator() (const LogicalArray &mask) |
| Return a MaskedArray. | |
| MaskedArray< T > | operator() (const MaskedLogicalArray &mask) const |
| Return a MaskedArray. | |
| MaskedArray< T > | operator() (const MaskedLogicalArray &mask) |
| Return a MaskedArray. | |
| Vector< T > | row (uInt i) |
| Returns a reference to the i'th row. | |
| const Vector< T > | row (uInt i) const |
| Vector< T > | column (uInt j) |
| Returns a reference to the j'th column. | |
| const Vector< T > | column (uInt j) const |
| Vector< T > | diagonal () |
| Returns a diagonal from the Matrix. | |
| const Vector< T > | diagonal () const |
| Vector< T > | diagonal (Int n) |
| n==0 is the main diagonal. | |
| const Vector< T > | diagonal (Int n) const |
| Array< T > | operator() (const IPosition &blc, const IPosition &trc, const IPosition &incr) |
| Slice using IPositions. | |
| Array< T > | operator() (const IPosition &blc, const IPosition &trc) |
| Get a reference to an array which extends from "start" to end. | |
| Array< T > | operator() (const Slicer &slicer) |
| Get a reference to an array using a Slicer. | |
| void | shape (Int &s1, Int &s2) const |
| The length of each axis of the Matrix. | |
| const IPosition & | shape () const |
| The length of each axis. | |
| virtual void | takeStorage (const IPosition &shape, T *storage, StorageInitPolicy policy=COPY) |
Replace the data values with those in the pointer storage. | |
| virtual void | takeStorage (const IPosition &shape, const T *storage) |
| Since the pointer is const, a copy is always taken. | |
Protected Member Functions | |
| virtual void | doNonDegenerate (Array< T > &other, const IPosition &ignoreAxes) |
| Remove the degenerate axes from other and store result in this matrix. | |
Private Member Functions | |
| void | makeIndexingConstants () |
| Helper fn to calculate the indexing constants. | |
Private Attributes | |
| Int | xinc_p |
| Cached constants to improve indexing. | |
| Int | yinc_p |
| casa::Matrix< T >::Matrix | ( | ) |
A Matrix of length zero in each dimension; zero origin.
| casa::Matrix< T >::Matrix | ( | uInt | l1, | |
| uInt | l2 | |||
| ) |
A Matrix with "l1" rows and "l2" columns.
| casa::Matrix< T >::Matrix | ( | uInt | l1, | |
| uInt | l2, | |||
| const T & | initialValue | |||
| ) |
A Matrix with "l1" rows and "l2" columns.
Fill it with the initial value.
| casa::Matrix< T >::Matrix | ( | const IPosition & | len | ) |
A matrix of shape with shape "len".
| casa::Matrix< T >::Matrix | ( | const IPosition & | len, | |
| const T & | initialValue | |||
| ) |
A matrix of shape with shape "len".
Fill it with the initial value.
| casa::Matrix< T >::Matrix | ( | const Matrix< T > & | other | ) |
The copy constructor uses reference semantics.
| casa::Matrix< T >::Matrix | ( | const Array< T > & | other | ) |
| casa::Matrix< T >::Matrix | ( | const IPosition & | shape, | |
| T * | storage, | |||
| StorageInitPolicy | policy = COPY | |||
| ) |
Create an Matrix of a given shape from a pointer.
| casa::Matrix< T >::Matrix | ( | const IPosition & | shape, | |
| const T * | storage | |||
| ) |
Create an Matrix of a given shape from a pointer.
Because the pointer is const, a copy is always made.
| virtual casa::Matrix< T >::~Matrix | ( | ) | [virtual] |
Define a destructor, otherwise the (SUN) compiler makes a static one.
| virtual void casa::Matrix< T >::assign | ( | const Array< T > & | other | ) | [virtual] |
Assign the other array (which must be dimension 2) to this matrix.
If the shapes mismatch, this array is resized.
Reimplemented from casa::Array< T >.
| virtual void casa::Matrix< T >::reference | ( | const Array< T > & | other | ) | [virtual] |
Make this matrix a reference to other.
Other must be of dimensionality 2 or less.
Reimplemented from casa::Array< T >.
| void casa::Matrix< T >::resize | ( | uInt | nx, | |
| uInt | ny, | |||
| Bool | copyValues = False | |||
| ) |
Resize to the given shape (must be 2-dimensional).
Resize without argument is equal to resize(0,0).
| virtual void casa::Matrix< T >::resize | ( | ) | [virtual] |
Make this array a different shape.
If copyValues==True the old values are copied over to the new array. Copying is done on a per axis basis, thus a subsection with the minimum of the old and new shape is copied.
Resize without argument is equal to resize(IPosition()).
It is important to note that if multiple Array objects reference the same data storage, this Array object still references the same data storage as the other Array objects if the shape does not change. Otherwise this Array object references newly allocated storage, while the other Array objects still reference the existing data storage.
If you want to be sure that the data storage of this Array object is not referenced by other Array objects, the function unique should be called first.
Reimplemented from casa::Array< T >.
| virtual void casa::Matrix< T >::resize | ( | const IPosition & | newShape, | |
| Bool | copyValues = False | |||
| ) | [virtual] |
Reimplemented from casa::Array< T >.
| Matrix<T>& casa::Matrix< T >::operator= | ( | const Matrix< T > & | other | ) |
Copy the values from other to this Matrix.
If this matrix has zero elements then it will resize to be the same shape as other; otherwise other must conform to this. Note that the assign function can be used to assign a non-conforming matrix.
| virtual Array<T>& casa::Matrix< T >::operator= | ( | const Array< T > & | other | ) | [virtual] |
Copy the values in other to this.
If the array on the left hand side has no elements, then it is resized to be the same size as as the array on the right hand side. Otherwise, the arrays must conform (same shapes).
IPosition shape(2,10,10); // some shape Array<Double> ad(shape); //.\.. Array<Double> ad2; // N.B. ad2.nelements() == 0 ad2 = ad; // ad2 resizes, then elements // are copied. shape = 20; Array<Double> ad3(shape); ad3 = ad; // Error: arrays do not conform
Reimplemented from casa::Array< T >.
| Array<T>& casa::Matrix< T >::operator= | ( | const T & | val | ) | [inline] |
Copy val into every element of this Matrix; i.e.
behaves as if val were a constant conformant matrix.
Reimplemented from casa::Array< T >.
| Matrix<T>& casa::Matrix< T >::operator= | ( | const MaskedArray< T > & | marray | ) | [inline] |
Copy to this those values in marray whose corresponding elements in marray's mask are True.
Reimplemented from casa::Array< T >.
| T& casa::Matrix< T >::operator() | ( | const IPosition & | i | ) | [inline] |
Single-pixel addressing.
If AIPS_ARRAY_INDEX_CHECK is defined, bounds checking is performed.
Reimplemented from casa::Array< T >.
| const T& casa::Matrix< T >::operator() | ( | const IPosition & | i | ) | const [inline] |
| T& casa::Matrix< T >::operator() | ( | uInt | i1, | |
| uInt | i2 | |||
| ) | [inline] |
| const T& casa::Matrix< T >::operator() | ( | uInt | i1, | |
| uInt | i2 | |||
| ) | const [inline] |
| MaskedArray<T> casa::Matrix< T >::operator() | ( | const LogicalArray & | mask | ) | const [inline] |
| MaskedArray<T> casa::Matrix< T >::operator() | ( | const LogicalArray & | mask | ) | [inline] |
| MaskedArray<T> casa::Matrix< T >::operator() | ( | const MaskedLogicalArray & | mask | ) | const [inline] |
| MaskedArray<T> casa::Matrix< T >::operator() | ( | const MaskedLogicalArray & | mask | ) | [inline] |
| Vector<T> casa::Matrix< T >::row | ( | uInt | i | ) |
Returns a reference to the i'th row.
| const Vector<T> casa::Matrix< T >::row | ( | uInt | i | ) | const |
| Vector<T> casa::Matrix< T >::column | ( | uInt | j | ) |
Returns a reference to the j'th column.
Referenced by casa::QtPixelCanvas::drawColoredPoints(), and casa::PixelCanvas::drawColoredPoints().
| const Vector<T> casa::Matrix< T >::column | ( | uInt | j | ) | const |
| Vector<T> casa::Matrix< T >::diagonal | ( | ) | [inline] |
Returns a diagonal from the Matrix.
The Matrix must be square.
Definition at line 251 of file Matrix.h.
Referenced by casa::Matrix< std::complex< Float > >::diagonal().
| const Vector<T> casa::Matrix< T >::diagonal | ( | ) | const [inline] |
| Vector<T> casa::Matrix< T >::diagonal | ( | Int | n | ) |
n==0 is the main diagonal.
n>0 is above the main diagonal, n<0 is below it.
| const Vector<T> casa::Matrix< T >::diagonal | ( | Int | n | ) | const |
| Matrix<T> casa::Matrix< T >::operator() | ( | const Slice & | sliceX, | |
| const Slice & | sliceY | |||
| ) |
Take a slice of this matrix.
Slices are always indexed starting at zero. This uses reference semantics, i.e. changing a value in the slice changes the original.
Matrix<Double> vd(100,100);
//.\..
vd(Slice(0,10),Slice(10,10)) = -1.0; // 10x10 sub-matrix set to -1.0
| Array<T> casa::Matrix< T >::operator() | ( | const IPosition & | blc, | |
| const IPosition & | trc, | |||
| const IPosition & | incr | |||
| ) | [inline] |
Slice using IPositions.
Required to be defined, otherwise the base class versions are hidden.
Reimplemented from casa::Array< T >.
| Array<T> casa::Matrix< T >::operator() | ( | const IPosition & | blc, | |
| const IPosition & | trc | |||
| ) | [inline] |
Get a reference to an array which extends from "start" to end.
"
Reimplemented from casa::Array< T >.
| Array<T> casa::Matrix< T >::operator() | ( | const Slicer & | slicer | ) | [inline] |
| void casa::Matrix< T >::shape | ( | Int & | s1, | |
| Int & | s2 | |||
| ) | const [inline] |
The length of each axis of the Matrix.
Definition at line 294 of file Matrix.h.
Referenced by casa::PlotRasterMatrixData< T >::PlotRasterMatrixData(), casa::MSPlotMainMSCallBack::printlocateinfo(), casa::MSPlotAntennaCallBack::printlocateinfo(), casa::MSPlotUVWCallBack::printlocateinfo(), casa::PlotCalCallBacks::printlocateinfo(), and casa::TPGuiCallBackHooks::printlocateinfo().
| const IPosition& casa::Matrix< T >::shape | ( | ) | const [inline] |
| uInt casa::Matrix< T >::nrow | ( | ) | const [inline] |
The number of rows in the Matrix, i.e.
the length of the first axis.
Definition at line 301 of file Matrix.h.
Referenced by casa::MSPlotConvertAveChanToChan::MSPlotConvertAveChanToChan(), casa::PlotRasterMatrixData< T >::PlotRasterMatrixData(), and casa::MSPlotMainMSCallBack::printlocateinfo().
| uInt casa::Matrix< T >::ncolumn | ( | ) | const [inline] |
The number of columns in the Matrix, i.e.
the length of the 2nd axis.
Definition at line 305 of file Matrix.h.
Referenced by casa::PlotRasterMatrixData< T >::PlotRasterMatrixData().
| virtual void casa::Matrix< T >::takeStorage | ( | const IPosition & | shape, | |
| T * | storage, | |||
| StorageInitPolicy | policy = COPY | |||
| ) | [virtual] |
Replace the data values with those in the pointer storage.
The results are undefined is storage does not point at nelements() or more data elements. After takeStorage() is called, unique() is True.
Reimplemented from casa::Array< T >.
| virtual void casa::Matrix< T >::takeStorage | ( | const IPosition & | shape, | |
| const T * | storage | |||
| ) | [virtual] |
| virtual Bool casa::Matrix< T >::ok | ( | ) | const [virtual] |
| virtual void casa::Matrix< T >::doNonDegenerate | ( | Array< T > & | other, | |
| const IPosition & | ignoreAxes | |||
| ) | [protected, virtual] |
Remove the degenerate axes from other and store result in this matrix.
An exception is thrown if removing degenerate axes does not result in a matrix.
Reimplemented from casa::Array< T >.
| void casa::Matrix< T >::makeIndexingConstants | ( | ) | [private] |
Helper fn to calculate the indexing constants.
Int casa::Matrix< T >::xinc_p [private] |
Cached constants to improve indexing.
Definition at line 330 of file Matrix.h.
Referenced by casa::Matrix< std::complex< Float > >::operator()().
Int casa::Matrix< T >::yinc_p [private] |
Definition at line 330 of file Matrix.h.
Referenced by casa::Matrix< std::complex< Float > >::operator()().
1.5.1