Coefficient

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

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.

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

Methods

__init__(c[, parent])	Initialize self.
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

c

copy()

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

degenerate(eps)

Find degenerate coefficients with a specified precision

Parameters:

eps : float

the precision above which coefficients are not considered degenerate

Returns:

list of numpy.ndarray: a list of indices

dkind

The data-type of the coefficient (in str)

dtype

Data-type for the coefficients

info

iter(asarray=False)

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

shape

Returns the shape of the coefficients

sub(idx)

Return a new coefficient with only the specified coefficients

Parameters:

idx : int or array_like

indices that are retained in the returned object

Returns:

Coefficient

a new coefficient only containing the requested elements