GNU Octave  4.4.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
matrix_type.cc File Reference
#include <algorithm>
#include "ov.h"
#include "defun.h"
#include "error.h"
#include "ov-re-mat.h"
#include "ov-cx-mat.h"
#include "ov-re-sparse.h"
#include "ov-cx-sparse.h"
#include "MatrixType.h"
#include "oct-locbuf.h"
Include dependency graph for matrix_type.cc:

Go to the source code of this file.

Functions

Upper triangular If the optional third argument the matrix is assumed to be a permuted upper triangular with the permutations defined the vector the matrix is assumed to be a permuted lower triangular with the permutations defined the vector then the matrix is tridiagonal and treated with specialized code In addition the matrix can be marked as probably a positive definite (Sparse matrices only) tem code
 
OCTAVE_EXPORT octave_value_list Fmatrix_type (const octave_value_list &args, int) ode
 
returns the type of the matrix and caches it for future use Called with more than one the function will not attempt to guess the type if it is still unknown This is useful for debugging purposes The possible matrix types depend on whether the matrix is full or and can be one of the following able sis tem and mark type as unknown tem as the structure of the matrix explicitly gives this (Sparse matrices only) tem code
 

Variables

Upper triangular If the optional third argument ar {perm} is given
 
returns the type of the matrix and caches it for future use Called with more than one argument
 
it is entirely the test for positive definiteness is a low cost test for a Hermitian matrix with a real positive diagonal This does not guarantee that the matrix is positive but only that it is a probable candidate When such a matrix is a Choleskyie {}factorization is first attempted
 
returns the type of the matrix and caches it for future use Called with more than one the function will not attempt to guess the type if it is still unknown This is useful for debugging purposes The possible matrix types depend on whether the matrix is full or and can be one of the following able sis tem code {"unknown"} Remove any previously cached matrix type
 
it is entirely the test for positive definiteness is a low cost test for a Hermitian matrix with a real positive diagonal This does not guarantee that the matrix is positive definite
 
it is entirely the test for positive definiteness is a low cost test for a Hermitian matrix with a real positive diagonal This does not guarantee that the matrix is positive but only that it is a probable candidate When such a matrix is factorized
 
it is entirely the test for positive definiteness is a low cost test for a Hermitian matrix with a real positive diagonal This does not guarantee that the matrix is positive but only that it is a probable candidate When such a matrix is a and if that fails the matrix is then treated with an LUie {}factorization. Once the matrix has been factorized
 
returns the type of the matrix and caches it for future use Called with more than one ode {matrix_type} allows the type of the matrix to be defined. 0 the option code{"nocompute"} is given
 
returns the type of the matrix and caches it for future use Called with more than one the function will not attempt to guess the type if it is still unknown This is useful for debugging purposes The possible matrix types depend on whether the matrix is full or sparse
 
it is entirely trong {the responsibility of the user} to correctly identify the matrix type. Also
 

Function Documentation

◆ definite()

Upper triangular If the optional third argument the matrix is assumed to be a permuted upper triangular with the permutations defined the vector the matrix is assumed to be a permuted lower triangular with the permutations defined the vector then the matrix is tridiagonal and treated with specialized code In addition the matrix can be marked as probably a positive definite ( Sparse matrices  only)

Definition at line 120 of file matrix_type.cc.

◆ Fmatrix_type()

OCTAVE_EXPORT octave_value_list Fmatrix_type ( const octave_value_list args,
int   
)

Definition at line 120 of file matrix_type.cc.

◆ this()

returns the type of the matrix and caches it for future use Called with more than one the function will not attempt to guess the type if it is still unknown This is useful for debugging purposes The possible matrix types depend on whether the matrix is full or and can be one of the following able sis tem and mark type as unknown tem as the structure of the matrix explicitly gives this ( Sparse matrices  only)

Variable Documentation

◆ ar

The matrix is assumed to be singular and will be treated with a minimum norm solution nd table Note that the matrix type will be discovered automatically on the first attempt to solve a linear equation involving ar {perm} is given

Definition at line 120 of file matrix_type.cc.

◆ argument

◆ Choleskyie

it is entirely the test for positive definiteness is a low cost test for a Hermitian matrix with a real positive diagonal This does not guarantee that the matrix is positive but only that it is a probable candidate When such a matrix is a Choleskyie {}factorization is first attempted

Definition at line 120 of file matrix_type.cc.

◆ code

returns the type of the matrix and caches it for future use Called with more than one the function will not attempt to guess the type if it is still unknown This is useful for debugging purposes The possible matrix types depend on whether the matrix is full or and can be one of the following able sis tem and mark type as unknown tem code {"unknown"} Remove any previously cached matrix type

Definition at line 120 of file matrix_type.cc.

◆ definite

it is entirely the test for positive definiteness is a low cost test for a Hermitian matrix with a real positive diagonal This does not guarantee that the matrix is positive definite

Definition at line 120 of file matrix_type.cc.

◆ factorized

it is entirely the test for positive definiteness is a low cost test for a Hermitian matrix with a real positive diagonal This does not guarantee that the matrix is positive but only that it is a probable candidate When such a matrix is factorized

Definition at line 120 of file matrix_type.cc.

◆ LUie

it is entirely the test for positive definiteness is a low cost test for a Hermitian matrix with a real positive diagonal This does not guarantee that the matrix is positive but only that it is a probable candidate When such a matrix is a and if that fails the matrix is then treated with an LUie {}factorization. Once the matrix has been factorized

Definition at line 120 of file matrix_type.cc.

◆ ode

returns the type of the matrix and caches it for future use Called with more than one ode {matrix_type} allows the type of the matrix to be defined. 0 the option code{"nocompute"} is given

Definition at line 120 of file matrix_type.cc.

◆ sparse

returns the type of the matrix and caches it for future use Called with more than one the function will not attempt to guess the type if it is still unknown This is useful for debugging purposes The possible matrix types depend on whether the matrix is full or sparse

Definition at line 120 of file matrix_type.cc.

◆ trong

it is entirely trong {the responsibility of the user} to correctly identify the matrix type. Also

Definition at line 120 of file matrix_type.cc.