Header file for sparse matrices. More...

#include <iostream>
#include "Eigen/Core"
#include "Eigen/SparseCore"
#include "array.h"
#include "matpackI.h"

Classes
class	Sparse
	The Sparse class. More...

Functions
void	abs (Sparse &A, const Sparse &B)
	Absolute value of sparse matrix elements. More...

void	mult (VectorView y, const Sparse &M, ConstVectorView x)
	Sparse matrix - Vector multiplication. More...

void	transpose_mult (VectorView y, const Sparse &M, ConstVectorView x)
	Sparse matrix - Vector multiplication. More...

void	mult (MatrixView A, const Sparse &B, const ConstMatrixView &C)
	SparseMatrix - Matrix multiplication. More...

void	mult (MatrixView A, const ConstMatrixView &B, const Sparse &C)
	Matrix - SparseMatrix multiplication. More...

void	mult (Sparse &A, const Sparse &B, const Sparse &C)
	Sparse - Sparse multiplication. More...

void	add (Sparse &A, const Sparse &B, const Sparse &C)
	Sparse - Sparse addition. More...

void	sub (Sparse &A, const Sparse &B, const Sparse &C)
	Sparse - Sparse subtraction. More...

void	transpose (Sparse &A, const Sparse &B)
	Transpose of sparse matrix. More...

void	id_mat (Sparse &A)
	Sparse identity matrix. More...

Detailed Description

Header file for sparse matrices.

Author: Stefan Buehler sbueh.nosp@m.ler@.nosp@m.ltu.s.nosp@m.e

Date: Tue Jul 15 15:05:40 2003

Notes:

There are two different ways to index: S.rw(3,4) = 1; // Read and write cout << S.ro(3,4); // Read only

This distinction is necessary, because rw() creates elements if they don't already exist.

The normal index operator "()" correspondes to ro, so "S(3,4)" is the same as S.ro(3,4).

Definition in file matpackII.h.

Function Documentation

◆ abs()

void abs	(	Sparse &	A,
		const Sparse &	B
	)

Absolute value of sparse matrix elements.

Computes the absolute values of the elements in sparse matrix B.

The output matrix A must have been initialized with the correct size.

Parameters

A	Output: Absolute value matrix.
B	Original matrix.

Author: Mattias Ekstrom

Date: 2005-03-21

Definition at line 128 of file matpackII.cc.

References Sparse::matrix, Sparse::ncols(), and Sparse::nrows().

◆ add()

void add	(	Sparse &	A,
		const Sparse &	B,
		const Sparse &	C
	)

Sparse - Sparse addition.

Calculates A = B+C, where result A is sparse, and B and C are also sparse.

Output comes first!

Dimensions of B, and C must match. A will be resized.

Parameters

A	Output: Result matrix.
B	First summand matrix.
C	Second summand matrix.

Author: Oliver Lemke

Date: 2009-09-03

Definition at line 134 of file matpackII.cc.

References Sparse::matrix, Sparse::ncols(), Sparse::nrows(), and Sparse::resize().

Referenced by test49(), and test_sparse_arithmetic().

◆ id_mat()

void id_mat ( Sparse & A )

Sparse identity matrix.

Set the given Sparse matrix object to the identity matrix. The matrix must be square.

Parameters

A	The matrix to be set to the identity matrix.

Definition at line 137 of file matpackII.cc.

References Sparse::matrix, Sparse::ncols(), and Sparse::nrows().

◆ mult() [1/4]

void mult	(	MatrixView	A,
		const ConstMatrixView &	B,
		const Sparse &	C
	)

Matrix - SparseMatrix multiplication.

Calculates the matrix product:

A = B*C, where C is sparse.

Output comes first!

Dimensions of A, B, and C must match. No memory reallocation takes place, only the data is copied.

Parameters

A	Output: Result matrix (full).
B	First matrix to multiply (sparse).
C	Second matrix to multiply (full).

Author: Stefan Buehler sbueh.nosp@m.ler@.nosp@m.ltu.s.nosp@m.e

Date: Tue Jul 15 15:05:40 2003

Definition at line 1043 of file matpackII.cc.

References ConstMatrixView::ncols(), Sparse::ncols(), ConstMatrixView::nrows(), and Sparse::nrows().

◆ mult() [2/4]

void mult	(	MatrixView	A,
		const Sparse &	B,
		const ConstMatrixView &	C
	)

SparseMatrix - Matrix multiplication.

Calculates the matrix product:

A = B*C, where B is sparse.

Output comes first!

Dimensions of A, B, and C must match. No memory reallocation takes place, only the data is copied.

Parameters

A	Output: Result matrix (full).
B	First matrix to multiply (sparse).
C	Second matrix to multiply (full).

Author: Stefan Buehler sbueh.nosp@m.ler@.nosp@m.ltu.s.nosp@m.e

Date: Tue Jul 15 15:05:40 2003

Definition at line 1042 of file matpackII.cc.

References data, Range::get_start(), Range::get_stride(), Sparse::matrix, ConstMatrixView::mcr, ConstMatrixView::mdata, ConstMatrixView::mrr, ConstMatrixView::ncols(), Sparse::ncols(), ConstMatrixView::nrows(), and Sparse::nrows().

◆ mult() [3/4]

void mult	(	Sparse &	A,
		const Sparse &	B,
		const Sparse &	C
	)

Sparse - Sparse multiplication.

Calculates A = B*C, where result A is sparse, and B and C are also sparse.

Output comes first!

Dimensions of A, B, and C must match. No memory reallocation takes place, only the data is copied.

Parameters

A	Output: Result matrix.
B	First product matrix.
C	Second product matrix.

Author: Mattias Ekstroem

Date: 2003-08-06

Definition at line 133 of file matpackII.cc.

References Sparse::matrix, Sparse::ncols(), and Sparse::nrows().

◆ mult() [4/4]

void mult	(	VectorView	y,
		const Sparse &	M,
		ConstVectorView	x
	)

Sparse matrix - Vector multiplication.

This calculates the product

y = M*x, where M is sparse.

Output comes first!

Dimensions of y, M, and x must match. No memory reallocation takes place, only the data is copied.

Parameters

y	Output: The multiplication result.
M	Matrix for multiplication (sparse).
x	Vector for multiplication.

Definition at line 551 of file matpackII.cc.

References data, M, ARTS::Var::x(), and ARTS::Var::y().

◆ sub()

void sub	(	Sparse &	A,
		const Sparse &	B,
		const Sparse &	C
	)

Sparse - Sparse subtraction.

Calculates A = B-C, where result A is sparse, and B and C are also sparse.

Output comes first!

Dimensions of B, and C must match. A will be resized.

Parameters

A	Output: Result matrix.
B	First subtrahend matrix.
C	Second subtrahend matrix.

Author: Oliver Lemke

Date: 2009-09-03

Definition at line 135 of file matpackII.cc.

References Sparse::matrix, Sparse::ncols(), Sparse::nrows(), and Sparse::resize().

Referenced by sensor_responseBackendFrequencySwitching(), test49(), and test_sparse_arithmetic().

◆ transpose()

void transpose	(	Sparse &	A,
		const Sparse &	B
	)

Transpose of sparse matrix.

Computes the transpose of the sparse matrix B.

The output matrix A must have been initialized with the correct size.

Parameters

A	Output: Transposed matrix.
B	Original matrix.

Author: Mattias Ekstroem

Date: 2003-08-05

Definition at line 136 of file matpackII.cc.

References Sparse::matrix, Sparse::ncols(), and Sparse::nrows().

◆ transpose_mult()

void transpose_mult	(	VectorView	y,
		const Sparse &	M,
		ConstVectorView	x
	)

Sparse matrix - Vector multiplication.

This calculates the product

y = M*x, where M is sparse.

Output comes first!

Dimensions of y, M, and x must match. No memory reallocation takes place, only the data is copied.

Parameters

y	Output: The multiplication result.
M	Matrix for multiplication (sparse).
x	Vector for multiplication.

Definition at line 552 of file matpackII.cc.

References data, M, ARTS::Var::x(), and ARTS::Var::y().

Referenced by mult().

Classes

Functions

Detailed Description

Function Documentation

◆ abs()

◆ add()

◆ id_mat()

◆ mult() [1/4]

◆ mult() [2/4]

◆ mult() [3/4]

◆ mult() [4/4]

◆ sub()

◆ transpose()

◆ transpose_mult()