sisl.physics.Coefficient

class sisl.physics.Coefficient

Bases: ParentContainer

An object holding coefficients for a parent with info

Parameters:

c (ndarray) – 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()

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

Parameters:: coefficient (Coefficient)
Return type:: Coefficient

degenerate(atol)[source]

Find degenerate coefficients with a specified precision

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

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, inplace=False)

Return a new coefficient without the specified coefficients

Parameters:

index (int | Sequence[int] | Sequence[bool]) – indices that are removed in the returned object
inplace (bool) – whether the values will be removed inplace
coefficient (Coefficient)

Returns:

a new coefficient without containing the requested elements

Return type:

Coefficient

sub(index, inplace=False)

Return a new coefficient with only the specified coefficients

Parameters:

index (int | Sequence[int] | Sequence[bool]) – indices that are retained in the returned object
inplace (bool) – whether the values will be retained inplace
coefficient (Coefficient)

Returns:

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

Return type:

Coefficient

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