Decimation Class Reference

A class providing function handle to reduce the number of sites in the Hamiltonian via decimation procedure. More...

Inheritance diagram for Decimation:

Public Member Functions
function	Decimation (Opt, varargin)
	Constructor of the class. More...
function	decimation_1_and_2 (E, Way2Hamiltonian, NameOfH, NameOfRegular_sites)
	Algorithm to reduce the number of sites in the Hamiltonian via decimation. More...
function	decimation_3 (E, Way2Hamiltonian, NameOfH, NameOfRegular_sites)
	Algorithm to reduce the number of the sites in the Hamiltonian via decimation. More...
function	decimation_4 (E, Way2Hamiltonian, NameOfH, NameOfRegular_sites)
	Algorithm to reduce the number of the sites in the Hamiltonian via decimation. More...
function	display (message, nosilent)
	Displays output messages on the screen. More...
function	getOpt ()
	Retrives the structure containing the calculation parameters. More...

Static Public Member Functions
static function	BadInputType (variable, type)
	Throws a "bad input type" warning, with using the default value. More...
static function	BadInputTypeNoDefault (variable, type)
	Throws a "bad input type" warning without setting it to default. More...
static function	ExceedIteration ()
	Throws an "iteration exceeded" warning. More...

Public Attributes
Property	DecimationFunc
	The function handle of the decimation method. More...

Protected Member Functions
function	setCoordinates (Way2Hamiltonian, regular_sites)
	Sets the coordinates of the remaining sites after the decimation is finshed. More...

Protected Attributes
Property	Opt
	An instance of structure Opt. More...

Detailed Description

A class providing function handle to reduce the number of sites in the Hamiltonian via decimation procedure.

The Decimation parameter in structure Opt picks the following decimation procedures
Opt.Decimation=1 or Opt.Decimation=2 picks procedure decimation_1_and_2
Opt.Decimation=3 picks procedure decimation_3
Opt.Decimation=4 picks procedure decimation_4

Definition at line 29 of file Decimation.m.

Constructor & Destructor Documentation

Decimation()

function Decimation::Decimation	(	Opt	,
		varargin
	)

Constructor of the class.

Parameters

Opt	An instance of the structure Opt.
varargin	Cell array of optional parameters:
'ForcedDecimation'	Overrides the parameter value Opt.Decimation in structure Opt.

Returns

An instance of the class

Member Function Documentation

BadInputType()

static function Messages::BadInputType ( variable  , type    )

staticinherited

Throws a "bad input type" warning, with using the default value.

Parameters

variable	A string conatining the name of the variable.
type	A string describing the desired type.

BadInputTypeNoDefault()

static function Messages::BadInputTypeNoDefault ( variable  , type    )

staticinherited

Throws a "bad input type" warning without setting it to default.

Parameters

variable	A string conatining the name of the variable.
type	A string describing the desired type.

decimation_1_and_2()

function Decimation::decimation_1_and_2	(	E	,
		Way2Hamiltonian	,
		NameOfH	,
		NameOfRegular_sites
	)

Algorithm to reduce the number of sites in the Hamiltonian via decimation.

The number of the decimated sites is fixed during the calculations.

Parameters

E	The energy value
Way2Hamiltonian	An instance of class CreateHamiltonians (or a derived class).
NameOfH	Name of the attribute storing the Hamiltonian to be decimate (typically use 'Hscatter')
NameOfRegular_sites	Name of the attribute storing the idexes of sites to be kept after the decimation (typically use 'kulso_szabfokok').

decimation_3()

function Decimation::decimation_3	(	E	,
		Way2Hamiltonian	,
		NameOfH	,
		NameOfRegular_sites
	)

Algorithm to reduce the number of the sites in the Hamiltonian via decimation.

The number of the decimated sites in one turn varies dynamically in order to avoid badly conditioned matrices.

Parameters

E	The energy value
Way2Hamiltonian	An instance of class CreateHamiltonians (or a derived class).
NameOfH	Name of the attribute storing the Hamiltonian to be decimate (typically use 'Hscatter')
NameOfRegular_sites	Name of the attribute storing the idexes of sites to be kept after the decimation. (typically use 'kulso_szabfokok')

decimation_4()

function Decimation::decimation_4	(	E	,
		Way2Hamiltonian	,
		NameOfH	,
		NameOfRegular_sites
	)

Algorithm to reduce the number of the sites in the Hamiltonian via decimation.

The number of the decimated sites in one turn varies dynamically in order to avoid badly conditioned matrices. Equally fast as decimation_3, but more stable and more accurate.

Parameters

E	The energy value
Way2Hamiltonian	An instance of class CreateHamiltonians (or a derived class).
NameOfH	Name of the attribute storing the Hamiltonian to be decimate (typically use 'Hscatter')
NameOfRegular_sites	Name of the attribute storing the idexes of sites to be kept after the decimation. (typically use 'kulso_szabfokok')

display()

function Messages::display ( message  , nosilent    )

inherited

Displays output messages on the screen.

Parameters

message	String containing the message to be displayed
nosilent	Set true to override the silent option given in Opt.Silent.

ExceedIteration()

static function Messages::ExceedIteration ( )

staticinherited

Throws an "iteration exceeded" warning.

getOpt()

function Messages::getOpt ( )

inherited

Retrives the structure containing the calculation parameters.

Returns

Return an instance of structure Opt.

setCoordinates()

function Decimation::setCoordinates ( Way2Hamiltonian  , regular_sites    )

protected

Sets the coordinates of the remaining sites after the decimation is finshed.

Parameters

Way2Hamiltonian	An instance of class CreateHamiltonians (or a derived class).
regular_sites	Array of idexes of sites kept after the decimation

Member Data Documentation

DecimationFunc

Property Decimation::DecimationFunc

The function handle of the decimation method.

Definition at line 37 of file Decimation.m.

Opt

Property Messages::Opt

protectedinherited

An instance of structure Opt.

Definition at line 31 of file Messages.m.

---

The documentation for this class was generated from the following file:

• Decimation.m