Covariance matrix block. More...

#include <arts_api.h>

Public Attributes
long	indices [2]
	Quantity indices. More...

long	position [2]
	Start indices of block. More...

long	dimensions [2]
	Block size. More...

const void *	ptr
	Element pointer. More...

long	nnz
	Number of non-zero elements. More...

const int *	inner_ptr
	Inner pointer for sparse matrices. More...

const int *	outer_ptr
	Outer pointer for sparse matrices. More...

Detailed Description

Covariance matrix block.

This struct is used to return the value of a block of a covariance matrix through the API

Definition at line 172 of file arts_api.h.

Member Data Documentation

◆ dimensions

long CovarianceMatrixBlockStruct::dimensions[2]

Block size.

Number of rows and columns of this block.

Definition at line 191 of file arts_api.h.

◆ indices

long CovarianceMatrixBlockStruct::indices[2]

Quantity indices.

The indices of the retrieval quantities that this block corresponds to.

Definition at line 178 of file arts_api.h.

Referenced by get_covariance_matrix_block().

◆ inner_ptr

const int* CovarianceMatrixBlockStruct::inner_ptr

Inner pointer for sparse matrices.

If the block contains a sparse matrix, this pointer will point to the array of row indices. Otherwise it will be 0.

Definition at line 215 of file arts_api.h.

◆ nnz

long CovarianceMatrixBlockStruct::nnz

Number of non-zero elements.

Contains the number of non-zero elements in the block if it is represented by a sparse matrix. 0 otherwise.

Definition at line 207 of file arts_api.h.

◆ outer_ptr

const int* CovarianceMatrixBlockStruct::outer_ptr

Outer pointer for sparse matrices.

If the block contains a sparse matrix, this pointer will point to the array of row indices. Otherwise it will be 0.

Definition at line 222 of file arts_api.h.

◆ position

long CovarianceMatrixBlockStruct::position[2]

Start indices of block.

Row and column indices of the upper- and left-most elements of this block w.r.t. to the full covariance matrix.

Definition at line 185 of file arts_api.h.

◆ ptr

const void* CovarianceMatrixBlockStruct::ptr

Element pointer.

Pointer to the data of the matrix the block consists of. If the block holds a sparse matrix, this pointer will point to the element vector. If the block holds a dense matrix, this pointer will point to the 2D data array in row-major order.

Definition at line 200 of file arts_api.h.

The documentation for this struct was generated from the following file:

arts_api.h

Public Attributes