Column-major upper-triangular packed matrix class. More...
#include <Matrix_TriangPacked.hxx>
Public Types | |
typedef Allocator::value_type | value_type |
typedef Prop | property |
typedef ColUpTriangPacked | storage |
typedef Allocator | allocator |
typedef Allocator::pointer | pointer |
typedef Allocator::const_pointer | const_pointer |
typedef Allocator::reference | reference |
typedef Allocator::const_reference | const_reference |
typedef Allocator::value_type | entry_type |
typedef Allocator::reference | access_type |
typedef Allocator::const_reference | const_access_type |
Public Member Functions | |
Matrix () | |
Default constructor. More... | |
Matrix (int i, int j=0) | |
Main constructor. More... | |
void | Resize (int i, int j) |
Reallocates memory to resize the matrix and keeps previous entries. More... | |
template<class T0 > | |
Matrix< T, Prop, ColUpTriangPacked, Allocator > & | operator= (const T0 &x) |
Fills the matrix with a given value. More... | |
Matrix< T, Prop, ColUpTriangPacked, Allocator > & | operator= (const Matrix< T, Prop, ColUpTriangPacked, Allocator > &A) |
Duplicates a matrix (assignment operator). More... | |
template<class T0 > | |
Matrix< T, Prop, ColUpTriangPacked, Allocator > & | operator*= (const T0 &x) |
Multiplies the matrix by a given value. More... | |
void | Clear () |
Clears the matrix. More... | |
long | GetDataSize () const |
Returns the number of elements stored in memory. More... | |
size_t | GetMemorySize () const |
Returns size of A in bytes used to store the matrix. | |
void | Reallocate (int i, int j) |
Reallocates memory to resize the matrix. More... | |
void | SetData (int i, int j, pointer data) |
Changes the size of the matrix and sets its data array (low level method). More... | |
void | Nullify () |
Clears the matrix without releasing memory. More... | |
const value_type | operator() (int i, int j) const |
Access operator. More... | |
reference | Val (int i, int j) |
Direct access method. More... | |
const_reference | Val (int i, int j) const |
Direct access method. More... | |
reference | Get (int i, int j) |
Returns the element (i, j) More... | |
const_reference | Get (int i, int j) const |
Returns the element (i, j) More... | |
reference | operator[] (int i) |
Access to elements of the data array. More... | |
const_reference | operator[] (int i) const |
Access to elements of the data array. More... | |
void | Set (int i, int j, const T &x) |
Sets an element of the matrix. More... | |
void | Copy (const Matrix_TriangPacked< T, Prop, ColUpTriangPacked, Allocator > &A) |
Duplicates a matrix. More... | |
void | Zero () |
Sets all elements to zero. More... | |
void | SetIdentity () |
Sets the matrix to the identity. | |
void | Fill () |
Fills the matrix with 0, 1, 2, ... More... | |
void | Fill (const T0 &x) |
Fills the matrix with a given value. More... | |
void | FillRand () |
Fills the matrix randomly. More... | |
void | Print () const |
Displays the matrix on the standard output. More... | |
void | Print (int a, int b, int m, int n) const |
Displays a sub-matrix on the standard output. More... | |
void | Print (int l) const |
Displays a square sub-matrix on the standard output. More... | |
void | Write (string FileName) const |
Writes the matrix in a file. More... | |
void | Write (ostream &FileStream) const |
Writes the matrix to an output stream. More... | |
void | WriteText (string FileName) const |
Writes the matrix in a file. More... | |
void | WriteText (ostream &FileStream) const |
Writes the matrix to an output stream. More... | |
void | Read (string FileName) |
Reads the matrix from a file. More... | |
void | Read (istream &FileStream) |
Reads the matrix from an input stream. More... | |
void | ReadText (string FileName) |
Reads the matrix from a file. More... | |
void | ReadText (istream &FileStream) |
Reads the matrix from an input stream. More... | |
pointer | GetData () const |
Returns a pointer to the data array. More... | |
const_pointer | GetDataConst () const |
Returns a const pointer to the data array. More... | |
void * | GetDataVoid () const |
Returns a pointer of type "void*" to the data array. More... | |
const void * | GetDataConstVoid () const |
Returns a pointer of type "const void*" to the data array. More... | |
int | GetM () const |
Returns the number of rows. More... | |
int | GetM (const Seldon::SeldonTranspose &status) const |
Returns the number of rows of the matrix possibly transposed. More... | |
int | GetM (const CBLAS_TRANSPOSE &status) const |
Returns the number of rows of the matrix possibly transposed. More... | |
int | GetN () const |
Returns the number of columns. More... | |
int | GetN (const Seldon::SeldonTranspose &status) const |
Returns the number of columns of the matrix possibly transposed. More... | |
int | GetN (const CBLAS_TRANSPOSE &status) const |
Returns the number of columns of the matrix possibly transposed. More... | |
long | GetSize () const |
Returns the number of elements in the matrix. More... | |
Protected Attributes | |
pointer | data_ |
int | m_ |
int | n_ |
Column-major upper-triangular packed matrix class.
Definition at line 146 of file Matrix_TriangPacked.hxx.
|
inline |
Default constructor.
On exit, the matrix is an empty 0x0 matrix.
Definition at line 402 of file Matrix_TriangPackedInline.cxx.
|
inlineexplicit |
Main constructor.
Builds a i x j column-major upper triangular matrix in packed form.
i | number of rows. |
j | number of columns. |
Definition at line 415 of file Matrix_TriangPackedInline.cxx.
|
inherited |
Clears the matrix.
Destructs the matrix.
Definition at line 88 of file Matrix_TriangPacked.cxx.
|
inlineinherited |
Duplicates a matrix.
A | matrix to be copied. |
Definition at line 295 of file Matrix_TriangPackedInline.cxx.
|
inherited |
Fills the matrix with 0, 1, 2, ...
On exit, the matrix is filled with 0, 1, 2, 3, ... The order of those numbers depends on the storage.
Definition at line 282 of file Matrix_TriangPacked.cxx.
|
inherited |
Fills the matrix with a given value.
x | value to fill the matrix with. |
Definition at line 295 of file Matrix_TriangPacked.cxx.
|
inherited |
Fills the matrix randomly.
Definition at line 324 of file Matrix_TriangPacked.cxx.
|
inlineinherited |
Returns the element (i, j)
Returns the value of element (i, j).
i | row index. |
j | column index. |
Definition at line 195 of file Matrix_TriangPackedInline.cxx.
|
inlineinherited |
Returns the element (i, j)
Returns the value of element (i, j).
i | row index. |
j | column index. |
Definition at line 211 of file Matrix_TriangPackedInline.cxx.
|
inlineinherited |
Returns a pointer to the data array.
Returns a pointer to data, i.e. the data array 'data_'.
Definition at line 241 of file Matrix_BaseInline.cxx.
|
inlineinherited |
Returns a const pointer to the data array.
Returns a const pointer to data, i.e. the data array 'data_'.
Definition at line 254 of file Matrix_BaseInline.cxx.
|
inlineinherited |
Returns a pointer of type "const void*" to the data array.
Returns a pointer of type "const void*" to data, i.e. the data array 'data_'.
Definition at line 280 of file Matrix_BaseInline.cxx.
|
inlineinherited |
Returns the number of elements stored in memory.
Definition at line 69 of file Matrix_TriangPackedInline.cxx.
|
inlineinherited |
Returns a pointer of type "void*" to the data array.
Returns a pointer of type "void*" to data, i.e. the data array 'data_'.
Definition at line 267 of file Matrix_BaseInline.cxx.
|
inlineinherited |
Returns the number of rows.
Definition at line 69 of file Matrix_BaseInline.cxx.
|
inlineinherited |
Returns the number of rows of the matrix possibly transposed.
status | assumed status about the transposition of the matrix. |
Definition at line 122 of file Matrix_BaseInline.cxx.
|
inlineinherited |
Returns the number of rows of the matrix possibly transposed.
status | assumed status about the transposition of the matrix. |
Definition at line 92 of file Matrix_BaseInline.cxx.
|
inlineinherited |
Returns the number of columns.
Definition at line 80 of file Matrix_BaseInline.cxx.
|
inlineinherited |
Returns the number of columns of the matrix possibly transposed.
status | assumed status about the transposition of the matrix. |
Definition at line 137 of file Matrix_BaseInline.cxx.
|
inlineinherited |
Returns the number of columns of the matrix possibly transposed.
status | assumed status about the transposition of the matrix. |
Definition at line 107 of file Matrix_BaseInline.cxx.
|
inlineinherited |
Returns the number of elements in the matrix.
Returns the number of elements in the matrix, i.e. the number of rows multiplied by the number of columns.
Definition at line 153 of file Matrix_BaseInline.cxx.
|
inherited |
Clears the matrix without releasing memory.
On exit, the matrix is empty and the memory has not been released. It is useful for low level manipulations on a Matrix instance.
Definition at line 209 of file Matrix_TriangPacked.cxx.
|
inlineinherited |
Access operator.
Returns the value of element (i, j).
i | row index. |
j | column index. |
Definition at line 100 of file Matrix_TriangPackedInline.cxx.
|
inline |
Multiplies the matrix by a given value.
x | multiplication coefficient |
Definition at line 464 of file Matrix_TriangPackedInline.cxx.
|
inline |
Duplicates a matrix (assignment operator).
A | matrix to be copied. |
Definition at line 450 of file Matrix_TriangPackedInline.cxx.
|
inline |
Fills the matrix with a given value.
x | value to fill the matrix with. |
Definition at line 433 of file Matrix_TriangPackedInline.cxx.
|
inlineinherited |
Access to elements of the data array.
Provides a direct access to the data array.
i | index. |
Definition at line 225 of file Matrix_TriangPackedInline.cxx.
|
inlineinherited |
Access to elements of the data array.
Provides a direct access to the data array.
i | index. |
Definition at line 245 of file Matrix_TriangPackedInline.cxx.
|
inherited |
Displays the matrix on the standard output.
Displays elements on the standard output, in text format. Each row is displayed on a single line and elements of a row are delimited by tabulations.
Definition at line 341 of file Matrix_TriangPacked.cxx.
|
inherited |
Displays a sub-matrix on the standard output.
The sub-matrix is defined by its upper-left corner (a, b) and its bottom-right corner (m, n). So, elements with indices in [a, m] x [b, n] are displayed on the standard output, in text format. Each row is displayed on a single line and elements of a row are delimited by tabulations.
a | row index of the upper-left corner. |
b | column index of the upper-left corner. |
m | row index of the bottom-right corner. |
n | column index of the bottom-right corner. |
Definition at line 366 of file Matrix_TriangPacked.cxx.
|
inherited |
Displays a square sub-matrix on the standard output.
The sub-matrix is defined by its bottom-right corner (l, l). So, elements with indices in [0, 0] x [l, l] are displayed on the standard output, in text format. Each row is displayed on a single line and elements of a row are delimited by tabulations.
l | dimension of the square matrix to be displayed. |
Definition at line 387 of file Matrix_TriangPacked.cxx.
|
inherited |
Reads the matrix from an input stream.
Reads a matrix in binary format from an input stream. The number of rows (integer) and the number of columns (integer) are read, and matrix elements are then read in the same order as it should be in memory (e.g. row-major storage).
FileStream | input stream. |
Definition at line 573 of file Matrix_TriangPacked.cxx.
|
inherited |
Reads the matrix from a file.
Reads a matrix stored in binary format in a file. The number of rows (integer) and the number of columns (integer) are read, and matrix elements are then read in the same order as it should be in memory (e.g. row-major storage).
FileName | input file name. |
Definition at line 545 of file Matrix_TriangPacked.cxx.
|
inherited |
Reads the matrix from an input stream.
Reads a matrix in text format from an input stream.
FileStream | input stream. |
Definition at line 634 of file Matrix_TriangPacked.cxx.
|
inherited |
Reads the matrix from a file.
Reads a matrix stored in text format in a file.
FileName | input file name. |
Definition at line 609 of file Matrix_TriangPacked.cxx.
|
inherited |
Reallocates memory to resize the matrix.
On exit, the matrix is a i x j matrix.
i | new number of rows. |
j | new number of columns. |
Definition at line 132 of file Matrix_TriangPacked.cxx.
void Seldon::Matrix< T, Prop, ColUpTriangPacked, Allocator >::Resize | ( | int | i, |
int | j | ||
) |
Reallocates memory to resize the matrix and keeps previous entries.
On exit, the matrix is a i x j matrix.
i | new number of rows. |
j | new number of columns. |
Definition at line 727 of file Matrix_TriangPacked.cxx.
|
inlineinherited |
Sets an element of the matrix.
i | row index. |
j | column index. |
x | new value for the matrix element (i, j). |
Definition at line 281 of file Matrix_TriangPackedInline.cxx.
|
inherited |
Changes the size of the matrix and sets its data array (low level method).
The matrix is first cleared (memory is freed). The matrix is then resized to a i x j matrix, and the data array of the matrix is set to 'data'. 'data' elements are not duplicated: the new data array of the matrix is the 'data' array. It is useful to create a matrix from pre-existing data.
i | new number of rows. |
j | new number of columns. |
data | new array storing elements. |
Definition at line 190 of file Matrix_TriangPacked.cxx.
|
inlineinherited |
Direct access method.
This method allows access to elements stored in memory, i.e. elements from the upper part. i <= j must be satisfied.
i | row index. |
j | column index. |
Definition at line 137 of file Matrix_TriangPackedInline.cxx.
|
inlineinherited |
Direct access method.
This method allows access to elements stored in memory, i.e. elements from the upper part. i <= j must be satisfied.
i | row index. |
j | column index. |
Definition at line 167 of file Matrix_TriangPackedInline.cxx.
|
inherited |
Writes the matrix to an output stream.
Writes the matrix to an output stream in binary format. The number of rows (integer) and the number of columns (integer) are written, and matrix elements are then written in the same order as in memory (e.g. row-major storage).
FileStream | output stream. |
Definition at line 436 of file Matrix_TriangPacked.cxx.
|
inherited |
Writes the matrix in a file.
Stores the matrix in a file in binary format. The number of rows (integer) and the number of columns (integer) are written, and matrix elements are then written in the same order as in memory (e.g. row-major storage).
FileName | output file name. |
Definition at line 408 of file Matrix_TriangPacked.cxx.
|
inherited |
Writes the matrix to an output stream.
Writes the matrix to an output stream in text format. Only matrix elements are written (not dimensions). Each row is written on a single line and elements of a row are delimited by tabulations.
FileStream | output stream. |
Definition at line 506 of file Matrix_TriangPacked.cxx.
|
inherited |
Writes the matrix in a file.
Stores the matrix in a file in text format. Only matrix elements are written (not dimensions). Each row is written on a single line and elements of a row are delimited by tabulations.
FileName | output file name. |
Definition at line 476 of file Matrix_TriangPacked.cxx.
|
inherited |
Sets all elements to zero.
Definition at line 228 of file Matrix_TriangPacked.cxx.