Favago Transport Programming Interface

Introduction

Interfaces

root/

root/utils

Data structures

Examples







CommonFunctions

  Copyright (C) 2009-2015 Peter Rakyta, Ph.D.
  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see http://www.gnu.org/licenses/.

Description

Provides an interface for common functions.

Syntax

interface = CommonFunctions()

Attributes

Methods

inv_SVD

CommonFunctions::inv_SVD

Calculates the inverse of a badly conditioned matrix with SVD regularization.

Syntax

invA = interface.inv_SVD( A )

Parameters
A The matrix to be inverted.

Return
invA The calculated inverse.






egesz_resz

CommonFunctions::egesz_resz

Calculates the integer part of a real number.

Syntax

y = interface.egesz_resz( x )

Parameters
x A real number.

Return
y The integer part of x.






atom_megkulonbozteto

CommonFunctions::atom_megkulonbozteto

Makes a difference between A and B type sites. (Can be used in hexagonal lattices.) --- Obsolete

Syntax

ret = interface.atom_megkulonbozteto( resz_index_mtx,index_koord )

Parameters
resz_index_mtx
index_koord

Return
ret The type of the site ("A" or "B")






atom_tipus

CommonFunctions::atom_tipus

Makes a difference between A and B type sites. (Can be used in hexagonal lattices.) --- Obsolete

Syntax

ret = interface.atom_tipus( idx_i,idx_j )

Parameters
idx_i row index.
idx_j column index.

Return
ret The type of the site ("A" or "B")






paritas

CommonFunctions::paritas

Determine the parity of a number.

Syntax

p = interface.paritas( x )

Parameters
x An integer.

Return
ret The parity of the input integer.