SHOGUN
4.1.0
|
shogun matrix
Definition at line 26 of file base/Parameter.h.
Public Types | |
typedef T | Scalar |
Public Member Functions | |
SGMatrix () | |
SGMatrix (bool ref_counting) | |
SGMatrix (T *m, index_t nrows, index_t ncols, bool ref_counting=true) | |
SGMatrix (T *m, index_t nrows, index_t ncols, index_t offset) | |
SGMatrix (index_t nrows, index_t ncols, bool ref_counting=true) | |
SGMatrix (SGVector< T > vec) | |
SGMatrix (SGVector< T > vec, index_t nrows, index_t ncols) | |
SGMatrix (EigenMatrixXt &mat) | |
operator EigenMatrixXtMap () const | |
SGMatrix (const SGMatrix &orig) | |
virtual | ~SGMatrix () |
T * | get_column_vector (index_t col) const |
SGVector< T > | get_row_vector (index_t row) const |
SGVector< T > | get_diagonal_vector () const |
const T & | operator() (index_t i_row, index_t i_col) const |
const T & | operator[] (index_t index) const |
T & | operator() (index_t i_row, index_t i_col) |
T & | operator[] (index_t index) |
SGMatrix< T > | get () |
T * | data () const |
uint64_t | size () const |
bool | operator== (SGMatrix< T > &other) |
bool | equals (SGMatrix< T > &other) |
void | set_const (T const_elem) |
void | zero () |
bool | is_symmetric () |
T | max_single () |
SGMatrix< T > | clone () |
void | compute_few_eigenvectors (double *matrix_, double *&eigenvalues, double *&eigenvectors, int n, int il, int iu) |
void | center () |
void | remove_column_mean () |
void | display_matrix (const char *name="matrix") const |
void | load (CFile *loader) |
void | save (CFile *saver) |
template<> | |
void | zero () |
template<> | |
bool | is_symmetric () |
template<> | |
bool | is_symmetric () |
template<> | |
bool | is_symmetric () |
template<> | |
bool | is_symmetric () |
template<> | |
complex128_t | max_single () |
template<> | |
void | display_matrix (const bool *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const char *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const int8_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const uint8_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const int16_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const uint16_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const int32_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const uint32_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const int64_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const uint64_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const float32_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const float64_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const floatmax_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
void | display_matrix (const complex128_t *matrix, int32_t rows, int32_t cols, const char *name, const char *prefix) |
template<> | |
SGMatrix< char > | create_identity_matrix (index_t size, char scale) |
template<> | |
SGMatrix< int8_t > | create_identity_matrix (index_t size, int8_t scale) |
template<> | |
SGMatrix< uint8_t > | create_identity_matrix (index_t size, uint8_t scale) |
template<> | |
SGMatrix< bool > | create_identity_matrix (index_t size, bool scale) |
template<> | |
SGMatrix< int16_t > | create_identity_matrix (index_t size, int16_t scale) |
template<> | |
SGMatrix< uint16_t > | create_identity_matrix (index_t size, uint16_t scale) |
template<> | |
SGMatrix< int32_t > | create_identity_matrix (index_t size, int32_t scale) |
template<> | |
SGMatrix< uint32_t > | create_identity_matrix (index_t size, uint32_t scale) |
template<> | |
SGMatrix< int64_t > | create_identity_matrix (index_t size, int64_t scale) |
template<> | |
SGMatrix< uint64_t > | create_identity_matrix (index_t size, uint64_t scale) |
template<> | |
SGMatrix< float32_t > | create_identity_matrix (index_t size, float32_t scale) |
template<> | |
SGMatrix< float64_t > | create_identity_matrix (index_t size, float64_t scale) |
template<> | |
SGMatrix< floatmax_t > | create_identity_matrix (index_t size, floatmax_t scale) |
template<> | |
SGMatrix< complex128_t > | create_identity_matrix (index_t size, complex128_t scale) |
template<> | |
void | load (CFile *loader) |
template<> | |
void | save (CFile *saver) |
int32_t | ref_count () |
Static Public Member Functions | |
static T * | clone_matrix (const T *matrix, int32_t nrows, int32_t ncols) |
static void | transpose_matrix (T *&matrix, int32_t &num_feat, int32_t &num_vec) |
static void | create_diagonal_matrix (T *matrix, T *v, int32_t size) |
static SGMatrix< T > | create_identity_matrix (index_t size, T scale) |
static SGVector< float64_t > | compute_eigenvectors (SGMatrix< float64_t > matrix) |
static double * | compute_eigenvectors (double *matrix, int n, int m) |
static SGMatrix< float64_t > | matrix_multiply (SGMatrix< float64_t > A, SGMatrix< float64_t > B, bool transpose_A=false, bool transpose_B=false, float64_t scale=1.0) |
static void | inverse (SGMatrix< float64_t > matrix) |
inverses square matrix in-place More... | |
static float64_t * | pinv (float64_t *matrix, int32_t rows, int32_t cols, float64_t *target=NULL) |
static float64_t | trace (float64_t *mat, int32_t cols, int32_t rows) |
static T * | get_row_sum (T *matrix, int32_t m, int32_t n) |
static T * | get_column_sum (T *matrix, int32_t m, int32_t n) |
static void | center_matrix (T *matrix, int32_t m, int32_t n) |
static void | display_matrix (const T *matrix, int32_t rows, int32_t cols, const char *name="matrix", const char *prefix="") |
static void | display_matrix (const SGMatrix< T > matrix, const char *name="matrix", const char *prefix="") |
static SGMatrix< T > | get_allocated_matrix (index_t num_rows, index_t num_cols, SGMatrix< T > pre_allocated=SGMatrix< T >()) |
Public Attributes | |
T * | matrix |
index_t | num_rows |
index_t | num_cols |
Protected Member Functions | |
virtual void | copy_data (const SGReferencedData &orig) |
virtual void | init_data () |
virtual void | free_data () |
void | copy_refcount (const SGReferencedData &orig) |
int32_t | ref () |
int32_t | unref () |
typedef T Scalar |
The scalar type of the matrix
Definition at line 40 of file SGMatrix.h.
SGMatrix | ( | ) |
Default constructor
Definition at line 30 of file SGMatrix.cpp.
SGMatrix | ( | bool | ref_counting | ) |
Constructor for setting reference counting while not creating the matrix in memory (use this for static SGMatrix instances)
Definition at line 36 of file SGMatrix.cpp.
Constructor for setting params
Definition at line 42 of file SGMatrix.cpp.
Wraps a matrix around an existing memory segment with an offset
Definition at line 53 of file SGMatrix.h.
Constructor to create new matrix in memory
Definition at line 47 of file SGMatrix.cpp.
Constructor for creating a SGMatrix from a SGVector with refcounting. We do not copy the data here, just the pointer to data and the ref- count object of the SGVector (i.e. vec and this share same data and ref-count object).
This constructor assumes that the vector is the column 0 in the matrix.
vec | The SGVector |
Definition at line 54 of file SGMatrix.cpp.
Constructor for creating a SGMatrix from a SGVector with refcounting. We do not copy the data here, just the pointer to data and the ref- count object of the SGVector (i.e. vec and this share same data and ref-count object).
The number of elements in the matrix MUST be same as the number of elements in the vector
vec | The SGVector |
nrows | number of rows in the matrix |
ncols | number of columns in the matrix |
Definition at line 63 of file SGMatrix.cpp.
SGMatrix | ( | EigenMatrixXt & | mat | ) |
Wraps a matrix around the data of an Eigen3 matrix
Definition at line 85 of file SGMatrix.cpp.
Copy constructor
Definition at line 78 of file SGMatrix.cpp.
|
virtual |
Empty destructor
Definition at line 100 of file SGMatrix.cpp.
void center | ( | ) |
Centers the matrix, i.e. removes column/row mean from columns/rows
Definition at line 346 of file SGMatrix.cpp.
|
static |
Centers matrix (e.g. kernel matrix in feature space INPLACE
Definition at line 352 of file SGMatrix.cpp.
SGMatrix< T > clone | ( | ) |
Clone matrix
Definition at line 260 of file SGMatrix.cpp.
|
static |
Clone matrix
Definition at line 267 of file SGMatrix.cpp.
Compute eigenvalues and eigenvectors of symmetric matrix using LAPACK
matrix | symmetric matrix to compute eigenproblem. Is overwritten and contains orthonormal eigenvectors afterwards |
Definition at line 895 of file SGMatrix.cpp.
|
static |
Compute eigenvalues and eigenvectors of symmetric matrix
matrix | overwritten and contains n orthonormal eigenvectors |
n | |
m |
Definition at line 912 of file SGMatrix.cpp.
void compute_few_eigenvectors | ( | double * | matrix_, |
double *& | eigenvalues, | ||
double *& | eigenvectors, | ||
int | n, | ||
int | il, | ||
int | iu | ||
) |
Compute few eigenpairs of a symmetric matrix using LAPACK DSYEVR method (Relatively Robust Representations). Has at least O(n^3/3) complexity
matrix_ | symmetric matrix |
eigenvalues | contains iu-il+1 eigenvalues in ascending order (to be free'd) |
eigenvectors | contains iu-il+1 orthonormal eigenvectors of given matrix column-wise (to be free'd) |
n | dimension of matrix |
il | low index of requested eigenpairs (1<=il<=n) |
iu | high index of requested eigenpairs (1<=il<=iu<=n) |
Definition at line 934 of file SGMatrix.cpp.
|
protectedvirtual |
|
protectedinherited |
copy refcount
Definition at line 55 of file SGReferencedData.cpp.
|
static |
Create diagonal matrix
Definition at line 295 of file SGMatrix.cpp.
Returns the identity matrix, scaled by a factor
size | size of square identity matrix |
scale | (optional) scaling factor |
Definition at line 660 of file SGMatrix.cpp.
Definition at line 667 of file SGMatrix.cpp.
Definition at line 680 of file SGMatrix.cpp.
Definition at line 693 of file SGMatrix.cpp.
Definition at line 706 of file SGMatrix.cpp.
Definition at line 719 of file SGMatrix.cpp.
Definition at line 732 of file SGMatrix.cpp.
Definition at line 745 of file SGMatrix.cpp.
Definition at line 758 of file SGMatrix.cpp.
Definition at line 771 of file SGMatrix.cpp.
Definition at line 784 of file SGMatrix.cpp.
Definition at line 797 of file SGMatrix.cpp.
SGMatrix< floatmax_t > create_identity_matrix | ( | index_t | size, |
floatmax_t | scale | ||
) |
Definition at line 810 of file SGMatrix.cpp.
SGMatrix< complex128_t > create_identity_matrix | ( | index_t | size, |
complex128_t | scale | ||
) |
Definition at line 823 of file SGMatrix.cpp.
T* data | ( | ) | const |
The data
Definition at line 181 of file SGMatrix.h.
void display_matrix | ( | const char * | name = "matrix" | ) | const |
Display matrix
Definition at line 394 of file SGMatrix.cpp.
|
static |
Display matrix (useful for debugging)
|
static |
Display matrix
Definition at line 400 of file SGMatrix.cpp.
void display_matrix | ( | const bool * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 408 of file SGMatrix.cpp.
void display_matrix | ( | const char * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 426 of file SGMatrix.cpp.
void display_matrix | ( | const int8_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 444 of file SGMatrix.cpp.
void display_matrix | ( | const uint8_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 462 of file SGMatrix.cpp.
void display_matrix | ( | const int16_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 480 of file SGMatrix.cpp.
void display_matrix | ( | const uint16_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 498 of file SGMatrix.cpp.
void display_matrix | ( | const int32_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 517 of file SGMatrix.cpp.
void display_matrix | ( | const uint32_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 535 of file SGMatrix.cpp.
void display_matrix | ( | const int64_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 552 of file SGMatrix.cpp.
void display_matrix | ( | const uint64_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 570 of file SGMatrix.cpp.
void display_matrix | ( | const float32_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 588 of file SGMatrix.cpp.
void display_matrix | ( | const float64_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 606 of file SGMatrix.cpp.
void display_matrix | ( | const floatmax_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 624 of file SGMatrix.cpp.
void display_matrix | ( | const complex128_t * | matrix, |
int32_t | rows, | ||
int32_t | cols, | ||
const char * | name, | ||
const char * | prefix | ||
) |
Definition at line 642 of file SGMatrix.cpp.
bool equals | ( | SGMatrix< T > & | other | ) |
Operator overload for element-wise matrix comparison. Note that only numerical data is compared
other | matrix to compare with |
Definition at line 118 of file SGMatrix.cpp.
|
protectedvirtual |
SGMatrix<T> get | ( | ) |
Get the matrix (no copying is done here)
Definition at line 175 of file SGMatrix.h.
|
static |
Simple helper method that returns a matrix with allocated memory for a given size. A pre_allocated one can optionally be specified in order to use that. Basically just for having dimension check encapsulated.
num_rows | rows of returned matrix |
num_cols | columns of returned matrix |
pre_allocated | optional matrix that is returned instead of new matrix. Make sure dimensions match |
Definition at line 997 of file SGMatrix.cpp.
|
static |
Sums up all columns of a matrix and returns the resulting columnvector
Definition at line 333 of file SGMatrix.cpp.
T* get_column_vector | ( | index_t | col | ) | const |
Get a column vector
col | column index |
Definition at line 115 of file SGMatrix.h.
SGVector< T > get_diagonal_vector | ( | ) | const |
Get a main diagonal vector. Matrix is not required to be square.
Definition at line 1099 of file SGMatrix.cpp.
|
static |
Sums up all rows of a matrix and returns the resulting rowvector
Definition at line 320 of file SGMatrix.cpp.
Get a row vector
row | row index |
Definition at line 1088 of file SGMatrix.cpp.
|
protectedvirtual |
overridden to initialize empty data
Implements SGReferencedData.
Definition at line 1035 of file SGMatrix.cpp.
inverses square matrix in-place
Inverses square matrix in-place
Definition at line 885 of file SGMatrix.cpp.
bool is_symmetric | ( | ) |
Definition at line 170 of file SGMatrix.cpp.
bool is_symmetric | ( | ) |
Definition at line 187 of file SGMatrix.cpp.
bool is_symmetric | ( | ) |
Definition at line 204 of file SGMatrix.cpp.
bool is_symmetric | ( | ) |
Checks whether the matrix is symmetric or not. The equality check is performed using '==' operators for discrete types (int, char, bool) and using CMath::fequals method for floating types (float, double, long double, std::complex<double>) with default espilon values from std::numeric_limits
Definition at line 154 of file SGMatrix.cpp.
bool is_symmetric | ( | ) |
Definition at line 221 of file SGMatrix.cpp.
void load | ( | CFile * | loader | ) |
Load matrix from file
loader | File object via which to load data |
Definition at line 1052 of file SGMatrix.cpp.
void load | ( | CFile * | loader | ) |
Definition at line 1067 of file SGMatrix.cpp.
|
static |
Computes scale* A*B, where A and B may be transposed. Asserts for matching inner dimensions.
A | matrix A |
transpose_A | optional whether A should be transposed before |
B | matrix B |
transpose_B | optional whether B should be transposed before |
scale | optional scaling factor for result |
Definition at line 947 of file SGMatrix.cpp.
T max_single | ( | ) |
Definition at line 240 of file SGMatrix.cpp.
complex128_t max_single | ( | ) |
Definition at line 253 of file SGMatrix.cpp.
operator EigenMatrixXtMap | ( | ) | const |
Wraps an Eigen3 matrix around the data of this matrix
Definition at line 93 of file SGMatrix.cpp.
Operator overload for matrix read only access
i_row | |
i_col |
Definition at line 138 of file SGMatrix.h.
Operator overload for matrix r/w access
i_row | |
i_col |
Definition at line 156 of file SGMatrix.h.
bool operator== | ( | SGMatrix< T > & | other | ) |
Check for pointer identity
Definition at line 106 of file SGMatrix.cpp.
const T& operator[] | ( | index_t | index | ) | const |
Operator overload for matrix read only access
index | to access |
Definition at line 147 of file SGMatrix.h.
T& operator[] | ( | index_t | index | ) |
Operator overload for matrix r/w access
index | to access |
Definition at line 165 of file SGMatrix.h.
|
static |
Return the pseudo inverse for matrix when matrix has shape (rows, cols) the pseudo inverse has (cols, rows)
Definition at line 846 of file SGMatrix.cpp.
|
protectedinherited |
increase reference counter
Definition at line 64 of file SGReferencedData.cpp.
|
inherited |
display reference counter
Definition at line 41 of file SGReferencedData.cpp.
void remove_column_mean | ( | ) |
Remove column mean
Definition at line 377 of file SGMatrix.cpp.
void save | ( | CFile * | saver | ) |
Save matrix to file
saver | File object via which to save data |
Definition at line 1073 of file SGMatrix.cpp.
void save | ( | CFile * | saver | ) |
Definition at line 1082 of file SGMatrix.cpp.
void set_const | ( | T | const_elem | ) |
Set matrix to a constant
Definition at line 133 of file SGMatrix.cpp.
uint64_t size | ( | ) | const |
The size
Definition at line 187 of file SGMatrix.h.
Compute trace
Definition at line 310 of file SGMatrix.cpp.
|
static |
Transpose matrix
Definition at line 277 of file SGMatrix.cpp.
|
protectedinherited |
decrement reference counter and deallocate object if refcount is zero before or after decrementing it
Definition at line 84 of file SGReferencedData.cpp.
void zero | ( | ) |
Definition at line 147 of file SGMatrix.cpp.
void zero | ( | ) |
fill matrix with zeros
Definition at line 140 of file SGMatrix.cpp.
T* matrix |
matrix
Definition at line 374 of file SGMatrix.h.
index_t num_cols |
number of columns of matrix
Definition at line 378 of file SGMatrix.h.
index_t num_rows |
number of rows of matrix
Definition at line 376 of file SGMatrix.h.