fml  0.1-0
Fused Matrix Library
cpumat< REAL > Class Template Reference

Matrix class for data held on a single CPU. More...

#include <cpumat.hh>

Inheritance diagram for cpumat< REAL >:
unimat< REAL >

Public Member Functions

 cpumat ()
 Construct matrix object with no internal allocated storage. More...
 
 cpumat (len_t nrows, len_t ncols)
 Construct matrix object. More...
 
 cpumat (REAL *data, len_t nrows, len_t ncols, 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...
 
 cpumat (const cpumat &x)
 
void resize (len_t nrows, len_t ncols)
 Resize the internal object storage. More...
 
void inherit (REAL *data, len_t nrows, len_t ncols, bool free_on_destruct=false)
 Set the internal object storage to the specified array. More...
 
cpumat< 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.
 
void fill_zero ()
 Set all values to zero.
 
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.
 
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.
 
void rev_cols ()
 Reverse the columns of the matrix.
 
bool any_inf () const
 Are any values infinite?
 
bool any_nan () const
 Are any values NaN?
 
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 cpumat< REAL > &x) const
 See if the two objects are the same. More...
 
bool operator!= (const cpumat< REAL > &x) const
 See if the two objects are not the same. Uses same internal logic as the == method. More...
 
cpumat< REAL > & operator= (const cpumat< 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...
 
void fill_linspace (const int start, const int stop)
 
- Public Member Functions inherited from unimat< REAL >
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
 

Additional Inherited Members

- Protected Member Functions inherited from unimat< REAL >
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
 
- Protected Attributes inherited from unimat< REAL >
len_t m
 
len_t n
 
REAL * data
 
bool free_data
 

Detailed Description

template<typename REAL>
class cpumat< REAL >

Matrix class for data held on a single CPU.

Template Parameters
REALshould be 'float' or 'double'.

Constructor & Destructor Documentation

◆ cpumat() [1/3]

template<typename REAL >
cpumat< REAL >::cpumat

Construct matrix object with no internal allocated storage.

◆ cpumat() [2/3]

template<typename REAL >
cpumat< REAL >::cpumat ( len_t  nrows,
len_t  ncols 
)

Construct matrix object.

Parameters
[in]nrows,ncolsNumber rows/columns of the matrix.
Exceptions\n If the allocation fails, a bad_alloc exception will be thrown.
If the input values are invalid, a runtime_error exception will be thrown.
cpumat<float> x(3, 2);

◆ cpumat() [3/3]

template<typename REAL >
cpumat< REAL >::cpumat ( REAL *  data_,
len_t  nrows,
len_t  ncols,
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.

Parameters
[in]data_Storage array.
[in]nrows,ncolsNumber rows/columns of the array, i.e. the length of the array is nrows*ncols.
[in]free_on_destructShould the inherited array data_ be freed when the matrix object is destroyed?
Exceptions\n If the input values are invalid, a runtime_error exception will be
thrown.

Member Function Documentation

◆ antidiag()

template<typename REAL >
void cpumat< REAL >::antidiag ( cpuvec< REAL > &  v)

Get the anti-diagonal entries, i.e. those on the bottom-left to top-right.

Parameters
[out]vThe 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.
Memory Allocations\n If the output dimension is inappropriately sized, it will
automatically be re-allocated.
Exceptions\n If a reallocation is triggered and fails, a bad_alloc exception
will be thrown.

◆ diag()

template<typename REAL >
void cpumat< REAL >::diag ( cpuvec< REAL > &  v)

Get the diagonal entries.

Parameters
[out]vThe 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.
Memory Allocations\n If the output dimension is inappropriately sized, it will
automatically be re-allocated.
Exceptions\n If a reallocation is triggered and fails, a bad_alloc exception
will be thrown.

◆ fill_diag()

template<typename REAL >
void cpumat< REAL >::fill_diag ( const cpuvec< REAL > &  v)

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.

Parameters
[in]vVector of values to set the matrix diagonal to.

◆ fill_linspace()

template<typename REAL >
void cpumat< REAL >::fill_linspace ( const REAL  start,
const REAL  stop 
)

Set values to linearly spaced numbers.

Parameters
[in]start,stopBeginning/ending numbers.

◆ fill_rnorm()

template<typename REAL >
void cpumat< 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.

Parameters
[in]seedSeed for the rng.
[in]mean,sdParameters for the generator.

◆ fill_runif()

template<typename REAL >
void cpumat< 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.

Parameters
[in]seedSeed for the rng.
[in]min,maxParameters for the generator.

◆ fill_val()

template<typename REAL >
void cpumat< REAL >::fill_val ( const REAL  v)

Set all values to input value.

Parameters
[in]vValue to set all data values to.

◆ get() [1/2]

template<typename REAL >
REAL cpumat< REAL >::get ( const len_t  i) const

Get the specified value.

Parameters
[in]iThe index of the desired value, 0-indexed. The numbering considers the internal storage as a 1-dimensional array.
Exceptions\n If indices are out of bounds, the method will throw a runtime_error
exception.

◆ get() [2/2]

template<typename REAL >
REAL cpumat< REAL >::get ( const len_t  i,
const len_t  j 
) const

Get the specified value.

Parameters
[in]i,jThe indices of the desired value, 0-indexed.
Exceptions\n If indices are out of bounds, the method will throw a runtime_error
exception.

◆ get_col()

template<typename REAL >
void cpumat< REAL >::get_col ( const len_t  j,
cpuvec< REAL > &  v 
) const

Get the specified column.

Parameters
[in]jThe desired column, 0-indexed.
[out]vThe column values.
Memory Allocations\n If the output dimension is inappropriately sized, it will
automatically be re-allocated.
Exceptions\n If j is an inappropriate value (i.e. does not refer to a matrix
column), then the method will throw a logic_error exception. If a reallocation is triggered and fails, a bad_alloc exception will be thrown.

◆ get_row()

template<typename REAL >
void cpumat< REAL >::get_row ( const len_t  i,
cpuvec< REAL > &  v 
) const

Get the specified row.

Parameters
[in]iThe desired row, 0-indexed.
[out]vThe row values.
Memory Allocations\n If the output dimension is inappropriately sized, it will
automatically be re-allocated.
Exceptions\n If i is an inappropriate value (i.e. does not refer to a matrix
row), then the method will throw a logic_error exception. If a reallocation is triggered and fails, a bad_alloc exception will be thrown.

◆ inherit()

template<typename REAL >
void cpumat< REAL >::inherit ( REAL *  data,
len_t  nrows,
len_t  ncols,
bool  free_on_destruct = false 
)

Set the internal object storage to the specified array.

Parameters
[in]dataValue storage.
[in]nrows,ncolsNumber rows/columns of the matrix. The product of these should be the length of the input data.
[in]free_on_destructShould the object destructor free the internal array data?
Exceptions\n If the input values are invalid, a runtime_error exception will be
thrown.

◆ operator!=()

template<typename REAL >
bool cpumat< REAL >::operator!= ( const cpumat< REAL > &  x) const

See if the two objects are not the same. Uses same internal logic as the == method.

Parameters
[in]Comparisonobject.

◆ operator=()

template<typename REAL >
cpumat< REAL > & cpumat< REAL >::operator= ( const cpumat< 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.

Parameters
[in]xSetter value.

◆ operator==()

template<typename REAL >
bool cpumat< REAL >::operator== ( const cpumat< REAL > &  x) const

See if the two objects are the same.

Parameters
[in]Comparisonobject.
Returns
If the dimensions mismatch, then false is necessarily returned. Next, if the pointer to the internal storage arrays match, then true is necessarily returned. Otherwise the objects are compared value by value.

◆ print()

template<typename REAL >
void cpumat< REAL >::print ( uint8_t  ndigits = 4,
bool  add_final_blank = true 
) const

Print all values in the object.

Parameters
[in]ndigitsNumber of decimal digits to print.
[in]add_final_blankShould a final blank line be printed?

◆ resize()

template<typename REAL >
void cpumat< REAL >::resize ( len_t  nrows,
len_t  ncols 
)

Resize the internal object storage.

Parameters
[in]nrows,ncolsNumber rows/columns needed.
Memory Allocations\n Resizing triggers a re-allocation.
Exceptions\n If the reallocation fails, a bad_alloc exception will be thrown.
If the input values are invalid, a runtime_error exception will be thrown.

◆ scale()

template<typename REAL >
void cpumat< REAL >::scale ( const REAL  s)

Multiply all values by the input value.

Parameters
[in]sScaling value.

◆ set() [1/2]

template<typename REAL >
void cpumat< REAL >::set ( const len_t  i,
const len_t  j,
const REAL  v 
)

Set the storage at the specified index with the provided value.

Parameters
[in]i,jThe indices of the desired value, 0-indexed.
[in]vSetter value.
Exceptions\n If indices are out of bounds, the method will throw a runtime_error
exception.

◆ set() [2/2]

template<typename REAL >
void cpumat< REAL >::set ( const len_t  i,
const REAL  v 
)

Set the storage at the specified index with the provided value.

Parameters
[in]iThe index of the desired value, 0-indexed. The numbering considers the internal storage as a 1-dimensional array.
[in]vSetter value.
Exceptions\n If indices are out of bounds, the method will throw a runtime_error
exception.

The documentation for this class was generated from the following file:
cpumat
Matrix class for data held on a single CPU.
Definition: cpumat.hh:34