Sparse

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

A sparse version of Matrix

This maps to scipy.sparse.csr_matrix.

Overview

Method	arcsin()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	arcsinh()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	arctan()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	arctanh()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	argmax()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	argmin()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	asformat()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	asfptype()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	astype()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	ceil()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	check_format()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	conj()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	conjugate()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	copy()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	count_nonzero()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	data()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	deg2rad()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	diagonal()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	dot()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	dtype()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	eliminate_zeros()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	expm1()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	floor()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	format()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	getH()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	get_shape()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	getcol()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	getformat()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	getmaxprint()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	getnnz()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	getrow()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	has_canonical_format()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	has_sorted_indices()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	imag()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	indices()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	indptr()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	log1p()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	max()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	maximum()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	maxprint()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	mean()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	min()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	minimum()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	multiply()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	nanmax()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	nanmin()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	ndim()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	nnz()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	nonzero()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	power()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	prune()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	rad2deg()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	readxml()	Read variable from file.
Method	real()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	reshape()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	resize()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	rint()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	savexml()	Saves variable to file.
Method	set_shape()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	setdiag()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	shape()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	sign()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	sin()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	sinh()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	size()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	sort_indices()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	sorted_indices()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	sqrt()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	sum()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	sum_duplicates()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	tan()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	tanh()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	tobsr()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	tocoo()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	tocsc()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	tocsr()	Make a scipy.sparse.csr_matrix from the sparse matrix
Method	todense()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	todia()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	todok()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	tolil()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	trace()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	transpose()	See scipy.sparse.csr_matrix, but for no input arguments.
Method	trunc()	See scipy.sparse.csr_matrix, but for no input arguments.
Static Method	fromxml()	Create variable from file.
Operator	__eq__()	Return self==value.
Operator	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	Return self>=value.
Operator	__getitem__()	__getitem__(self, arg: tuple[int, int], /) -> float
Operator	__getstate__()	__getstate__(self) -> tuple[scipy.sparse.csr_matrix[float]]
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	Overloaded function.
Operator	__le__()	Return self<=value.
Operator	__lt__()	Return self<value.
Operator	__ne__()	Return self!=value.
Operator	__repr__()	__repr__(self) -> str
Operator	__setitem__()	__setitem__(self, arg0: tuple[int, int], arg1: float, /) -> None
Operator	__setstate__()	__setstate__(self, arg: tuple[scipy.sparse.csr_matrix[float]], /) -> None
Operator	__str__()	__str__(self) -> str

Constructors

__init__(self) → None

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

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

Overloaded function.

1. __init__(self) -> None

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

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

From scipy.sparse.csr_matrix

Methods

arcsin(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

arcsinh(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

arctan(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

arctanh(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

argmax(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

argmin(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

asformat(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

asfptype(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

astype(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

ceil(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

check_format(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

conj(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

conjugate(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

copy(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

count_nonzero(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

data(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

deg2rad(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

diagonal(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

dot(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

dtype(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

eliminate_zeros(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

expm1(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

floor(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

format(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

getH(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

get_shape(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

getcol(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

getformat(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

getmaxprint(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

getnnz(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

getrow(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

has_canonical_format(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

has_sorted_indices(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

imag(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

indices(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

indptr(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

log1p(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

max(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

maximum(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

maxprint(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

mean(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

min(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

minimum(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

multiply(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

nanmax(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

nanmin(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

ndim(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

nnz(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

nonzero(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

power(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

prune(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

rad2deg(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

readxml(self, file: str) → str

Read variable from file.

Parameters:

file (str) – A file that can be read.

Raises:

RuntimeError – For any failure to read.

Returns:

file – The file path found (may differ from input due to environment variables).

Return type:

str

real(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

reshape(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

resize(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

rint(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

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

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, optional) – Type of file to save. See FileType for options. Defaults is “ascii”.

• clobber (bool, optional) – Overwrite existing files or add new file with modified name? Defaults is True.

Raises:

RuntimeError – For any failure to write.

Returns:

file – The file saved. May differ from input.

Return type:

str

set_shape(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

setdiag(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

shape(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

sign(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

sin(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

sinh(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

size(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

sort_indices(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

sorted_indices(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

sqrt(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

sum(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

sum_duplicates(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

tan(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

tanh(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

tobsr(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

tocoo(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

tocsc(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

tocsr(self) → scipy.sparse.csr_matrix[float]

Make a scipy.sparse.csr_matrix from the sparse matrix

Returns:

arr – A sparse array

Return type:

scipy.sparse.csr_matrix

todense(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

todia(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

todok(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

tolil(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

trace(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

transpose(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

trunc(self) → object

See scipy.sparse.csr_matrix, but for no input arguments.

Static Methods

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

Create variable from file.

Parameters:

file (str) – A file that can be read

Raises:

RuntimeError – For any failure to read.

Returns:

artstype – The variable created from the file.

Return type:

T

Operators

__eq__(value, /)

Return self==value.

__format__(self, arg: str, /) → str

__ge__(value, /)

Return self>=value.

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

__getstate__(self) → tuple[scipy.sparse.csr_matrix[float]]

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

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

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

Overloaded function.

1. __init__(self) -> None

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

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

From scipy.sparse.csr_matrix

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

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

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

__str__(self) → str