sisl.physics.Coefficient

class sisl.physics.Coefficient(c, parent=None, **info)

Bases: ParentContainer

An object holding coefficients for a parent with info

Parameters:

c (array_like) – coefficients
parent (obj, optional) – a parent object that defines the origin of the coefficient
**info (dict, optional) – an info dictionary that turns into an attribute on the object. This info may contain anything that may be relevant for the coefficient.

Methods

`copy`()	Return a copy (only the coefficients are copied).
`degenerate`(atol)	Find degenerate coefficients with a specified precision
`iter`([asarray])	An iterator looping over the coefficients in this system
`remove`(index[, inplace])	Return a new coefficient without the specified coefficients
`sub`(index[, inplace])	Return a new coefficient with only the specified coefficients

Attributes

`c`
`dkind`	The data-type of the coefficient (in str)
`dtype`	Data-type for the coefficients
`info`
`parent`
`shape`	Returns the shape of the coefficients

copy() → Coefficient: Return a copy (only the coefficients are copied). parent and info are passed by reference

degenerate(atol: float)[source]

Find degenerate coefficients with a specified precision

Parameters:: atol – the precision above which coefficients are not considered degenerate
Returns:: list of numpy.ndarray – a list of indices

iter(asarray=False)[source]

An iterator looping over the coefficients in this system

Parameters:

asarray (bool, optional) – if true the yielded values are the coefficient vectors, i.e. a numpy array. Otherwise an equivalent object is yielded.

Yields:

coeff (Coefficent) – the current coefficent as an object, only returned if asarray is false.
coeff (numpy.ndarray) – the current the coefficient as an array, only returned if asarray is true.

remove(index: sisl.typing.SimpleIndex, inplace: bool = False) → Coefficient | None

Return a new coefficient without the specified coefficients

Parameters:

index – indices that are removed in the returned object
inplace – whether the values will be removed inplace

Returns:

Coefficient – a new coefficient without containing the requested elements

sub(index: sisl.typing.SimpleIndex, inplace: bool = False) → Coefficient | None

Return a new coefficient with only the specified coefficients

Parameters:

index – indices that are retained in the returned object
inplace – whether the values will be retained inplace

Returns:

Coefficient – a new coefficient only containing the requested elements, only if inplace is false

c

property dkind: The data-type of the coefficient (in str)

property dtype: Data-type for the coefficients

info

parent

property shape: Returns the shape of the coefficients