sisl.physics.Coefficient¶
- class sisl.physics.Coefficient(c, parent=None, **info)¶
Bases:
sisl.physics.ParentContainer
An object holding coefficients for a parent with info
- c¶
coefficients
- Type
- parent¶
object from where the coefficients has been calculated, in one way or the other
- Type
obj
- Parameters
Methods
copy
()Return a copy (only the coefficients are copied).
degenerate
(eps)Find degenerate coefficients with a specified precision
iter
([asarray])An iterator looping over the coefficients in this system
sub
(idx)Return a new coefficient with only the specified coefficients
The data-type of the coefficient (in str)
Data-type for the coefficients
Returns the shape of the coefficients
- c¶
- copy()[source]¶
Return a copy (only the coefficients are copied).
parent
andinfo
are passed by reference
- degenerate(eps)[source]¶
Find degenerate coefficients with a specified precision
- Parameters
eps (float) – the precision above which coefficients are not considered degenerate
- Returns
a list of indices
- Return type
list of numpy.ndarray
- property dkind¶
The data-type of the coefficient (in str)
- property dtype¶
Data-type for the coefficients
- info¶
- 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.
- parent¶
- property shape¶
Returns the shape of the coefficients