Sparse

class pyarts.arts.Sparse(*args, **kwargs)

A sparse version of Matrix

Overview

Method	readxml()	Read variable from file
Method	savexml()	Saves variable to file
Method	toarray()	Make a dense numpy.ndarray from the sparse matrix
Static Method	fromxml()	Create variable from file
Attribute	value	Treat as scipy.sparse.csr_matrix
Operator	__eq__()	Return self==value.
Operator	__ge__()	Return self>=value.
Operator	__getitem__()	__getitem__(self, arg: tuple[int, int], /) -> float
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__le__()	Return self<=value.
Operator	__lt__()	Return self<value.
Operator	__ne__()	Return self!=value.
Operator	__setitem__()	__setitem__(self, arg0: tuple[int, int], arg1: float, /) -> None

Constructors

__init__(self) → None

__init__(self, arg: pyarts.arts.Sparse) → None

__init__(self, arg: scipy.sparse.csr_matrix[float], /) → None

Overloaded function.

1. __init__(self) -> None

2. __init__(self, arg: pyarts.arts.Sparse) -> None

3. __init__(self, arg: scipy.sparse.csr_matrix[float], /) -> None

From scipy.sparse.csr_matrix

Methods

readxml(self, file: str) → None

Read variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) → None

Saves variable to file

Parameters:

• file (str) – The path to which the file is written. Note that several of the options might modify the name or write more files

• type (str) – Type of file to save. See FileType for options.

• clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:

Throws RuntimeError for any failure to save

toarray(self) → numpy.ndarray[dtype=float64, shape=(*, *), order='F']

Make a dense numpy.ndarray from the sparse matrix

Returns:

arr – A dense array

Return type:

numpy.ndarray

Static Methods

fromxml(file: str) → pyarts.arts.Sparse

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

value

Treat as scipy.sparse.csr_matrix

Operators

__eq__(value, /)

Return self==value.

__ge__(value, /)

Return self>=value.

__getitem__(self, arg: tuple[int, int], /) → float

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__setitem__(self, arg0: tuple[int, int], arg1: float, /) → None