![]() |
fml
0.1-0
Fused Matrix Library
|
Matrix class for data distributed over MPI in the 2-d block cyclic format. More...
#include <mpimat.hh>
Public Member Functions | |
mpimat (const grid &blacs_grid) | |
Construct matrix object with no internal allocated storage. More... | |
mpimat (const grid &blacs_grid, int bf_rows, int bf_cols) | |
Construct matrix object. More... | |
mpimat (const grid &blacs_grid, len_t nrows, len_t ncols, int bf_rows, int bf_cols) | |
Construct matrix object. More... | |
mpimat (const grid &blacs_grid, REAL *data_, len_t nrows, len_t ncols, int bf_rows, int bf_cols, bool free_on_destruct=false) | |
Construct matrix object with inherited data. Essentially the same as using the minimal constructor and immediately calling the inherit() method. More... | |
mpimat (const mpimat &x) | |
void | resize (len_t nrows, len_t ncols) |
Resize the internal object storage. More... | |
void | resize (len_t nrows, len_t ncols, int bf_rows, int bf_cols) |
Resize the internal object storage. More... | |
void | inherit (grid &blacs_grid, REAL *data_, len_t nrows, len_t ncols, int bf_rows, int bf_cols, bool free_on_destruct=false) |
Set the internal object storage to the specified array. More... | |
mpimat< REAL > | dupe () const |
Duplicate the object in a deep copy. | |
void | print (uint8_t ndigits=4, bool add_final_blank=true) const |
Print all values in the object. More... | |
void | info () const |
Print some brief information about the object. More... | |
void | fill_zero () |
Set all values to zero. More... | |
void | fill_val (const REAL v) |
Set all values to input value. More... | |
void | fill_linspace (const REAL start, const REAL stop) |
Set values to linearly spaced numbers. More... | |
void | fill_eye () |
Set diagonal entries to 1 and non-diagonal entries to 0. More... | |
void | fill_diag (const cpuvec< REAL > &v) |
Set diagonal entries of the matrix to those in the vector. More... | |
void | fill_runif (const uint32_t seed, const REAL min=0, const REAL max=1) |
Set diagonal entries to 1 and non-diagonal entries to 0. More... | |
void | fill_runif (const REAL min=0, const REAL max=1) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | fill_rnorm (const uint32_t seed, const REAL mean=0, const REAL sd=1) |
Set diagonal entries to 1 and non-diagonal entries to 0. More... | |
void | fill_rnorm (const REAL mean=0, const REAL sd=1) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | diag (cpuvec< REAL > &v) |
Get the diagonal entries. More... | |
void | antidiag (cpuvec< REAL > &v) |
Get the anti-diagonal entries, i.e. those on the bottom-left to top-right. More... | |
void | scale (const REAL s) |
Multiply all values by the input value. More... | |
void | rev_rows () |
Reverse the rows of the matrix. More... | |
void | rev_cols () |
Reverse the columns of the matrix. More... | |
bool | any_inf () const |
Are any values infinite? More... | |
bool | any_nan () const |
Are any values NaN? More... | |
REAL | get (const len_t i) const |
Get the specified value. More... | |
REAL | get (const len_t i, const len_t j) const |
Get the specified value. More... | |
void | set (const len_t i, const REAL v) |
Set the storage at the specified index with the provided value. More... | |
void | set (const len_t i, const len_t j, const REAL v) |
Set the storage at the specified index with the provided value. More... | |
void | get_row (const len_t i, cpuvec< REAL > &v) const |
Get the specified row. More... | |
void | get_col (const len_t j, cpuvec< REAL > &v) const |
Get the specified column. More... | |
bool | operator== (const mpimat< REAL > &x) const |
See if the two objects are the same. More... | |
bool | operator!= (const mpimat< REAL > &x) const |
See if the two objects are not the same. Uses same internal logic as the == method. More... | |
mpimat< REAL > & | operator= (const mpimat< REAL > &x) |
Operator that sets the LHS to a shallow copy of the input. Desctruction of the LHS object will not result in the internal array storage being freed. More... | |
len_local_t | nrows_local () const |
len_local_t | ncols_local () const |
int | bf_rows () const |
int | bf_cols () const |
int * | desc_ptr () |
const int * | desc_ptr () const |
const grid | get_grid () const |
void | fill_linspace (const int start, const int stop) |
![]() | |
bool | is_square () const |
Is the matrix square? | |
len_t | nrows () const |
Number of rows. | |
len_t | ncols () const |
Number of columns. | |
REAL * | data_ptr () |
Pointer to the internal array. | |
REAL * | data_ptr () const |
Protected Attributes | |
len_local_t | m_local |
len_local_t | n_local |
int | mb |
int | nb |
int | desc [9] |
grid | g |
![]() | |
len_t | m |
len_t | n |
REAL * | data |
bool | free_data |
Additional Inherited Members | |
![]() | |
bool | should_free () const |
void | check_index (const len_t i) const |
void | check_index (const len_t i, const len_t j) const |
void | printval (const REAL val, uint8_t ndigits) const |
void | printval (const int val, uint8_t ndigits) const |
Matrix class for data distributed over MPI in the 2-d block cyclic format.
REAL | should be 'float' or 'double'. |
Construct matrix object with no internal allocated storage.
[in] | blacs_grid | Scalapack grid object. |
mpimat< REAL >::mpimat | ( | const grid & | blacs_grid, |
int | bf_rows, | ||
int | bf_cols | ||
) |
Construct matrix object.
[in] | blacs_grid | Scalapack grid object. |
[in] | nrows,ncols | Number rows/columns of the matrix. |
[in] | bf_rows,bf_cols | Row/column blocking factor. |
runtime_error
exception will be thrown.mpimat< REAL >::mpimat | ( | const grid & | blacs_grid, |
len_t | nrows, | ||
len_t | ncols, | ||
int | bf_rows, | ||
int | bf_cols | ||
) |
Construct matrix object.
[in] | blacs_grid | Scalapack grid object. |
[in] | nrows,ncols | Number rows/columns of the array, i.e. the length of the array is nrows*ncols. |
[in] | bf_rows,bf_cols | Row/column blocking factor. |
mpimat< REAL >::mpimat | ( | const grid & | blacs_grid, |
REAL * | data_, | ||
len_t | nrows, | ||
len_t | ncols, | ||
int | bf_rows, | ||
int | bf_cols, | ||
bool | free_on_destruct = false |
||
) |
Construct matrix object with inherited data. Essentially the same as using the minimal constructor and immediately calling the inherit()
method.
[in] | blacs_grid | Scalapack grid object. |
[in] | data_ | Storage array. |
[in] | nrows,ncols | Number rows/columns of the array, i.e. the length of the array is nrows*ncols. |
[in] | bf_rows,bf_cols | Row/column blocking factor. |
[in] | free_on_destruct | Should the inherited array data_ be freed when the matrix object is destroyed? |
Get the anti-diagonal entries, i.e. those on the bottom-left to top-right.
[out] | v | The anti-diagonal. Length should match the length of the diagonal of the input (minimum of the matrix dimensions). If not, the vector will automatically be resized. |
bool mpimat< REAL >::any_inf |
Are any values infinite?
bool mpimat< REAL >::any_nan |
Are any values NaN?
Get the diagonal entries.
[out] | v | The diagonal. Length should match the length of the diagonal of the input (minimum of the matrix dimensions). If not, the vector will automatically be resized. |
Set diagonal entries of the matrix to those in the vector.
If the vector is smaller than the matrix diagonal, the vector will recycle until the matrix diagonal is filled. If the vector is longer, then not all of it will be used.
[in] | v | Vector of values to set the matrix diagonal to. |
void mpimat< REAL >::fill_eye |
Set diagonal entries to 1 and non-diagonal entries to 0.
void mpimat< REAL >::fill_linspace | ( | const REAL | start, |
const REAL | stop | ||
) |
Set values to linearly spaced numbers.
[in] | start,stop | Beginning/ending numbers. |
void mpimat< REAL >::fill_rnorm | ( | const uint32_t | seed, |
const REAL | mean = 0 , |
||
const REAL | sd = 1 |
||
) |
Set diagonal entries to 1 and non-diagonal entries to 0.
[in] | seed | Seed for the rng. |
[in] | mean,sd | Parameters for the generator. |
void mpimat< REAL >::fill_runif | ( | const uint32_t | seed, |
const REAL | min = 0 , |
||
const REAL | max = 1 |
||
) |
Set diagonal entries to 1 and non-diagonal entries to 0.
[in] | seed | Seed for the rng. |
[in] | min,max | Parameters for the generator. |
void mpimat< REAL >::fill_val | ( | const REAL | v | ) |
Set all values to input value.
[in] | v | Value to set all data values to. |
void mpimat< REAL >::fill_zero |
Set all values to zero.
REAL mpimat< REAL >::get | ( | const len_t | i | ) | const |
Get the specified value.
All processes receive the return.
[in] | i | The index of the desired value, 0-indexed. The numbering considers the internal storage as a 1-dimensional array. |
REAL mpimat< REAL >::get | ( | const len_t | i, |
const len_t | j | ||
) | const |
Get the specified value.
All processes receive the return.
[in] | i,j | The indices of the desired value, 0-indexed. |
Get the specified column.
The return vector of column values is set on all processes.
[in] | j | The desired column, 0-indexed. |
[out] | v | The column values. |
logic_error
exception. If a reallocation is triggered and fails, a bad_alloc
exception will be thrown.Get the specified row.
The return vector of row values is set on all processes.
[in] | i | The desired row, 0-indexed. |
[out] | v | The row values. |
logic_error
exception. If a reallocation is triggered and fails, a bad_alloc
exception will be thrown.void mpimat< REAL >::info |
Print some brief information about the object.
Printing will only be done by rank 0.
void mpimat< REAL >::inherit | ( | grid & | blacs_grid, |
REAL * | data_, | ||
len_t | nrows, | ||
len_t | ncols, | ||
int | bf_rows, | ||
int | bf_cols, | ||
bool | free_on_destruct = false |
||
) |
Set the internal object storage to the specified array.
[in] | data | Value storage. |
[in] | nrows,ncols | Number rows/columns of the matrix. The product of these should be the length of the input data . |
[in] | bf_rows,bf_cols | Row/column blocking factor. |
[in] | free_on_destruct | Should the object destructor free the internal array data ? |
See if the two objects are not the same. Uses same internal logic as the ==
method.
[in] | Comparison | object. |
Operator that sets the LHS to a shallow copy of the input. Desctruction of the LHS object will not result in the internal array storage being freed.
[in] | x | Setter value. |
See if the two objects are the same.
All processes receive the return.
[in] | Comparison | object. |
false
is necessarily returned. Next, if the grid objects have different ordinal context numbers, then false
is returned. Next, if the pointer to the internal storage arrays match, then true
is returned. Otherwise the objects are compared value by value.void mpimat< REAL >::print | ( | uint8_t | ndigits = 4 , |
bool | add_final_blank = true |
||
) | const |
Print all values in the object.
Printing will only be done by rank 0.
[in] | ndigits | Number of decimal digits to print. |
[in] | add_final_blank | Should a final blank line be printed? |
void mpimat< REAL >::resize | ( | len_t | nrows, |
len_t | ncols | ||
) |
Resize the internal object storage.
[in] | nrows,ncols | Number rows/columns needed. |
runtime_error
exception will be thrown.void mpimat< REAL >::resize | ( | len_t | nrows, |
len_t | ncols, | ||
int | bf_rows, | ||
int | bf_cols | ||
) |
Resize the internal object storage.
[in] | nrows,ncols | Number rows/columns needed. |
[in] | bf_rows,bf_cols | Row/column blocking factor. |
runtime_error
exception will be thrown.void mpimat< REAL >::rev_cols |
Reverse the columns of the matrix.
void mpimat< REAL >::rev_rows |
Reverse the rows of the matrix.
void mpimat< REAL >::scale | ( | const REAL | s | ) |
Multiply all values by the input value.
[in] | s | Scaling value. |
void mpimat< REAL >::set | ( | const len_t | i, |
const len_t | j, | ||
const REAL | v | ||
) |
Set the storage at the specified index with the provided value.
[in] | i,j | The indices of the desired value, 0-indexed. |
[in] | v | Setter value. |
void mpimat< REAL >::set | ( | const len_t | i, |
const REAL | v | ||
) |
Set the storage at the specified index with the provided value.
[in] | i | The index of the desired value, 0-indexed. The numbering considers the internal storage as a 1-dimensional array. |
[in] | v | Setter value. |