LinearCombinationOfWavepackets

About the LinearCombinationOfWavepackets class

The WaveBlocks Project

@author: R. Bourquin @copyright: Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015, 2016 R. Bourquin @license: Modified BSD License

Inheritance diagram

Inheritance diagram of LinearCombinationOfWavepackets

Class documentation

class WaveBlocksND.LinearCombinationOfWavepackets(dimension, ncomponents)[source]

This class is an abstract interface to linear combinations of general but compatible wavepackets.

__init__(dimension, ncomponents)[source]

Initialize a new linear combination of wavepackets. This object represents \Upsilon := \sum_{j=0}^{J-1} c_j \Psi_j. All J wavepackets \Psi_j have the same number N components and are defined in the D dimensional space.

Raise:NotImplementedError Abstract interface.
__str__()[source]
Returns:A string describing the linear combination of wavepackets.
Raise:NotImplementedError Abstract interface.
add_wavepacket(packet, coefficient)[source]
Raise:NotImplementedError Abstract interface.
add_wavepackets(packets, coefficients)[source]
Raise:NotImplementedError Abstract interface.
clone()[source]
Raise:NotImplementedError Abstract interface.
get_coefficient(index)[source]
Raise:NotImplementedError Abstract interface.
get_coefficients()[source]
Raise:NotImplementedError Abstract interface.
get_dimension()[source]
Returns:The space dimension D of all the wavepackets \Psi_j.
get_number_components()[source]
Returns:The number N of components all the wavepackets \Psi_j have.
get_number_packets()[source]
Returns:The number J of wavepackets in the linear combination \Upsilon := \sum_{j=0}^{J-1} c_j \Psi_j.
get_wavepacket(index)[source]
Raise:NotImplementedError Abstract interface.
get_wavepackets()[source]
Raise:NotImplementedError Abstract interface.
remove_wavepacket(index)[source]
Raise:NotImplementedError Abstract interface.
set_coefficient(index, coefficient)[source]
Raise:NotImplementedError Abstract interface.
set_coefficients(coefficients)[source]
Raise:NotImplementedError Abstract interface.
set_wavepackets(packetlist)[source]
Raise:NotImplementedError Abstract interface.