SparseMatrix Class Reference

#include <dSparse.h>

Inherits MSparse< double >.

Collaboration diagram for SparseMatrix:

List of all members.

Public Types
typedef void(*	solve_singularity_handler )(double rcond)
Public Member Functions
	SparseMatrix (void)
	SparseMatrix (octave_idx_type r, octave_idx_type c)
	SparseMatrix (const dim_vector &dv, octave_idx_type nz=0)
	SparseMatrix (octave_idx_type r, octave_idx_type c, double val)
	SparseMatrix (const SparseMatrix &a)
	SparseMatrix (const SparseMatrix &a, const dim_vector &dv)
	SparseMatrix (const MSparse< double > &a)
	SparseMatrix (const Sparse< double > &a)
	SparseMatrix (const SparseBoolMatrix &a)
	SparseMatrix (const Matrix &a)
	SparseMatrix (const NDArray &a)
	SparseMatrix (const Array< double > &a, const idx_vector &r, const idx_vector &c, octave_idx_type nr=-1, octave_idx_type nc=-1, bool sum_terms=true, octave_idx_type nzm=-1)
	SparseMatrix (const DiagMatrix &a)
	SparseMatrix (const PermMatrix &a)
	SparseMatrix (octave_idx_type r, octave_idx_type c, octave_idx_type num_nz)
SparseMatrix &	operator= (const SparseMatrix &a)
bool	operator== (const SparseMatrix &a) const
bool	operator!= (const SparseMatrix &a) const
bool	is_symmetric (void) const
SparseMatrix	max (int dim=-1) const
SparseMatrix	max (Array< octave_idx_type > &index, int dim=-1) const
SparseMatrix	min (int dim=-1) const
SparseMatrix	min (Array< octave_idx_type > &index, int dim=-1) const
SparseMatrix &	insert (const SparseMatrix &a, octave_idx_type r, octave_idx_type c)
SparseMatrix &	insert (const SparseMatrix &a, const Array< octave_idx_type > &indx)
SparseMatrix	concat (const SparseMatrix &rb, const Array< octave_idx_type > &ra_idx)
SparseComplexMatrix	concat (const SparseComplexMatrix &rb, const Array< octave_idx_type > &ra_idx)
SparseMatrix	transpose (void) const
SparseMatrix	hermitian (void) const
RowVector	row (octave_idx_type i) const
ColumnVector	column (octave_idx_type i) const
SparseMatrix	inverse (void) const
SparseMatrix	inverse (MatrixType &mattype) const
SparseMatrix	inverse (MatrixType &mattype, octave_idx_type &info) const
SparseMatrix	inverse (MatrixType &mattype, octave_idx_type &info, double &rcond, int force=0, int calc_cond=1) const
DET	determinant (void) const
DET	determinant (octave_idx_type &info) const
DET	determinant (octave_idx_type &info, double &rcond, int calc_cond=1) const
Matrix	solve (MatrixType &typ, const Matrix &b) const
Matrix	solve (MatrixType &typ, const Matrix &b, octave_idx_type &info) const
Matrix	solve (MatrixType &typ, const Matrix &b, octave_idx_type &info, double &rcond) const
Matrix	solve (MatrixType &typ, const Matrix &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler, bool singular_fallback=true) const
ComplexMatrix	solve (MatrixType &typ, const ComplexMatrix &b) const
ComplexMatrix	solve (MatrixType &typ, const ComplexMatrix &b, octave_idx_type &info) const
ComplexMatrix	solve (MatrixType &typ, const ComplexMatrix &b, octave_idx_type &info, double &rcond) const
ComplexMatrix	solve (MatrixType &typ, const ComplexMatrix &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler, bool singular_fallback=true) const
SparseMatrix	solve (MatrixType &typ, const SparseMatrix &b) const
SparseMatrix	solve (MatrixType &typ, const SparseMatrix &b, octave_idx_type &info) const
SparseMatrix	solve (MatrixType &typ, const SparseMatrix &b, octave_idx_type &info, double &rcond) const
SparseMatrix	solve (MatrixType &typ, const SparseMatrix &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler, bool singular_fallback=true) const
SparseComplexMatrix	solve (MatrixType &typ, const SparseComplexMatrix &b) const
SparseComplexMatrix	solve (MatrixType &typ, const SparseComplexMatrix &b, octave_idx_type &info) const
SparseComplexMatrix	solve (MatrixType &typ, const SparseComplexMatrix &b, octave_idx_type &info, double &rcond) const
SparseComplexMatrix	solve (MatrixType &typ, const SparseComplexMatrix &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler, bool singular_fallabck=true) const
ColumnVector	solve (MatrixType &typ, const ColumnVector &b) const
ColumnVector	solve (MatrixType &typ, const ColumnVector &b, octave_idx_type &info) const
ColumnVector	solve (MatrixType &typ, const ColumnVector &b, octave_idx_type &info, double &rcond) const
ColumnVector	solve (MatrixType &typ, const ColumnVector &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler) const
ComplexColumnVector	solve (MatrixType &typ, const ComplexColumnVector &b) const
ComplexColumnVector	solve (MatrixType &typ, const ComplexColumnVector &b, octave_idx_type &info) const
ComplexColumnVector	solve (MatrixType &typ, const ComplexColumnVector &b, octave_idx_type &info, double &rcond) const
ComplexColumnVector	solve (MatrixType &typ, const ComplexColumnVector &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler) const
Matrix	solve (const Matrix &b) const
Matrix	solve (const Matrix &b, octave_idx_type &info) const
Matrix	solve (const Matrix &b, octave_idx_type &info, double &rcond) const
Matrix	solve (const Matrix &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler) const
ComplexMatrix	solve (const ComplexMatrix &b) const
ComplexMatrix	solve (const ComplexMatrix &b, octave_idx_type &info) const
ComplexMatrix	solve (const ComplexMatrix &b, octave_idx_type &info, double &rcond) const
ComplexMatrix	solve (const ComplexMatrix &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler) const
SparseMatrix	solve (const SparseMatrix &b) const
SparseMatrix	solve (const SparseMatrix &b, octave_idx_type &info) const
SparseMatrix	solve (const SparseMatrix &b, octave_idx_type &info, double &rcond) const
SparseMatrix	solve (const SparseMatrix &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler) const
SparseComplexMatrix	solve (const SparseComplexMatrix &b) const
SparseComplexMatrix	solve (const SparseComplexMatrix &b, octave_idx_type &info) const
SparseComplexMatrix	solve (const SparseComplexMatrix &b, octave_idx_type &info, double &rcond) const
SparseComplexMatrix	solve (const SparseComplexMatrix &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler) const
ColumnVector	solve (const ColumnVector &b) const
ColumnVector	solve (const ColumnVector &b, octave_idx_type &info) const
ColumnVector	solve (const ColumnVector &b, octave_idx_type &info, double &rcond) const
ColumnVector	solve (const ColumnVector &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler) const
ComplexColumnVector	solve (const ComplexColumnVector &b) const
ComplexColumnVector	solve (const ComplexColumnVector &b, octave_idx_type &info) const
ComplexColumnVector	solve (const ComplexColumnVector &b, octave_idx_type &info, double &rcond) const
ComplexColumnVector	solve (const ComplexColumnVector &b, octave_idx_type &info, double &rcond, solve_singularity_handler sing_handler) const
bool	any_element_is_negative (bool=false) const
bool	any_element_is_nan (void) const
bool	any_element_is_inf_or_nan (void) const
bool	any_element_not_one_or_zero (void) const
bool	all_elements_are_zero (void) const
bool	all_elements_are_int_or_inf_or_nan (void) const
bool	all_integers (double &max_val, double &min_val) const
bool	too_large_for_float (void) const
SparseBoolMatrix	operator! (void) const
SparseBoolMatrix	all (int dim=-1) const
SparseBoolMatrix	any (int dim=-1) const
SparseMatrix	cumprod (int dim=-1) const
SparseMatrix	cumsum (int dim=-1) const
SparseMatrix	prod (int dim=-1) const
SparseMatrix	sum (int dim=-1) const
SparseMatrix	sumsq (int dim=-1) const
SparseMatrix	abs (void) const
SparseMatrix	diag (octave_idx_type k=0) const
Matrix	matrix_value (void) const
SparseMatrix	squeeze (void) const
SparseMatrix	reshape (const dim_vector &new_dims) const
SparseMatrix	permute (const Array< octave_idx_type > &vec, bool inv=false) const
SparseMatrix	ipermute (const Array< octave_idx_type > &vec) const
Friends
OCTAVE_API SparseMatrix	real (const SparseComplexMatrix &a)
OCTAVE_API SparseMatrix	imag (const SparseComplexMatrix &a)
OCTAVE_API SparseMatrix	atan2 (const double &x, const SparseMatrix &y)
OCTAVE_API SparseMatrix	atan2 (const SparseMatrix &x, const double &y)
OCTAVE_API SparseMatrix	atan2 (const SparseMatrix &x, const SparseMatrix &y)
OCTAVE_API std::ostream &	operator<< (std::ostream &os, const SparseMatrix &a)
OCTAVE_API std::istream &	operator>> (std::istream &is, SparseMatrix &a)

---

Member Typedef Documentation

typedef void(* SparseMatrix::solve_singularity_handler)(double rcond)

---

Constructor & Destructor Documentation

SparseMatrix::SparseMatrix

(

void

)

[inline]

SparseMatrix::SparseMatrix	(	octave_idx_type	r,
		octave_idx_type	c
	)			[inline]

SparseMatrix::SparseMatrix	(	const dim_vector &	dv,
		octave_idx_type	nz = 0
	)			[inline]

SparseMatrix::SparseMatrix	(	octave_idx_type	r,
		octave_idx_type	c,
		double	val
	)			[inline, explicit]

SparseMatrix::SparseMatrix

(

const SparseMatrix &

a

)

[inline]

SparseMatrix::SparseMatrix	(	const SparseMatrix &	a,
		const dim_vector &	dv
	)			[inline]

SparseMatrix::SparseMatrix

(

const MSparse< double > &

a

)

[inline]

SparseMatrix::SparseMatrix

(

const Sparse< double > &

a

)

[inline]

F77_RET_T const octave_idx_type double Complex Complex const octave_idx_type octave_idx_type &F77_RET_T const octave_idx_type Complex Complex Complex Complex const octave_idx_type octave_idx_type & SparseMatrix::SparseMatrix

(

const SparseBoolMatrix &

a

)

[explicit]

SparseMatrix::SparseMatrix

(

const Matrix &

a

)

[inline, explicit]

SparseMatrix::SparseMatrix

(

const NDArray &

a

)

[inline, explicit]

SparseMatrix::SparseMatrix	(	const Array< double > &	a,
		const idx_vector &	r,
		const idx_vector &	c,
		octave_idx_type	nr = -1,
		octave_idx_type	nc = -1,
		bool	sum_terms = true,
		octave_idx_type	nzm = -1
	)			[inline]

SparseMatrix::SparseMatrix

(

const DiagMatrix &

a

)

[explicit]

SparseMatrix::SparseMatrix

(

const PermMatrix &

a

)

[explicit]

SparseMatrix::SparseMatrix	(	octave_idx_type	r,
		octave_idx_type	c,
		octave_idx_type	num_nz
	)			[inline]

---

Member Function Documentation

SparseMatrix SparseMatrix::abs

(

void

)

const

SparseBoolMatrix SparseMatrix::all

(

int

dim = -1

)

const

bool SparseMatrix::all_elements_are_int_or_inf_or_nan

(

void

)

const

bool SparseMatrix::all_elements_are_zero

(

void

)

const

bool SparseMatrix::all_integers	(	double &	max_val,
		double &	min_val
	)			const

SparseBoolMatrix SparseMatrix::any

(

int

dim = -1

)

const

bool SparseMatrix::any_element_is_inf_or_nan

(

void

)

const

bool SparseMatrix::any_element_is_nan

(

void

)

const

bool SparseMatrix::any_element_is_negative

(

bool

neg_zero = false

)

const

bool SparseMatrix::any_element_not_one_or_zero

(

void

)

const

ColumnVector SparseMatrix::column

(

octave_idx_type

i

)

const

SparseMatrix SparseMatrix::concat	(	const SparseMatrix &	rb,
		const Array< octave_idx_type > &	ra_idx
	)

SparseComplexMatrix SparseMatrix::concat	(	const SparseComplexMatrix &	rb,
		const Array< octave_idx_type > &	ra_idx
	)

SparseMatrix SparseMatrix::cumprod

(

int

dim = -1

)

const

SparseMatrix SparseMatrix::cumsum

(

int

dim = -1

)

const

DET SparseMatrix::determinant

(

void

)

const

DET SparseMatrix::determinant

(

octave_idx_type &

info

)

const

DET SparseMatrix::determinant	(	octave_idx_type &	info,
		double &	rcond,
		int	calc_cond = 1
	)			const

SparseMatrix SparseMatrix::diag

(

octave_idx_type

k = 0

)

const

Reimplemented from MSparse< double >.

SparseMatrix SparseMatrix::hermitian

(

void

)

const [inline]

SparseMatrix & SparseMatrix::insert	(	const SparseMatrix &	a,
		octave_idx_type	r,
		octave_idx_type	c
	)

SparseMatrix & SparseMatrix::insert	(	const SparseMatrix &	a,
		const Array< octave_idx_type > &	indx
	)

SparseMatrix SparseMatrix::inverse

(

void

)

const

SparseMatrix SparseMatrix::inverse

(

MatrixType &

mattype

)

const

SparseMatrix SparseMatrix::inverse	(	MatrixType &	mattype,
		octave_idx_type &	info
	)			const

SparseMatrix SparseMatrix::inverse	(	MatrixType &	mattype,
		octave_idx_type &	info,
		double &	rcond,
		int	force = 0,
		int	calc_cond = 1
	)			const

SparseMatrix SparseMatrix::ipermute

(

const Array< octave_idx_type > &

vec

)

const

Reimplemented from MSparse< double >.

bool SparseMatrix::is_symmetric

(

void

)

const

Matrix SparseMatrix::matrix_value

(

void

)

const

SparseMatrix SparseMatrix::max

(

int

dim = -1

)

const

SparseMatrix SparseMatrix::max	(	Array< octave_idx_type > &	index,
		int	dim = -1
	)			const

SparseMatrix SparseMatrix::min	(	Array< octave_idx_type > &	index,
		int	dim = -1
	)			const

SparseMatrix SparseMatrix::min

(

int

dim = -1

)

const

SparseBoolMatrix SparseMatrix::operator!

(

void

)

const

bool SparseMatrix::operator!=

(

const SparseMatrix &

a

)

const

SparseMatrix& SparseMatrix::operator=

(

const SparseMatrix &

a

)

[inline]

bool SparseMatrix::operator==

(

const SparseMatrix &

a

)

const

SparseMatrix SparseMatrix::permute	(	const Array< octave_idx_type > &	vec,
		bool	inv = false
	)			const

Reimplemented from MSparse< double >.

SparseMatrix SparseMatrix::prod

(

int

dim = -1

)

const

SparseMatrix SparseMatrix::reshape

(

const dim_vector &

new_dims

)

const

Reimplemented from MSparse< double >.

RowVector SparseMatrix::row

(

octave_idx_type

i

)

const

ComplexMatrix SparseMatrix::solve	(	const ComplexMatrix &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

ComplexMatrix SparseMatrix::solve	(	const ComplexMatrix &	b,
		octave_idx_type &	info
	)			const

SparseMatrix SparseMatrix::solve

(

const SparseMatrix &

b

)

const

Matrix SparseMatrix::solve	(	const Matrix &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler
	)			const

Matrix SparseMatrix::solve	(	const Matrix &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

Matrix SparseMatrix::solve	(	const Matrix &	b,
		octave_idx_type &	info
	)			const

Matrix SparseMatrix::solve

(

const Matrix &

b

)

const

ColumnVector SparseMatrix::solve	(	MatrixType &	typ,
		const ColumnVector &	b,
		octave_idx_type &	info
	)			const

SparseComplexMatrix SparseMatrix::solve	(	const SparseComplexMatrix &	b,
		octave_idx_type &	info
	)			const

ComplexColumnVector SparseMatrix::solve	(	const ComplexColumnVector &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler
	)			const

ColumnVector SparseMatrix::solve	(	MatrixType &	typ,
		const ColumnVector &	b
	)			const

ColumnVector SparseMatrix::solve	(	MatrixType &	typ,
		const ColumnVector &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler
	)			const

ColumnVector SparseMatrix::solve	(	const ColumnVector &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

ComplexColumnVector SparseMatrix::solve

(

const ComplexColumnVector &

b

)

const

ComplexColumnVector SparseMatrix::solve	(	MatrixType &	typ,
		const ComplexColumnVector &	b
	)			const

ComplexColumnVector SparseMatrix::solve	(	MatrixType &	typ,
		const ComplexColumnVector &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

SparseMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const SparseMatrix &	b
	)			const

SparseComplexMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const SparseComplexMatrix &	b,
		octave_idx_type &	info
	)			const

ColumnVector SparseMatrix::solve

(

const ColumnVector &

b

)

const

SparseMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const SparseMatrix &	b,
		octave_idx_type &	info
	)			const

ComplexColumnVector SparseMatrix::solve	(	MatrixType &	typ,
		const ComplexColumnVector &	b,
		octave_idx_type &	info
	)			const

SparseMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const SparseMatrix &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

SparseMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const SparseMatrix &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler,
		bool	singular_fallback = true
	)			const

ComplexMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const ComplexMatrix &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler,
		bool	singular_fallback = true
	)			const

ComplexMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const ComplexMatrix &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

ComplexMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const ComplexMatrix &	b,
		octave_idx_type &	info
	)			const

ComplexMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const ComplexMatrix &	b
	)			const

Matrix SparseMatrix::solve	(	MatrixType &	typ,
		const Matrix &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler,
		bool	singular_fallback = true
	)			const

ComplexMatrix SparseMatrix::solve

(

const ComplexMatrix &

b

)

const

Matrix SparseMatrix::solve	(	MatrixType &	typ,
		const Matrix &	b,
		octave_idx_type &	info
	)			const

Matrix SparseMatrix::solve	(	MatrixType &	typ,
		const Matrix &	b
	)			const

ComplexColumnVector SparseMatrix::solve	(	const ComplexColumnVector &	b,
		octave_idx_type &	info
	)			const

ComplexColumnVector SparseMatrix::solve	(	const ComplexColumnVector &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

SparseComplexMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const SparseComplexMatrix &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler,
		bool	singular_fallabck = true
	)			const

SparseMatrix SparseMatrix::solve	(	const SparseMatrix &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler
	)			const

ColumnVector SparseMatrix::solve	(	const ColumnVector &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler
	)			const

SparseComplexMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const SparseComplexMatrix &	b
	)			const

ComplexColumnVector SparseMatrix::solve	(	MatrixType &	typ,
		const ComplexColumnVector &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler
	)			const

SparseMatrix SparseMatrix::solve	(	const SparseMatrix &	b,
		octave_idx_type &	info
	)			const

ColumnVector SparseMatrix::solve	(	const ColumnVector &	b,
		octave_idx_type &	info
	)			const

ColumnVector SparseMatrix::solve	(	MatrixType &	typ,
		const ColumnVector &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

Matrix SparseMatrix::solve	(	MatrixType &	typ,
		const Matrix &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

SparseComplexMatrix SparseMatrix::solve	(	MatrixType &	typ,
		const SparseComplexMatrix &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

SparseMatrix SparseMatrix::solve	(	const SparseMatrix &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

SparseComplexMatrix SparseMatrix::solve	(	const SparseComplexMatrix &	b,
		octave_idx_type &	info,
		double &	rcond
	)			const

ComplexMatrix SparseMatrix::solve	(	const ComplexMatrix &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler
	)			const

SparseComplexMatrix SparseMatrix::solve	(	const SparseComplexMatrix &	b,
		octave_idx_type &	info,
		double &	rcond,
		solve_singularity_handler	sing_handler
	)			const

SparseComplexMatrix SparseMatrix::solve

(

const SparseComplexMatrix &

b

)

const

SparseMatrix SparseMatrix::squeeze

(

void

)

const

Reimplemented from MSparse< double >.

SparseMatrix SparseMatrix::sum

(

int

dim = -1

)

const

SparseMatrix SparseMatrix::sumsq

(

int

dim = -1

)

const

bool SparseMatrix::too_large_for_float

(

void

)

const

SparseMatrix SparseMatrix::transpose

(

void

)

const [inline]

Reimplemented from MSparse< double >.

---

Friends And Related Function Documentation

OCTAVE_API SparseMatrix atan2	(	const double &	x,
		const SparseMatrix &	y
	)			[friend]

OCTAVE_API SparseMatrix atan2	(	const SparseMatrix &	x,
		const double &	y
	)			[friend]

OCTAVE_API SparseMatrix atan2	(	const SparseMatrix &	x,
		const SparseMatrix &	y
	)			[friend]

OCTAVE_API SparseMatrix imag

(

const SparseComplexMatrix &

a

)

[friend]

OCTAVE_API std::ostream& operator<<	(	std::ostream &	os,
		const SparseMatrix &	a
	)			[friend]

OCTAVE_API std::istream& operator>>	(	std::istream &	is,
		SparseMatrix &	a
	)			[friend]

OCTAVE_API SparseMatrix real

(

const SparseComplexMatrix &

a

)

[friend]

---

The documentation for this class was generated from the following files:

• dSparse.h
• dSparse.cc