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

numpy.ndarray

info

information regarding the creation of these coefficients

Type

dict

parent

object from where the coefficients has been calculated, in one way or the other

Type

obj

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

__doc__
__module__
__slots__
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

__delattr__	Implement delattr(self, name).
__dir__	Default dir() implementation.
__eq__	Return self==value.
__format__	Default object formatter.
__ge__	Return self>=value.
__getattribute__	Return getattr(self, name).
__getitem__(key)	Return a new coefficient object with only one associated coefficient
__gt__	Return self>value.
__hash__	Return hash(self).
__init__(c[, parent])	Initialize self.
__init_subclass__	This method is called when a class is subclassed.
__iter__([asarray])	An iterator looping over the coefficients in this system
__le__	Return self<=value.
__len__()	Number of coefficients
__lt__	Return self<value.
__ne__	Return self!=value.
__new__	Create and return a new object.
__reduce__	Helper for pickle.
__reduce_ex__	Helper for pickle.
__repr__	Return repr(self).
__setattr__	Implement setattr(self, name, value).
__sizeof__	Size of object in memory, in bytes.
__str__()	The string representation of this object
__subclasshook__	Abstract classes can override this to customize issubclass().
_sanitize_index(idx)	Ensure indices are transferred to acceptable integers
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

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)

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

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

a new coefficient only containing the requested elements

Return type

Coefficient